CrystalSpace

Public API Reference

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

iDataBuffer Struct Reference
[Utilities]

The iDataBuffer interface can be used to exchange buffers with abstract data between plugins. More...

#include <databuff.h>

Inheritance diagram for iDataBuffer:

iBase csDataBuffer List of all members.

Public Methods

virtual size_t GetSize () const=0
 Query the buffer size.

virtual char * GetData () const=0
 Get the buffer as an abstract pointer.

char * operator * () const
 Get the buffer as an (char *) pointer.

int8GetInt8 ()
 Get as an int8 *.

uint8GetUint8 ()
 Get as an uint8 *.


Detailed Description

The iDataBuffer interface can be used to exchange buffers with abstract data between plugins.

The object does not care about the contents of the buffer; it just can perform several simple operations on them. The interface is designed to be light-weight, as an alternative to the heavy iString interface.

Definition at line 39 of file databuff.h.


Member Function Documentation

virtual char* iDataBuffer::GetData   [pure virtual]
 

Get the buffer as an abstract pointer.

Implemented in csDataBuffer.

Referenced by csDataBuffer::csDataBuffer(), GetInt8(), GetUint8(), and operator *().

int8* iDataBuffer::GetInt8   [inline]
 

Get as an int8 *.

Definition at line 49 of file databuff.h.

References GetData().

virtual size_t iDataBuffer::GetSize   [pure virtual]
 

Query the buffer size.

Implemented in csDataBuffer.

Referenced by csDataBuffer::csDataBuffer().

uint8* iDataBuffer::GetUint8   [inline]
 

Get as an uint8 *.

Definition at line 52 of file databuff.h.

References GetData().

char* iDataBuffer::operator *   const [inline]
 

Get the buffer as an (char *) pointer.

Definition at line 46 of file databuff.h.

References GetData().


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