OGRE  13.4
Object-Oriented Graphics Rendering Engine
Ogre::DefaultHardwareBufferManagerBase Class Reference

Specialisation of HardwareBufferManagerBase to emulate hardware buffers. More...

#include <OgreDefaultHardwareBufferManager.h>

+ Inheritance diagram for Ogre::DefaultHardwareBufferManagerBase:

Public Member Functions

 DefaultHardwareBufferManagerBase ()
 
 ~DefaultHardwareBufferManagerBase ()
 
HardwareIndexBufferPtr createIndexBuffer (HardwareIndexBuffer::IndexType itype, size_t numIndexes, HardwareBuffer::Usage usage, bool useShadowBuffer=false) override
 Create a hardware index buffer. More...
 
HardwareBufferPtr createUniformBuffer (size_t sizeBytes, HardwareBufferUsage=HBU_CPU_ONLY, bool=false) override
 Create uniform buffer. More...
 
HardwareVertexBufferPtr createVertexBuffer (size_t vertexSize, size_t numVerts, HardwareBuffer::Usage usage, bool useShadowBuffer=false) override
 Create a hardware vertex buffer. More...
 
- Public Member Functions inherited from Ogre::HardwareBufferManagerBase
 HardwareBufferManagerBase ()
 
virtual ~HardwareBufferManagerBase ()
 
void _forceReleaseBufferCopies (const HardwareVertexBufferSharedPtr &sourceBuffer)
 Internal method that forces the release of copies of a given buffer. More...
 
void _forceReleaseBufferCopies (HardwareVertexBuffer *sourceBuffer)
 Internal method that forces the release of copies of a given buffer. More...
 
void _freeUnusedBufferCopies (void)
 Free all unused vertex buffer copies. More...
 
void _notifyVertexBufferDestroyed (HardwareVertexBuffer *buf)
 Notification that a hardware vertex buffer has been destroyed. More...
 
void _releaseBufferCopies (bool forceFreeUnused=false)
 Internal method for releasing all temporary buffers which have been allocated using BLT_AUTOMATIC_RELEASE; is called by OGRE. More...
 
HardwareVertexBufferSharedPtr allocateVertexBufferCopy (const HardwareVertexBufferSharedPtr &sourceBuffer, BufferLicenseType licenseType, HardwareBufferLicensee *licensee, bool copyData=false)
 Allocates a copy of a given vertex buffer. More...
 
virtual RenderToVertexBufferSharedPtr createRenderToVertexBuffer ()
 Create a render to vertex buffer. More...
 
VertexBufferBindingcreateVertexBufferBinding (void)
 Creates a new VertexBufferBinding. More...
 
VertexDeclarationcreateVertexDeclaration (void)
 Creates a new vertex declaration. More...
 
void destroyVertexBufferBinding (VertexBufferBinding *binding)
 Destroys a VertexBufferBinding. More...
 
void destroyVertexDeclaration (VertexDeclaration *decl)
 Destroys a vertex declaration. More...
 
virtual void registerVertexBufferSourceAndCopy (const HardwareVertexBufferSharedPtr &sourceBuffer, const HardwareVertexBufferSharedPtr &copy)
 Registers a vertex buffer as a copy of another. More...
 
void releaseVertexBufferCopy (const HardwareVertexBufferSharedPtr &bufferCopy)
 Manually release a vertex buffer copy for others to subsequently use. More...
 
void touchVertexBufferCopy (const HardwareVertexBufferSharedPtr &bufferCopy)
 Tell engine that the vertex buffer copy intent to reuse. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::HardwareBufferManagerBase
enum  BufferLicenseType { BLT_MANUAL_RELEASE , BLT_AUTOMATIC_RELEASE }
 

Detailed Description

Specialisation of HardwareBufferManagerBase to emulate hardware buffers.

You might want to instantiate this class if you want to utilise classes like MeshSerializer without having initialised the rendering system (which is required to create a 'real' hardware buffer manager).

Constructor & Destructor Documentation

◆ DefaultHardwareBufferManagerBase()

Ogre::DefaultHardwareBufferManagerBase::DefaultHardwareBufferManagerBase ( )

◆ ~DefaultHardwareBufferManagerBase()

Ogre::DefaultHardwareBufferManagerBase::~DefaultHardwareBufferManagerBase ( )

Member Function Documentation

◆ createVertexBuffer()

HardwareVertexBufferPtr Ogre::DefaultHardwareBufferManagerBase::createVertexBuffer ( size_t  vertexSize,
size_t  numVerts,
HardwareBuffer::Usage  usage,
bool  useShadowBuffer = false 
)
overridevirtual

Create a hardware vertex buffer.

This method creates a new vertex buffer; this will act as a source of geometry data for rendering objects. Note that because the meaning of the contents of the vertex buffer depends on the usage, this method does not specify a vertex format; the user of this buffer can actually insert whatever data they wish, in any format. However, in order to use this with a RenderOperation, the data in this vertex buffer will have to be associated with a semantic element of the rendering pipeline, e.g. a position, or texture coordinates. This is done using the VertexDeclaration class, which itself contains VertexElement structures referring to the source data. Note that because vertex buffers can be shared, they are reference counted so you do not need to worry about destroying them this will be done automatically.

Parameters
vertexSizeThe size in bytes of each vertex in this buffer; you must calculate this based on the kind of data you expect to populate this buffer with.
numVertsThe number of vertices in this buffer.
usageOne or more members of the HardwareBufferUsage enumeration; you are strongly advised to use HBU_GPU_ONLY wherever possible, if you need to update regularly, consider HBU_CPU_TO_GPU or useShadowBuffer=true.
useShadowBufferIf set to true, this buffer will be 'shadowed' by one stored in system memory rather than GPU memory. See Shadow Buffers.

Implements Ogre::HardwareBufferManagerBase.

◆ createIndexBuffer()

HardwareIndexBufferPtr Ogre::DefaultHardwareBufferManagerBase::createIndexBuffer ( HardwareIndexBuffer::IndexType  itype,
size_t  numIndexes,
HardwareBuffer::Usage  usage,
bool  useShadowBuffer = false 
)
overridevirtual

Create a hardware index buffer.

Remarks
Note that because buffers can be shared, they are reference counted so you do not need to worry about destroying them this will be done automatically.
Parameters
itypeThe type in index, either 16- or 32-bit, depending on how many vertices you need to be able to address
numIndexesThe number of indexes in the buffer
usageOne or more members of the HardwareBufferUsage enumeration.
useShadowBufferIf set to true, this buffer will be 'shadowed' by one stored in system memory rather than GPU memory. See Shadow Buffers.

Implements Ogre::HardwareBufferManagerBase.

◆ createUniformBuffer()

HardwareBufferPtr Ogre::DefaultHardwareBufferManagerBase::createUniformBuffer ( size_t  sizeBytes,
HardwareBufferUsage  usage = HBU_CPU_ONLY,
bool  useShadowBuffer = false 
)
inlineoverridevirtual

Create uniform buffer.

This type of buffer allows the upload of shader constants once, and sharing between shader stages or even shaders from another materials. The update shall be triggered by GpuProgramParameters, if is dirty

Reimplemented from Ogre::HardwareBufferManagerBase.


The documentation for this class was generated from the following file: