csRenderBuffer Class Reference
[Graphics]
Render buffer - basic container for mesh geometry data.
More...
#include <csgfx/renderbuffer.h>
Inherits scfImplementation1<csRenderBuffer, iRenderBuffer>.
Classes | |
struct | Props |
To scrape off a few bytes use bitfields; assumes values are in sane limits. More... | |
Public Member Functions | |
virtual | ~csRenderBuffer () |
Destructor. | |
iRenderBuffer implementation | |
virtual void | CopyInto (const void *data, size_t elementCount, size_t elemOffset=0) |
Get version. | |
virtual csRenderBufferType | GetBufferType () const |
Get version. | |
virtual int | GetComponentCount () const |
Get version. | |
virtual csRenderBufferComponentType | GetComponentType () const |
Get version. | |
virtual size_t | GetElementCount () const |
Get version. | |
virtual size_t | GetElementDistance () const |
Get version. | |
virtual iRenderBuffer * | GetMasterBuffer () const |
Get version. | |
virtual size_t | GetOffset () const |
Get version. | |
virtual size_t | GetRangeEnd () const |
Get version. | |
virtual size_t | GetRangeStart () const |
Get version. | |
virtual size_t | GetSize () const |
Get version. | |
virtual size_t | GetStride () const |
Get version. | |
virtual uint | GetVersion () |
Get version. | |
virtual bool | IsIndexBuffer () const |
Get version. | |
bool | IsMasterBuffer () |
Get version. | |
virtual void * | Lock (csRenderBufferLockType lockType) |
Get version. | |
virtual void | Release () |
Get version. | |
virtual void | SetCallback (iRenderBufferCallback *cb) |
Get version. | |
virtual void | SetData (const void *data) |
Get version. | |
void | SetIndexBufferProperties (size_t elementCount, csRenderBufferType type, csRenderBufferComponentType componentType, size_t rangeStart, size_t rangeEnd, bool copy=true) |
Change properties of a render buffer after creation (DANGEROUS). | |
void | SetRenderBufferProperties (size_t elementCount, csRenderBufferType type, csRenderBufferComponentType componentType, uint componentCount, bool copy=true) |
Change properties of a render buffer after creation (DANGEROUS). | |
Static Public Member Functions | |
Render buffer creation | |
static csRef< csRenderBuffer > | CreateIndexRenderBuffer (size_t elementCount, csRenderBufferType type, csRenderBufferComponentType componentType, size_t rangeStart, size_t rangeEnd, bool copy) |
Create an index buffer. | |
static csRef< csRenderBuffer > | CreateIndexRenderBuffer (size_t elementCount, csRenderBufferType type, csRenderBufferComponentType componentType, size_t rangeStart, size_t rangeEnd) |
Create an index buffer. | |
static csRef< csRenderBuffer > | CreateInterleavedRenderBuffers (size_t elementCount, csRenderBufferType type, uint count, const csInterleavedSubBufferOptions *elements, csRef< iRenderBuffer > *buffers) |
Create an interleaved renderbuffer (You would use this then set stride to determine offset and stride of the interleaved buffer. | |
static csRef< csRenderBuffer > | CreateRenderBuffer (size_t elementCount, csRenderBufferType type, csRenderBufferComponentType componentType, uint componentCount, bool copy) |
Create an index buffer. | |
static csRef< csRenderBuffer > | CreateRenderBuffer (size_t elementCount, csRenderBufferType type, csRenderBufferComponentType componentType, uint componentCount) |
Create a render buffer. | |
"Friendly" name utilities | |
static csRenderBufferName | GetBufferNameFromDescr (const char *name) |
Retrieve the buffer name for a "friendly" buffer description. | |
static const char * | GetDescrFromBufferName (csRenderBufferName bufferName) |
Utility to retrieve the "friendly" string name of a buffer description, e.g. | |
Protected Member Functions | |
csRenderBuffer (size_t size, csRenderBufferType type, csRenderBufferComponentType componentType, uint componentCount, size_t rangeStart, size_t rangeEnd, bool copy=true) | |
Constructor. | |
Protected Attributes | |
unsigned char * | buffer |
buffer holding the data | |
size_t | bufferSize |
Total size of the buffer. | |
struct csRenderBuffer::Props | props |
To scrape off a few bytes use bitfields; assumes values are in sane limits. | |
size_t | rangeEnd |
range start for index-buffer | |
size_t | rangeStart |
range start for index-buffer | |
unsigned int | version |
modification number |
Detailed Description
Render buffer - basic container for mesh geometry data.Definition at line 58 of file renderbuffer.h.
Constructor & Destructor Documentation
csRenderBuffer::csRenderBuffer | ( | size_t | size, | |
csRenderBufferType | type, | |||
csRenderBufferComponentType | componentType, | |||
uint | componentCount, | |||
size_t | rangeStart, | |||
size_t | rangeEnd, | |||
bool | copy = true | |||
) | [protected] |
Constructor.
virtual csRenderBuffer::~csRenderBuffer | ( | ) | [virtual] |
Destructor.
Member Function Documentation
virtual void csRenderBuffer::CopyInto | ( | const void * | data, | |
size_t | elementCount, | |||
size_t | elemOffset = 0 | |||
) | [virtual] |
Get version.
static csRef<csRenderBuffer> csRenderBuffer::CreateIndexRenderBuffer | ( | size_t | elementCount, | |
csRenderBufferType | type, | |||
csRenderBufferComponentType | componentType, | |||
size_t | rangeStart, | |||
size_t | rangeEnd, | |||
bool | copy | |||
) | [static] |
Create an index buffer.
- Parameters:
-
elementCount Number of elements in the buffer. type Type of buffer; CS_BUF_DYNAMIC, CS_BUF_STATIC or CS_BUF_STREAM. componentType Components Types; usually CS_BUFCOMP_UNSIGNED_INT rangeStart Minimum index value that is expected to be written to the created buffer. rangeEnd Maximum index value that is expected to be written to the created buffer. copy if true (default) then this buffer will make a copy of the data, else just save the buffer pointers provided by the caller. This has some implications: CopyInto() does not copy, merely update the internal buffer pointer. Lock() just returns that pointer. The pointer passed to CopyInto() must be valid over the lifetime of the render buffer.
static csRef<csRenderBuffer> csRenderBuffer::CreateIndexRenderBuffer | ( | size_t | elementCount, | |
csRenderBufferType | type, | |||
csRenderBufferComponentType | componentType, | |||
size_t | rangeStart, | |||
size_t | rangeEnd | |||
) | [static] |
Create an index buffer.
- Parameters:
-
elementCount Number of elements in the buffer. type Type of buffer; CS_BUF_DYNAMIC, CS_BUF_STATIC or CS_BUF_STREAM. componentType Components Types; usually CS_BUFCOMP_UNSIGNED_INT rangeStart Minimum index value that is expected to be written to the created buffer. rangeEnd Maximum index value that is expected to be written to the created buffer. copy if true (default) then this buffer will make a copy of the data, else just save the buffer pointers provided by the caller. This has some implications: CopyInto() does not copy, merely update the internal buffer pointer. Lock() just returns that pointer. The pointer passed to CopyInto() must be valid over the lifetime of the render buffer.
static csRef<csRenderBuffer> csRenderBuffer::CreateInterleavedRenderBuffers | ( | size_t | elementCount, | |
csRenderBufferType | type, | |||
uint | count, | |||
const csInterleavedSubBufferOptions * | elements, | |||
csRef< iRenderBuffer > * | buffers | |||
) | [static] |
Create an interleaved renderbuffer (You would use this then set stride to determine offset and stride of the interleaved buffer.
- Parameters:
-
elementCount Number of elements in the buffer. type Type of buffer; CS_BUF_DYNAMIC, CS_BUF_STATIC or CS_BUF_STREAM. count number of render buffers you want elements Array of csInterleavedSubBufferOptions describing the properties of the individual buffers to be interleaved. buffers an array of render buffer references that can hold at least 'count' render buffers.
static const csInterleavedSubBufferOptions interleavedElements[2] = {{CS_BUFCOMP_FLOAT, 3}, {CS_BUFCOMP_FLOAT, 2}}; csRef<iRenderBuffer> buffers[2]; csRenderBuffer::CreateInterleavedRenderBuffers (num_verts, CS_BUF_STATIC, 2, interleavedElements, buffers); csRef<iRenderBuffer> vertex_buffer = buffers[0]; csRef<iRenderBuffer> texel_buffer = buffers[1];
static csRef<csRenderBuffer> csRenderBuffer::CreateRenderBuffer | ( | size_t | elementCount, | |
csRenderBufferType | type, | |||
csRenderBufferComponentType | componentType, | |||
uint | componentCount, | |||
bool | copy | |||
) | [static] |
Create an index buffer.
- Parameters:
-
elementCount Number of elements in the buffer. type Type of buffer; CS_BUF_DYNAMIC, CS_BUF_STATIC or CS_BUF_STREAM. componentType Components Types; usually CS_BUFCOMP_UNSIGNED_INT rangeStart Minimum index value that is expected to be written to the created buffer. rangeEnd Maximum index value that is expected to be written to the created buffer. copy if true (default) then this buffer will make a copy of the data, else just save the buffer pointers provided by the caller. This has some implications: CopyInto() does not copy, merely update the internal buffer pointer. Lock() just returns that pointer. The pointer passed to CopyInto() must be valid over the lifetime of the render buffer.
static csRef<csRenderBuffer> csRenderBuffer::CreateRenderBuffer | ( | size_t | elementCount, | |
csRenderBufferType | type, | |||
csRenderBufferComponentType | componentType, | |||
uint | componentCount | |||
) | [static] |
Create a render buffer.
- Parameters:
-
elementCount Number of elements in the buffer. type Type of buffer; CS_BUF_DYNAMIC, CS_BUF_STATIC or CS_BUF_STREAM. componentType Components Types; CS_BUFCOMP_FLOAT, CS_BUFCOMP_INT, etc componentCount Number of components per element (e.g. 4 for RGBA) copy if true (default) then this buffer will make a copy of the data, else just save the buffer pointers provided by the caller. This has some implications: CopyInto() does not copy, merely update the internal buffer pointer. Lock() just returns that pointer. The pointer passed to CopyInto() must be valid over the lifetime of the render buffer.
static csRenderBufferName csRenderBuffer::GetBufferNameFromDescr | ( | const char * | name | ) | [static] |
Retrieve the buffer name for a "friendly" buffer description.
Can be used to parse e.g. shader files.
virtual csRenderBufferType csRenderBuffer::GetBufferType | ( | ) | const [inline, virtual] |
virtual int csRenderBuffer::GetComponentCount | ( | ) | const [inline, virtual] |
virtual csRenderBufferComponentType csRenderBuffer::GetComponentType | ( | ) | const [inline, virtual] |
static const char* csRenderBuffer::GetDescrFromBufferName | ( | csRenderBufferName | bufferName | ) | [static] |
Utility to retrieve the "friendly" string name of a buffer description, e.g.
"position" for CS_BUFFER_POSITION.
virtual size_t csRenderBuffer::GetElementCount | ( | ) | const [virtual] |
Get version.
virtual size_t csRenderBuffer::GetElementDistance | ( | ) | const [inline, virtual] |
virtual iRenderBuffer* csRenderBuffer::GetMasterBuffer | ( | ) | const [inline, virtual] |
virtual size_t csRenderBuffer::GetOffset | ( | ) | const [inline, virtual] |
virtual size_t csRenderBuffer::GetRangeEnd | ( | ) | const [inline, virtual] |
virtual size_t csRenderBuffer::GetRangeStart | ( | ) | const [inline, virtual] |
virtual size_t csRenderBuffer::GetSize | ( | ) | const [inline, virtual] |
virtual size_t csRenderBuffer::GetStride | ( | ) | const [inline, virtual] |
virtual uint csRenderBuffer::GetVersion | ( | ) | [inline, virtual] |
virtual bool csRenderBuffer::IsIndexBuffer | ( | ) | const [inline, virtual] |
bool csRenderBuffer::IsMasterBuffer | ( | ) | [inline] |
virtual void* csRenderBuffer::Lock | ( | csRenderBufferLockType | lockType | ) | [virtual] |
Get version.
virtual void csRenderBuffer::Release | ( | ) | [virtual] |
Get version.
virtual void csRenderBuffer::SetCallback | ( | iRenderBufferCallback * | cb | ) | [inline, virtual] |
virtual void csRenderBuffer::SetData | ( | const void * | data | ) | [virtual] |
Get version.
void csRenderBuffer::SetIndexBufferProperties | ( | size_t | elementCount, | |
csRenderBufferType | type, | |||
csRenderBufferComponentType | componentType, | |||
size_t | rangeStart, | |||
size_t | rangeEnd, | |||
bool | copy = true | |||
) |
Change properties of a render buffer after creation (DANGEROUS).
- Warning:
- If the buffer was already passed around and is thus probably used somewhere, changing properties with this methiod is a sure-fire way to wreak havoc. This function is useful in very very specific scenarios; only use it if you really know what you're doing.
void csRenderBuffer::SetRenderBufferProperties | ( | size_t | elementCount, | |
csRenderBufferType | type, | |||
csRenderBufferComponentType | componentType, | |||
uint | componentCount, | |||
bool | copy = true | |||
) |
Change properties of a render buffer after creation (DANGEROUS).
- Warning:
- If the buffer was already passed around and is thus probably used somewhere, changing properties with this methiod is a sure-fire way to wreak havoc. This function is useful in very very specific scenarios; only use it if you really know what you're doing.
Member Data Documentation
unsigned char* csRenderBuffer::buffer [protected] |
size_t csRenderBuffer::bufferSize [protected] |
struct csRenderBuffer::Props csRenderBuffer::props [protected] |
To scrape off a few bytes use bitfields; assumes values are in sane limits.
size_t csRenderBuffer::rangeEnd [protected] |
size_t csRenderBuffer::rangeStart [protected] |
unsigned int csRenderBuffer::version [protected] |
The documentation for this class was generated from the following file:
- csgfx/renderbuffer.h
Generated for Crystal Space 1.4.0 by doxygen 1.5.8