crystalspace.jbind.interfaces.ivideo.rndbuf
Interface iRenderBuffer

All Superinterfaces:
iBase, iPointer
All Known Implementing Classes:
csRenderBuffer

public interface iRenderBuffer
extends iBase

This is a general buffer to be used by the renderer. It can ONLY be created by the VB manager

Author:
Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/pubapi/structiRenderBuffer.php

Method Summary
 int getBufferType()
          Get type of buffer (static/dynamic);.
 int getComponentCount()
          Gets the number of components per element.
 int getComponentType()
          Gets the component type (float, int, etc);.
 int getSize()
          Get the size of the buffer (in bytes);.
 iPointer lock(int lockType)
          Lock the buffer to allow writing and give us a pointer to the data.
 void release()
          Releases the buffer.
 void setComponentCount(int count)
          Sets the number of components per element.
 void setComponentType(int type)
          Sets the component type (float, int, etc);.
 
Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase
decRef, getName, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe
 
Methods inherited from interface crystalspace.jbind.interfaces.iPointer
changePointer, getPointer, isMemoryOwner, setMemoryOwner
 

Method Detail

getBufferType

public int getBufferType()
Get type of buffer (static/dynamic);.

Returns:

getComponentCount

public int getComponentCount()
Gets the number of components per element.

Returns:

getComponentType

public int getComponentType()
Gets the component type (float, int, etc);.

Returns:

getSize

public int getSize()
Get the size of the buffer (in bytes);.

Returns:

lock

public iPointer lock(int lockType)
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.

Parameters:
lockType -
Returns:

release

public void release()
Releases the buffer. After this all writing to the buffer is illegal.


setComponentCount

public void setComponentCount(int count)
Sets the number of components per element.

Parameters:
count -

setComponentType

public void setComponentType(int type)
Sets the component type (float, int, etc);.

Parameters:
type -