Specialisation of HardwareBuffer for a pixel buffer. More...
#include <OgreHardwarePixelBuffer.h>
Public Types | |
enum | LockOptions { HBL_NORMAL, HBL_DISCARD, HBL_READ_ONLY, HBL_NO_OVERWRITE, HBL_WRITE_ONLY } |
Locking options. More... | |
enum | Usage { HBU_STATIC = 1, HBU_DYNAMIC = 2, HBU_WRITE_ONLY = 4, HBU_DISCARDABLE = 8, HBU_STATIC_WRITE_ONLY = 5, HBU_DYNAMIC_WRITE_ONLY = 6, HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = 14 } |
Enums describing buffer usage; not mutually exclusive. More... | |
Public Member Functions | |
HardwarePixelBuffer (uint32 mWidth, uint32 mHeight, uint32 mDepth, PixelFormat mFormat, HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer) | |
Should be called by HardwareBufferManager. More... | |
~HardwarePixelBuffer () | |
virtual void | _updateFromShadow (void) |
Updates the real buffer from the shadow buffer, if required. More... | |
virtual void | blit (const HardwarePixelBufferSharedPtr &src, const Image::Box &srcBox, const Image::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... | |
virtual void | blitFromMemory (const PixelBox &src, const Image::Box &dstBox)=0 |
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... | |
virtual void | blitToMemory (const Image::Box &srcBox, const PixelBox &dst)=0 |
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... | |
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... | |
uint32 | getHeight () const |
Gets the height of this buffer. More... | |
virtual RenderTexture * | getRenderTarget (size_t slice=0) |
Get a render target for this PixelBuffer, or a slice of it. More... | |
size_t | getSizeInBytes (void) const |
Returns the size of this buffer in bytes. 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 Image::Box &lockBox, LockOptions options) |
Lock the buffer for (potentially) reading / writing. More... | |
virtual void * | lock (size_t offset, size_t length, LockOptions options) |
Lock the buffer for (potentially) reading / writing. More... | |
void * | lock (LockOptions options) |
Lock the entire buffer for (potentially) reading / writing. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
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 | 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... | |
Protected Member Functions | |
virtual void | _clearSliceRTT (size_t zoffset) |
Notify TextureBuffer of destruction of render target. More... | |
virtual PixelBox | lockImpl (const Image::Box lockBox, LockOptions options)=0 |
Internal implementation of lock(), must be overridden in subclasses. More... | |
virtual void * | lockImpl (size_t offset, size_t length, LockOptions options) |
Internal implementation of lock(), do not OVERRIDE or CALL this for HardwarePixelBuffer implementations, but override the previous method. More... | |
virtual void | unlockImpl (void)=0 |
Internal implementation of unlock() More... | |
Protected Attributes | |
PixelBox | mCurrentLock |
Currently locked region (local coords) More... | |
uint32 | mDepth |
PixelFormat | mFormat |
Internal format. More... | |
uint32 | mHeight |
bool | mIsLocked |
Image::Box | mLockedBox |
The current locked box of this surface (entire surface coords) More... | |
size_t | mLockSize |
size_t | mLockStart |
size_t | mRowPitch |
Pitches (offsets between rows and slices) More... | |
HardwareBuffer * | mShadowBuffer |
bool | mShadowUpdated |
size_t | mSizeInBytes |
size_t | mSlicePitch |
bool | mSuppressHardwareUpdate |
bool | mSystemMemory |
Usage | mUsage |
bool | mUseShadowBuffer |
uint32 | mWidth |
Extents. More... | |
Friends | |
class | RenderTexture |
Specialisation of HardwareBuffer for a pixel buffer.
The HardwarePixelbuffer abstracts an 1D, 2D or 3D quantity of pixels stored by the rendering API. The buffer can be located on the card or in main memory depending on its usage. One mipmap level of a texture is an example of a HardwarePixelBuffer.
Definition at line 53 of file OgreHardwarePixelBuffer.h.
|
inherited |
Locking options.
Definition at line 121 of file OgreHardwareBuffer.h.
|
inherited |
Enums describing buffer usage; not mutually exclusive.
Definition at line 79 of file OgreHardwareBuffer.h.
Ogre::HardwarePixelBuffer::HardwarePixelBuffer | ( | uint32 | mWidth, |
uint32 | mHeight, | ||
uint32 | mDepth, | ||
PixelFormat | mFormat, | ||
HardwareBuffer::Usage | usage, | ||
bool | useSystemMemory, | ||
bool | useShadowBuffer | ||
) |
Should be called by HardwareBufferManager.
Ogre::HardwarePixelBuffer::~HardwarePixelBuffer | ( | ) |
|
protectedvirtual |
Notify TextureBuffer of destruction of render target.
Called by RenderTexture when destroyed.
Reimplemented in Ogre::D3D9HardwarePixelBuffer, Ogre::GLESTextureBuffer, Ogre::GL3PlusTextureBuffer, Ogre::GLES2TextureBuffer, Ogre::D3D11HardwarePixelBuffer, and Ogre::GLTextureBuffer.
|
inlinevirtualinherited |
Updates the real buffer from the shadow buffer, if required.
Reimplemented in Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLHardwareVertexBuffer, and Ogre::GLHardwareIndexBuffer.
Definition at line 305 of file OgreHardwareBuffer.h.
|
virtual |
Copies a box from another PixelBuffer to a region of the this PixelBuffer.
src | Source pixel buffer |
srcBox | Image::Box describing the source region in src |
dstBox | Image::Box describing the destination region in this buffer |
Reimplemented in Ogre::GLESTextureBuffer, Ogre::GL3PlusTextureBuffer, Ogre::GLES2TextureBuffer, Ogre::D3D9HardwarePixelBuffer, Ogre::GLTextureBuffer, and Ogre::D3D11HardwarePixelBuffer.
void Ogre::HardwarePixelBuffer::blit | ( | const HardwarePixelBufferSharedPtr & | src | ) |
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 |
|
pure 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 | Image::Box describing the destination region in this buffer |
Implemented in Ogre::D3D9HardwarePixelBuffer, Ogre::GLESTextureBuffer, Ogre::GL3PlusTextureBuffer, Ogre::GLES2TextureBuffer, Ogre::GLTextureBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::GLESHardwarePixelBuffer, Ogre::GL3PlusHardwarePixelBuffer, Ogre::GLES2HardwarePixelBuffer, and Ogre::GLHardwarePixelBuffer.
|
inline |
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 |
Definition at line 149 of file OgreHardwarePixelBuffer.h.
|
pure virtual |
Copies a region of this pixelbuffer to normal memory.
srcBox | Image::Box describing the source region of this buffer |
dst | PixelBox describing the destination pixels and format in memory |
Implemented in Ogre::D3D9HardwarePixelBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::GLESHardwarePixelBuffer, Ogre::GL3PlusHardwarePixelBuffer, Ogre::GLES2HardwarePixelBuffer, and Ogre::GLHardwarePixelBuffer.
|
inline |
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 |
Definition at line 168 of file OgreHardwarePixelBuffer.h.
|
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::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLES2HardwareUniformBuffer, Ogre::GL3PlusHardwareUniformBuffer, Ogre::GL3PlusHardwareCounterBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.
Definition at line 284 of file OgreHardwareBuffer.h.
References Ogre::HardwareBuffer::lock(), and Ogre::HardwareBuffer::unlock().
|
inlinevirtualinherited |
Copy all data from another buffer into this one.
Definition at line 298 of file OgreHardwareBuffer.h.
References Ogre::HardwareBuffer::getSizeInBytes().
const PixelBox& Ogre::HardwarePixelBuffer::getCurrentLock | ( | ) |
Get the current locked region.
This is the same value as returned by lock(const Image::Box, LockOptions)
|
inline |
Gets the depth of this buffer.
Definition at line 187 of file OgreHardwarePixelBuffer.h.
|
inline |
Gets the native pixel format of this buffer.
Definition at line 189 of file OgreHardwarePixelBuffer.h.
|
inline |
Gets the height of this buffer.
Definition at line 185 of file OgreHardwarePixelBuffer.h.
|
virtual |
Get a render target for this PixelBuffer, or a slice of it.
The texture this was acquired from must have TU_RENDERTARGET set, otherwise it is possible to render to it and this method will throw an ERR_RENDERSYSTEM exception.
slice | Which slice |
Reimplemented in Ogre::D3D9HardwarePixelBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::GLESTextureBuffer, Ogre::GL3PlusTextureBuffer, Ogre::GLES2TextureBuffer, and Ogre::GLTextureBuffer.
|
inlineinherited |
Returns the size of this buffer in bytes.
Definition at line 330 of file OgreHardwareBuffer.h.
Referenced by Ogre::HardwareBuffer::copyData().
|
inlineinherited |
Returns the Usage flags with which this buffer was created.
Definition at line 332 of file OgreHardwareBuffer.h.
|
inline |
Gets the width of this buffer.
Definition at line 183 of file OgreHardwarePixelBuffer.h.
|
inlineinherited |
Returns whether this buffer has a system memory shadow for quicker reading.
Definition at line 336 of file OgreHardwareBuffer.h.
|
inlineinherited |
Returns whether or not this buffer is currently locked.
Definition at line 338 of file OgreHardwareBuffer.h.
|
inlineinherited |
Returns whether this buffer is held in system memory.
Definition at line 334 of file OgreHardwareBuffer.h.
|
virtual |
Lock the buffer for (potentially) reading / writing.
lockBox | Region of the buffer to lock |
options | Locking options |
|
virtual |
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 |
Reimplemented from Ogre::HardwareBuffer.
|
inlineinherited |
Lock the entire buffer for (potentially) reading / writing.
options | Locking options |
Definition at line 220 of file OgreHardwareBuffer.h.
|
protectedpure virtual |
Internal implementation of lock(), must be overridden in subclasses.
Implemented in Ogre::D3D9HardwarePixelBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::GLES2HardwarePixelBuffer, and Ogre::GLHardwarePixelBuffer.
|
protectedvirtual |
Internal implementation of lock(), do not OVERRIDE or CALL this for HardwarePixelBuffer implementations, but override the previous method.
Implements Ogre::HardwareBuffer.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
virtual |
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.
|
inlineinherited |
Pass true to suppress hardware upload of shadow buffer changes.
Definition at line 342 of file OgreHardwareBuffer.h.
|
inlinevirtualinherited |
Releases the lock on this buffer.
Reimplemented in Ogre::DefaultHardwareCounterBuffer, Ogre::GL3PlusDefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareUniformBuffer, Ogre::GLES2DefaultHardwareUniformBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.
Definition at line 236 of file OgreHardwareBuffer.h.
Referenced by Ogre::HardwareBuffer::copyData().
|
protectedpure virtualinherited |
Internal implementation of unlock()
Implemented in Ogre::DefaultHardwareCounterBuffer, Ogre::GL3PlusDefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareUniformBuffer, Ogre::GLES2DefaultHardwareUniformBuffer, Ogre::D3D9HardwarePixelBuffer, Ogre::D3D9HardwareIndexBuffer, Ogre::D3D9HardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::D3D11HardwareBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GLHardwareVertexBuffer, Ogre::GL3PlusHardwareVertexBuffer, Ogre::GLHardwareIndexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLES2HardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GL3PlusHardwareCounterBuffer, Ogre::GL3PlusHardwareUniformBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, Ogre::GLESHardwarePixelBuffer, Ogre::D3D11HardwareVertexBuffer, Ogre::GL3PlusHardwarePixelBuffer, Ogre::GLES2HardwarePixelBuffer, and Ogre::GLHardwarePixelBuffer.
|
virtual |
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.
|
friend |
Definition at line 79 of file OgreHardwarePixelBuffer.h.
|
protected |
Currently locked region (local coords)
Definition at line 63 of file OgreHardwarePixelBuffer.h.
|
protected |
Definition at line 57 of file OgreHardwarePixelBuffer.h.
|
protected |
Internal format.
Definition at line 61 of file OgreHardwarePixelBuffer.h.
|
protected |
Definition at line 57 of file OgreHardwarePixelBuffer.h.
|
protectedinherited |
Definition at line 145 of file OgreHardwareBuffer.h.
|
protected |
The current locked box of this surface (entire surface coords)
Definition at line 65 of file OgreHardwarePixelBuffer.h.
|
protectedinherited |
Definition at line 147 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 146 of file OgreHardwareBuffer.h.
|
protected |
Pitches (offsets between rows and slices)
Definition at line 59 of file OgreHardwarePixelBuffer.h.
|
protectedinherited |
Definition at line 150 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 151 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 143 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 59 of file OgreHardwarePixelBuffer.h.
|
protectedinherited |
Definition at line 152 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 148 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 144 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 149 of file OgreHardwareBuffer.h.
|
protected |
Extents.
Definition at line 57 of file OgreHardwarePixelBuffer.h.