OGRE
1.10.12
Object-Oriented Graphics Rendering Engine
|
#include <OgreD3D9HardwarePixelBuffer.h>
Public Types | |
enum | LockOptions { HBL_NORMAL, HBL_DISCARD, HBL_READ_ONLY, HBL_NO_OVERWRITE, HBL_WRITE_ONLY } |
Locking options. More... | |
enum | UploadOptions { HBU_DEFAULT = 0x0000, HBU_ON_DEMAND = 0x0001 } |
Device load options The following enum is used to controls how data is loaded to devices in a multi device environment This enum only works with the Direct3D 9 render system (5/2013). More... | |
enum | Usage { HBU_STATIC = 1, HBU_DYNAMIC = 2, HBU_WRITE_ONLY = 4, HBU_DISCARDABLE = 8, HBU_STATIC_WRITE_ONLY = HBU_STATIC | HBU_WRITE_ONLY, HBU_DYNAMIC_WRITE_ONLY = HBU_DYNAMIC | HBU_WRITE_ONLY, HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = HBU_DYNAMIC_WRITE_ONLY | HBU_DISCARDABLE } |
Enums describing buffer usage; not mutually exclusive. More... | |
Public Member Functions | |
D3D9HardwarePixelBuffer (HardwareBuffer::Usage usage, D3D9Texture *ownerTexture) | |
~D3D9HardwarePixelBuffer () | |
virtual void | _clearSliceRTT (size_t zoffset) |
Notify TextureBuffer of destruction of render target. More... | |
void | _genMipmaps (IDirect3DBaseTexture9 *mipTex) |
Internal function to update mipmaps on update of level 0. More... | |
void | _setMipmapping (bool doMipmapGen, bool HWMipmaps) |
Function to set mipmap generation. More... | |
virtual void | _updateFromShadow (void) |
Updates the real buffer from the shadow buffer, if required. More... | |
void | bind (IDirect3DDevice9 *dev, IDirect3DSurface9 *mSurface, IDirect3DSurface9 *fsaaSurface, bool writeGamma, uint fsaa, const String &srcName, IDirect3DBaseTexture9 *mipTex) |
Call this to associate a D3D surface or volume with this pixel buffer. More... | |
void | bind (IDirect3DDevice9 *dev, IDirect3DVolume9 *mVolume, IDirect3DBaseTexture9 *mipTex) |
void | blit (const HardwarePixelBufferSharedPtr &src, const Box &srcBox, const Box &dstBox) |
Copies a box from another PixelBuffer to a region of the this PixelBuffer. More... | |
void | blit (const HardwarePixelBufferSharedPtr &src) |
Convenience function that blits the entire source pixel buffer to this buffer. More... | |
void | blitFromMemory (const PixelBox &src, const Box &dstBox) |
Copies a region from normal memory to a region of this pixelbuffer. More... | |
void | blitFromMemory (const PixelBox &src) |
Convenience function that blits a pixelbox from memory to the entire buffer. More... | |
void | blitToMemory (const Box &srcBox, const PixelBox &dst) |
Copies a region of this pixelbuffer to normal memory. More... | |
void | blitToMemory (const PixelBox &dst) |
Convenience function that blits this entire buffer to a pixelbox. More... | |
virtual void | copyData (HardwareBuffer &srcBuffer, size_t srcOffset, size_t dstOffset, size_t length, bool discardWholeBuffer=false) |
Copy data from another buffer into this one. More... | |
virtual void | copyData (HardwareBuffer &srcBuffer) |
Copy all data from another buffer into this one. More... | |
void | destroyBufferResources (IDirect3DDevice9 *d3d9Device) |
Destroy resources associated with the given device. More... | |
const PixelBox & | getCurrentLock () |
Get the current locked region. More... | |
uint32 | getDepth () const |
Gets the depth of this buffer. More... | |
PixelFormat | getFormat () const |
Gets the native pixel format of this buffer. More... | |
IDirect3DSurface9 * | getFSAASurface (IDirect3DDevice9 *d3d9Device) |
Accessor for AA surface. More... | |
uint32 | getHeight () const |
Gets the height of this buffer. More... | |
RenderTexture * | getRenderTarget (size_t zoffset) |
Get rendertarget for z slice. More... | |
size_t | getSizeInBytes (void) const |
Returns the size of this buffer in bytes. More... | |
IDirect3DSurface9 * | getSurface (IDirect3DDevice9 *d3d9Device) |
Accessor for surface. More... | |
Usage | getUsage (void) const |
Returns the Usage flags with which this buffer was created. More... | |
uint32 | getWidth () const |
Gets the width of this buffer. More... | |
bool | hasShadowBuffer (void) const |
Returns whether this buffer has a system memory shadow for quicker reading. More... | |
bool | isLocked (void) const |
Returns whether or not this buffer is currently locked. More... | |
bool | isSystemMemory (void) const |
Returns whether this buffer is held in system memory. More... | |
virtual const PixelBox & | lock (const Box &lockBox, LockOptions options) |
Lock the buffer for (potentially) reading / writing. More... | |
virtual void * | lock (size_t offset, size_t length, LockOptions options, UploadOptions uploadOpt=HBU_DEFAULT) |
Lock the buffer for (potentially) reading / writing. More... | |
void * | lock (LockOptions options, UploadOptions uploadOpt=HBU_DEFAULT) |
virtual void | readData (size_t offset, size_t length, void *pDest) |
Reads data from the buffer and places it in the memory pointed to by pDest. More... | |
void | releaseSurfaces (IDirect3DDevice9 *d3d9Device) |
Release surfaces held by this pixel buffer. More... | |
void | suppressHardwareUpdate (bool suppress) |
Pass true to suppress hardware upload of shadow buffer changes. More... | |
virtual void | unlock (void) |
Releases the lock on this buffer. More... | |
virtual void | writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false) |
Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough. More... | |
Static Public Member Functions | |
static void | lockDeviceAccess () |
static void | unlockDeviceAccess () |
|
inherited |
Enums describing buffer usage; not mutually exclusive.
|
inherited |
Locking options.
|
inherited |
Device load options The following enum is used to controls how data is loaded to devices in a multi device environment This enum only works with the Direct3D 9 render system (5/2013).
Enumerator | |
---|---|
HBU_DEFAULT | |
HBU_ON_DEMAND |
Ogre::D3D9HardwarePixelBuffer::D3D9HardwarePixelBuffer | ( | HardwareBuffer::Usage | usage, |
D3D9Texture * | ownerTexture | ||
) |
Ogre::D3D9HardwarePixelBuffer::~D3D9HardwarePixelBuffer | ( | ) |
void Ogre::D3D9HardwarePixelBuffer::bind | ( | IDirect3DDevice9 * | dev, |
IDirect3DSurface9 * | mSurface, | ||
IDirect3DSurface9 * | fsaaSurface, | ||
bool | writeGamma, | ||
uint | fsaa, | ||
const String & | srcName, | ||
IDirect3DBaseTexture9 * | mipTex | ||
) |
Call this to associate a D3D surface or volume with this pixel buffer.
void Ogre::D3D9HardwarePixelBuffer::bind | ( | IDirect3DDevice9 * | dev, |
IDirect3DVolume9 * | mVolume, | ||
IDirect3DBaseTexture9 * | mipTex | ||
) |
|
virtual |
Copies a box from another PixelBuffer to a region of the this PixelBuffer.
src | Source pixel buffer |
srcBox | Box describing the source region in src |
dstBox | Box describing the destination region in this buffer |
Reimplemented from Ogre::HardwarePixelBuffer.
|
virtual |
Copies a region from normal memory to a region of this pixelbuffer.
The source image can be in any pixel format supported by OGRE, and in any size.
src | PixelBox containing the source pixels and format in memory |
dstBox | Box describing the destination region in this buffer |
Implements Ogre::HardwarePixelBuffer.
|
virtual |
Copies a region of this pixelbuffer to normal memory.
srcBox | Box describing the source region of this buffer |
dst | PixelBox describing the destination pixels and format in memory |
Implements Ogre::HardwarePixelBuffer.
void Ogre::D3D9HardwarePixelBuffer::_genMipmaps | ( | IDirect3DBaseTexture9 * | mipTex | ) |
Internal function to update mipmaps on update of level 0.
void Ogre::D3D9HardwarePixelBuffer::_setMipmapping | ( | bool | doMipmapGen, |
bool | HWMipmaps | ||
) |
Function to set mipmap generation.
|
virtual |
Get rendertarget for z slice.
Reimplemented from Ogre::HardwarePixelBuffer.
IDirect3DSurface9* Ogre::D3D9HardwarePixelBuffer::getSurface | ( | IDirect3DDevice9 * | d3d9Device | ) |
Accessor for surface.
IDirect3DSurface9* Ogre::D3D9HardwarePixelBuffer::getFSAASurface | ( | IDirect3DDevice9 * | d3d9Device | ) |
Accessor for AA surface.
|
virtual |
Notify TextureBuffer of destruction of render target.
Reimplemented from Ogre::HardwarePixelBuffer.
void Ogre::D3D9HardwarePixelBuffer::releaseSurfaces | ( | IDirect3DDevice9 * | d3d9Device | ) |
Release surfaces held by this pixel buffer.
void Ogre::D3D9HardwarePixelBuffer::destroyBufferResources | ( | IDirect3DDevice9 * | d3d9Device | ) |
Destroy resources associated with the given device.
|
static |
|
static |
|
virtualinherited |
Lock the buffer for (potentially) reading / writing.
lockBox | Region of the buffer to lock |
options | Locking options |
|
virtualinherited |
Lock the buffer for (potentially) reading / writing.
offset | The byte offset from the start of the buffer to lock |
length | The size of the area to lock, in bytes |
options | Locking options |
uploadOpt |
Reimplemented from Ogre::HardwareBuffer.
|
inlineinherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inherited |
Get the current locked region.
This is the same value as returned by lock(const Box, LockOptions)
|
virtualinherited |
Reads data from the buffer and places it in the memory pointed to by pDest.
offset | The byte offset from the start of the buffer to read |
length | The size of the area to read, in bytes |
pDest | The area of memory in which to place the data, must be large enough to accommodate the data! |
Implements Ogre::HardwareBuffer.
|
virtualinherited |
Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough.
offset | The byte offset from the start of the buffer to start writing |
length | The size of the data to write to, in bytes |
pSource | The source of the data to be written |
discardWholeBuffer | If true, this allows the driver to discard the entire buffer when writing, such that DMA stalls can be avoided; use if you can. |
Implements Ogre::HardwareBuffer.
|
inherited |
Convenience function that blits the entire source pixel buffer to this buffer.
If source and destination dimensions don't match, scaling is done.
src | PixelBox containing the source pixels and format in memory |
|
inlineinherited |
Convenience function that blits a pixelbox from memory to the entire buffer.
The source image is scaled as needed.
src | PixelBox containing the source pixels and format in memory |
|
inlineinherited |
Convenience function that blits this entire buffer to a pixelbox.
The image is scaled as needed.
dst | PixelBox describing the destination pixels and format in memory |
|
inlineinherited |
Gets the width of this buffer.
|
inlineinherited |
Gets the height of this buffer.
|
inlineinherited |
Gets the depth of this buffer.
|
inlineinherited |
Gets the native pixel format of this buffer.
|
inlinevirtualinherited |
Releases the lock on this buffer.
Reimplemented in Ogre::DefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::D3D11HardwareUniformBuffer, Ogre::D3D11HardwareVertexBuffer, and Ogre::D3D11HardwareIndexBuffer.
References Ogre::HardwareBuffer::isLocked(), and Ogre::HardwareBuffer::unlock().
Referenced by Ogre::HardwareBuffer::copyData(), Ogre::HardwareBuffer::unlock(), and Ogre::Lod0Stripifier::~Lod0Stripifier().
|
inlinevirtualinherited |
Copy data from another buffer into this one.
srcBuffer | The buffer from which to read the copied data |
srcOffset | Offset in the source buffer at which to start reading |
dstOffset | Offset in the destination buffer to start writing |
length | Length of the data to copy, in bytes. |
discardWholeBuffer | If true, will discard the entire contents of this buffer before copying |
Reimplemented in Ogre::D3D11HardwareBuffer, Ogre::GLES2HardwareVertexBuffer, Ogre::GLES2HardwareIndexBuffer, Ogre::GL3PlusHardwareShaderStorageBuffer, Ogre::GL3PlusHardwareUniformBuffer, Ogre::GLES2HardwareUniformBuffer, Ogre::GL3PlusHardwareCounterBuffer, Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, Ogre::D3D11HardwareVertexBuffer, and Ogre::D3D11HardwareIndexBuffer.
References Ogre::HardwareBuffer::lock(), and Ogre::HardwareBuffer::unlock().
|
inlinevirtualinherited |
Copy all data from another buffer into this one.
References Ogre::HardwareBuffer::getSizeInBytes().
|
inlinevirtualinherited |
Updates the real buffer from the shadow buffer, if required.
Reimplemented in Ogre::D3D11HardwareBuffer, Ogre::GLES2HardwareVertexBuffer, Ogre::GLES2HardwareIndexBuffer, Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLHardwareVertexBuffer, and Ogre::GLHardwareIndexBuffer.
|
inlineinherited |
Returns the size of this buffer in bytes.
Referenced by Ogre::HardwareBuffer::copyData().
|
inlineinherited |
Returns the Usage flags with which this buffer was created.
Referenced by Ogre::Lod0Stripifier::~Lod0Stripifier().
|
inlineinherited |
Returns whether this buffer is held in system memory.
|
inlineinherited |
Returns whether this buffer has a system memory shadow for quicker reading.
Referenced by Ogre::Lod0Stripifier::~Lod0Stripifier().
|
inlineinherited |
Returns whether or not this buffer is currently locked.
References Ogre::HardwareBuffer::isLocked().
Referenced by Ogre::HardwareBuffer::isLocked(), and Ogre::HardwareBuffer::unlock().
|
inlineinherited |
Pass true to suppress hardware upload of shadow buffer changes.