Public API Reference

               

---

iRenderBuffer Struct Reference
[3D]

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

#include <rndbuf.h>

Inheritance diagram for iRenderBuffer:

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 The pointer will be NULL if there was some error. More...
virtual void	Release ()=0
	Releases the buffer. After this all writing to the buffer is illegal. More...
virtual int	GetComponentCount ()=0
	Gets the number of components per element. More...
virtual csRenderBufferComponentType	GetComponentType ()=0
	Gets the component type. More...
virtual bool	IsDiscarded ()=0
	Returns wheter the buffer is discarded or not. More...
virtual void	CanDiscard (bool value)=0
	Set if buffer can be discarded or not. More...
virtual csRenderBufferType	GetBufferType ()=0
	Get type of buffer (where it's located). More...
virtual int	GetSize ()=0
	Get the size of the buffer (in bytes). More...

---

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 86 of file rndbuf.h.

---

Member Function Documentation

virtual void iRenderBuffer::CanDiscard (  bool    value )  [pure virtual]

Set if buffer can be discarded or not.

virtual csRenderBufferType iRenderBuffer::GetBufferType (    )  [pure virtual]

Get type of buffer (where it's located).

virtual int iRenderBuffer::GetComponentCount (    )  [pure virtual]

Gets the number of components per element.

virtual csRenderBufferComponentType iRenderBuffer::GetComponentType (    )  [pure virtual]

Gets the component type.

virtual int iRenderBuffer::GetSize (    )  [pure virtual]

Get the size of the buffer (in bytes).

virtual bool iRenderBuffer::IsDiscarded (    )  [pure virtual]

Returns wheter the buffer is discarded or not.

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 NULL if there was some error.

virtual void iRenderBuffer::Release (    )  [pure virtual]

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

---

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

• rndbuf.h

---