OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::GLRenderToVertexBuffer Class Reference

An object which renders geometry to a vertex. More...

#include <OgreGLRenderToVertexBuffer.h>

+ Inheritance diagram for Ogre::GLRenderToVertexBuffer:
+ Collaboration diagram for Ogre::GLRenderToVertexBuffer:

Public Member Functions

 GLRenderToVertexBuffer ()
 C'tor. More...
 
virtual ~GLRenderToVertexBuffer ()
 D'tor. More...
 
unsigned int getMaxVertexCount () const
 Get the maximum number of vertices that the buffer will hold. More...
 
RenderOperation::OperationType getOperationType () const
 What type of primitives does this object generate? More...
 
virtual void getRenderOperation (RenderOperation &op)
 Get the render operation for this buffer. More...
 
const MaterialPtrgetRenderToBufferMaterial ()
 Get the material which is used to render the geometry into the vertex buffer. More...
 
bool getResetsEveryUpdate () const
 Does this object reset its buffer each time it updates? More...
 
const RenderablegetSourceRenderable () const
 Get the source renderable of this object. More...
 
VertexDeclarationgetVertexDeclaration ()
 Get the vertex declaration that the pass will output. More...
 
virtual void reset ()
 Reset the vertex buffer to the initial state. More...
 
void setMaxVertexCount (unsigned int maxVertexCount)
 Set the maximum number of vertices that the buffer will hold. More...
 
void setOperationType (RenderOperation::OperationType operationType)
 Set the type of primitives that this object generates. More...
 
void setRenderToBufferMaterialName (const String &materialName)
 Set the material name which is used to render the geometry into the vertex buffer. More...
 
void setResetsEveryUpdate (bool resetsEveryUpdate)
 Set whether this object resets its buffers each time it updates. More...
 
void setSourceRenderable (Renderable *source)
 Set the source renderable of this object. More...
 
virtual void update (SceneManager *sceneMgr)
 Update the contents of this vertex buffer by rendering. More...
 

Protected Member Functions

void bindVerticesOutput (Pass *pass)
 
GLint getGLSemanticType (VertexElementSemantic semantic)
 
String getSemanticVaryingName (VertexElementSemantic semantic, unsigned short index)
 
void reallocateBuffer (size_t index)
 

Protected Attributes

size_t mFrontBufferIndex
 
MaterialPtr mMaterial
 
unsigned int mMaxVertexCount
 
RenderOperation::OperationType mOperationType
 
GLuint mPrimitivesDrawnQuery
 
bool mResetRequested
 
bool mResetsEveryUpdate
 
RenderablemSourceRenderable
 
HardwareVertexBufferSharedPtr mVertexBuffers [2]
 
VertexDatamVertexData
 

Detailed Description

An object which renders geometry to a vertex.

Remarks
This is especially useful together with geometry shaders, as you can render procedural geometry which will get saved to a vertex buffer for reuse later, without regenerating it again. You can also create shaders that run on previous results of those shaders, creating stateful shaders.

Definition at line 44 of file OgreGLRenderToVertexBuffer.h.

Constructor & Destructor Documentation

Ogre::GLRenderToVertexBuffer::GLRenderToVertexBuffer ( )

C'tor.

virtual Ogre::GLRenderToVertexBuffer::~GLRenderToVertexBuffer ( )
virtual

D'tor.

Member Function Documentation

void Ogre::GLRenderToVertexBuffer::bindVerticesOutput ( Pass pass)
protected
GLint Ogre::GLRenderToVertexBuffer::getGLSemanticType ( VertexElementSemantic  semantic)
protected
unsigned int Ogre::RenderToVertexBuffer::getMaxVertexCount ( ) const
inlineinherited

Get the maximum number of vertices that the buffer will hold.

Definition at line 69 of file OgreRenderToVertexBuffer.h.

RenderOperation::OperationType Ogre::RenderToVertexBuffer::getOperationType ( ) const
inlineinherited

What type of primitives does this object generate?

Definition at line 79 of file OgreRenderToVertexBuffer.h.

virtual void Ogre::GLRenderToVertexBuffer::getRenderOperation ( RenderOperation op)
virtual

Get the render operation for this buffer.

Implements Ogre::RenderToVertexBuffer.

const MaterialPtr& Ogre::RenderToVertexBuffer::getRenderToBufferMaterial ( )
inlineinherited

Get the material which is used to render the geometry into the vertex buffer.

