OGRE
2.3
Object-Oriented Graphics Rendering Engine
|
Renderbuffer surface. More...
#include <OgreGL3PlusHardwarePixelBuffer.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 | |
GL3PlusRenderBuffer (GLenum format, uint32 width, uint32 height, GLsizei numSamples) | |
~GL3PlusRenderBuffer () | |
virtual void | _updateFromShadow (void) |
Updates the real buffer from the shadow buffer, if required. More... | |
virtual void | bindToFramebuffer (GLenum attachment, uint32 zoffset) |
Bind surface to frame buffer. More... | |
void | blit (const HardwarePixelBufferSharedPtr &src) |
Convenience function that blits the entire source pixel buffer to this buffer. More... | |
virtual 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 | blitFromMemory (const PixelBox &src) |
Convenience function that blits a pixelbox from memory to the entire buffer. More... | |
void | blitFromMemory (const PixelBox &src, const Box &dstBox) |
Copies a region from normal memory to a region of this pixelbuffer. 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) |
Copy all data from another buffer into this one. 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... | |
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... | |
GLenum | getGLFormat () |
uint32 | getHeight () const |
Gets the height of this buffer. More... | |
virtual void * | getRenderSystemData (void) |
An internal function that should be used only by a render system for internal use. 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 Box &lockBox, LockOptions options) |
Lock the buffer for (potentially) reading / writing. More... | |
void * | lock (LockOptions options) |
Make every lock method from HardwareBuffer available. More... | |
void * | lock (LockOptions options) |
Lock the entire buffer for (potentially) reading / writing. More... | |
virtual void * | lock (size_t offset, size_t length, LockOptions options) |
Make every lock method from HardwareBuffer available. More... | |
virtual void * | lock (size_t offset, size_t length, LockOptions options) |
Lock the buffer for (potentially) reading / writing. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
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 *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
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... | |
Renderbuffer surface.
Needs FBO extension.
|
inherited |
Locking options.
|
inherited |
Enums describing buffer usage; not mutually exclusive.
Ogre::v1::GL3PlusRenderBuffer::GL3PlusRenderBuffer | ( | GLenum | format, |
uint32 | width, | ||
uint32 | height, | ||
GLsizei | numSamples | ||
) |
Ogre::v1::GL3PlusRenderBuffer::~GL3PlusRenderBuffer | ( | ) |
|
inlinevirtualinherited |
Updates the real buffer from the shadow buffer, if required.
Reimplemented in Ogre::v1::VulkanHardwareVertexBuffer, Ogre::v1::VulkanHardwareIndexBuffer, Ogre::v1::MetalHardwareVertexBuffer, Ogre::v1::MetalHardwareIndexBuffer, Ogre::v1::GL3PlusHardwareVertexBuffer, Ogre::v1::GL3PlusHardwareIndexBuffer, and Ogre::v1::D3D11HardwareBuffer.
|
virtual |
Bind surface to frame buffer.
Needs FBO extension.
Reimplemented from Ogre::v1::GL3PlusHardwarePixelBuffer.
|
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 |
|
virtualinherited |
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 in Ogre::v1::MetalTextureBuffer, Ogre::v1::GLES2TextureBuffer, Ogre::v1::GL3PlusTextureBuffer, and Ogre::v1::D3D11HardwarePixelBuffer.
|
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 |
|
virtualinherited |
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::v1::HardwarePixelBuffer.
Reimplemented in Ogre::v1::GL3PlusTextureBuffer.
|
virtualinherited |
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::v1::HardwarePixelBuffer.
|
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 |
|
inlinevirtualinherited |
Copy all data from another buffer into this one.
References Ogre::v1::HardwareBuffer::getSizeInBytes().
|
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::v1::VulkanHardwareVertexBuffer, Ogre::v1::VulkanHardwareIndexBuffer, Ogre::v1::MetalHardwareVertexBuffer, Ogre::v1::MetalHardwareIndexBuffer, Ogre::v1::GLES2HardwareUniformBuffer, Ogre::v1::GL3PlusHardwareVertexBuffer, Ogre::v1::GL3PlusHardwareUniformBuffer, Ogre::v1::GL3PlusHardwareShaderStorageBuffer, Ogre::v1::GL3PlusHardwareIndexBuffer, Ogre::v1::GL3PlusHardwareCounterBuffer, Ogre::v1::D3D11HardwareVertexBuffer, Ogre::v1::D3D11HardwareUniformBuffer, Ogre::v1::D3D11HardwareIndexBuffer, and Ogre::v1::D3D11HardwareBuffer.
References Ogre::v1::HardwareBuffer::lock(), and Ogre::v1::HardwareBuffer::unlock().
|
inherited |
Get the current locked region.
This is the same value as returned by lock(const Box, LockOptions)
|
inlineinherited |
Gets the depth of this buffer.
|
inlineinherited |
Gets the native pixel format of this buffer.
|
inlineinherited |
|
inlineinherited |
Gets the height of this buffer.
|
inlinevirtualinherited |
An internal function that should be used only by a render system for internal use.
Reimplemented in Ogre::v1::VulkanHardwareVertexBuffer, Ogre::v1::VulkanHardwareIndexBuffer, Ogre::v1::MetalHardwareVertexBuffer, and Ogre::v1::MetalHardwareIndexBuffer.
|
virtualinherited |
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::v1::GL3PlusTextureBuffer, Ogre::v1::NULLHardwarePixelBuffer, Ogre::v1::D3D11HardwarePixelBuffer, Ogre::v1::MetalNullPixelBuffer, Ogre::v1::MetalDepthPixelBuffer, Ogre::v1::GLES2NullPixelBuffer, Ogre::v1::GLES2DepthPixelBuffer, Ogre::v1::GL3PlusNullPixelBuffer, Ogre::v1::GL3PlusDepthPixelBuffer, Ogre::v1::D3D11NullPixelBuffer, Ogre::v1::D3D11DepthPixelBuffer, Ogre::v1::MetalTextureBuffer, and Ogre::v1::GLES2TextureBuffer.
|
inlineinherited |
Returns the size of this buffer in bytes.
Referenced by Ogre::v1::HardwareBuffer::copyData().
|
inlineinherited |
Returns the Usage flags with which this buffer was created.
Referenced by Ogre::VerticesRemapInfo::performIndexDataRemap().
|
inlineinherited |
Gets the width of this buffer.
|
inlineinherited |
Returns whether this buffer has a system memory shadow for quicker reading.
Referenced by Ogre::VerticesRemapInfo::performIndexDataRemap().
|
inlineinherited |
Returns whether or not this buffer is currently locked.
References Ogre::v1::HardwareBuffer::isLocked().
Referenced by Ogre::v1::HardwareBuffer::isLocked(), and Ogre::v1::HardwareBuffer::unlock().
|
inlineinherited |
Returns whether this buffer is held in system memory.
|
virtualinherited |
Lock the buffer for (potentially) reading / writing.
lockBox | Region of the buffer to lock |
options | Locking options |
|
inlineinherited |
Make every lock method from HardwareBuffer available.
See http://www.research.att.com/~bs/bs_faq2.html#overloadderived
|
inlineinherited |
Lock the entire buffer for (potentially) reading / writing.
options | Locking options |
|
inlineinherited |
Make every lock method from HardwareBuffer available.
See http://www.research.att.com/~bs/bs_faq2.html#overloadderived
|
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 |
Reimplemented from Ogre::v1::HardwareBuffer.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
|
inlineinherited |
placement operator new
|
inlineinherited |
|
inlineinherited |
array operator new, with debug line info
|
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::v1::HardwareBuffer.
|
inlineinherited |
Pass true to suppress hardware upload of shadow buffer changes.
|
inlinevirtualinherited |
Releases the lock on this buffer.
Reimplemented in Ogre::v1::GLES2DefaultHardwareUniformBuffer, Ogre::v1::GLES2DefaultHardwareIndexBuffer, Ogre::v1::GLES2DefaultHardwareVertexBuffer, Ogre::v1::GL3PlusDefaultHardwareCounterBuffer, Ogre::v1::GL3PlusDefaultHardwareUniformBuffer, Ogre::v1::GL3PlusDefaultHardwareIndexBuffer, Ogre::v1::GL3PlusDefaultHardwareVertexBuffer, Ogre::v1::D3D11HardwareVertexBuffer, Ogre::v1::D3D11HardwareUniformBuffer, Ogre::v1::D3D11HardwareIndexBuffer, Ogre::v1::DefaultHardwareCounterBuffer, Ogre::v1::DefaultHardwareUniformBuffer, Ogre::v1::DefaultHardwareIndexBuffer, and Ogre::v1::DefaultHardwareVertexBuffer.
References Ogre::v1::HardwareBuffer::isLocked(), and Ogre::v1::HardwareBuffer::unlock().
Referenced by Ogre::v1::HardwareBuffer::copyData(), Ogre::v1::HardwareBufferLockGuard::unlock(), and Ogre::v1::HardwareBuffer::unlock().
|
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::v1::HardwareBuffer.