CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iRenderBuffer Struct Reference
[3D]

This is a general buffer to be used by the renderer. More...

#include <rndbuf.h>

Inheritance diagram for iRenderBuffer:

iBase List of all members.

Public Methods

virtual void * Lock (csRenderBufferLockType lockType)=0
 Lock the buffer to allow writing and give us a pointer to the data.

virtual void Release ()=0
 Releases the buffer. After this all writing to the buffer is illegal.

virtual void SetComponentCount (int count)=0
 Sets the number of components per element.

virtual int GetComponentCount () const=0
 Gets the number of components per element.

virtual void SetComponentType (csRenderBufferComponentType type)=0
 Sets the component type (float, int, etc).

virtual csRenderBufferComponentType GetComponentType () const=0
 Gets the component type (float, int, etc).

virtual csRenderBufferType GetBufferType () const=0
 Get type of buffer (static/dynamic).

virtual int GetSize () const=0
 Get the size of the buffer (in bytes).


Detailed Description

This is a general buffer to be used by the renderer.

It can ONLY be created by the VB manager

Definition at line 83 of file rndbuf.h.


Member Function Documentation

virtual csRenderBufferType iRenderBuffer::GetBufferType   [pure virtual]
 

Get type of buffer (static/dynamic).

virtual int iRenderBuffer::GetComponentCount   [pure virtual]
 

Gets the number of components per element.

virtual csRenderBufferComponentType iRenderBuffer::GetComponentType   [pure virtual]
 

Gets the component type (float, int, etc).

virtual int iRenderBuffer::GetSize   [pure virtual]
 

Get the size of the buffer (in bytes).

virtual void* iRenderBuffer::Lock csRenderBufferLockType    lockType [pure virtual]
 

Lock the buffer to allow writing and give us a pointer to the data.

The pointer will be (void*)-1 if there was some error.

virtual void iRenderBuffer::Release   [pure virtual]
 

Releases the buffer. After this all writing to the buffer is illegal.

virtual void iRenderBuffer::SetComponentCount int    count [pure virtual]
 

Sets the number of components per element.

virtual void iRenderBuffer::SetComponentType csRenderBufferComponentType    type [pure virtual]
 

Sets the component type (float, int, etc).


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18