Definition at line 128 of file OgreRenderToVertexBuffer.h.

bool Ogre::RenderToVertexBuffer::getResetsEveryUpdate ( ) const
inlineinherited

Does this object reset its buffer each time it updates?

Definition at line 94 of file OgreRenderToVertexBuffer.h.

String Ogre::GLRenderToVertexBuffer::getSemanticVaryingName ( VertexElementSemantic  semantic,
unsigned short  index 
)
protected
const Renderable* Ogre::RenderToVertexBuffer::getSourceRenderable ( ) const
inlineinherited

Get the source renderable of this object.

Definition at line 122 of file OgreRenderToVertexBuffer.h.

VertexDeclaration* Ogre::RenderToVertexBuffer::getVertexDeclaration ( )
inherited

Get the vertex declaration that the pass will output.

Remarks
Use this object to set the elements of the buffer. Object will calculate buffers on its own. Only one source allowed!
void Ogre::GLRenderToVertexBuffer::reallocateBuffer ( size_t  index)
protected
virtual void Ogre::RenderToVertexBuffer::reset ( void  )
inlinevirtualinherited

Reset the vertex buffer to the initial state.

In the next update, the source renderable will be used as input.

Definition at line 110 of file OgreRenderToVertexBuffer.h.

void Ogre::RenderToVertexBuffer::setMaxVertexCount ( unsigned int  maxVertexCount)
inlineinherited

Set the maximum number of vertices that the buffer will hold.

Definition at line 74 of file OgreRenderToVertexBuffer.h.

void Ogre::RenderToVertexBuffer::setOperationType ( RenderOperation::OperationType  operationType)
inlineinherited

Set the type of primitives that this object generates.

Definition at line 84 of file OgreRenderToVertexBuffer.h.

void Ogre::RenderToVertexBuffer::setRenderToBufferMaterialName ( const String materialName)
inherited

Set the material name which is used to render the geometry into the vertex buffer.

void Ogre::RenderToVertexBuffer::setResetsEveryUpdate ( bool  resetsEveryUpdate)
inlineinherited

Set whether this object resets its buffers each time it updates.

Definition at line 89 of file OgreRenderToVertexBuffer.h.

void Ogre::RenderToVertexBuffer::setSourceRenderable ( Renderable source)
inlineinherited

Set the source renderable of this object.

During the first (and perhaps later) update of this object, this object's data will be used as input)

Definition at line 117 of file OgreRenderToVertexBuffer.h.

virtual void Ogre::GLRenderToVertexBuffer::update ( SceneManager sceneMgr)
virtual

Update the contents of this vertex buffer by rendering.

Implements Ogre::RenderToVertexBuffer.

Member Data Documentation

size_t Ogre::GLRenderToVertexBuffer::mFrontBufferIndex
protected

Definition at line 67 of file OgreGLRenderToVertexBuffer.h.

MaterialPtr Ogre::RenderToVertexBuffer::mMaterial
protectedinherited

Definition at line 140 of file OgreRenderToVertexBuffer.h.

unsigned int Ogre::RenderToVertexBuffer::mMaxVertexCount
protectedinherited

Definition at line 143 of file OgreRenderToVertexBuffer.h.

RenderOperation::OperationType Ogre::RenderToVertexBuffer::mOperationType
protectedinherited

Definition at line 137 of file OgreRenderToVertexBuffer.h.

GLuint Ogre::GLRenderToVertexBuffer::mPrimitivesDrawnQuery
protected

Definition at line 68 of file OgreGLRenderToVertexBuffer.h.

bool Ogre::RenderToVertexBuffer::mResetRequested
protectedinherited

Definition at line 139 of file OgreRenderToVertexBuffer.h.

bool Ogre::RenderToVertexBuffer::mResetsEveryUpdate
protectedinherited

Definition at line 138 of file OgreRenderToVertexBuffer.h.

Renderable* Ogre::RenderToVertexBuffer::mSourceRenderable
protectedinherited

Definition at line 141 of file OgreRenderToVertexBuffer.h.

HardwareVertexBufferSharedPtr Ogre::GLRenderToVertexBuffer::mVertexBuffers[2]
protected

Definition at line 66 of file OgreGLRenderToVertexBuffer.h.

VertexData* Ogre::RenderToVertexBuffer::mVertexData
protectedinherited

Definition at line 142 of file OgreRenderToVertexBuffer.h.


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