CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

iDataBuffer Struct Reference
[UtilitiesUtilities]

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

#include <iutil/databuff.h>

Inheritance diagram for iDataBuffer:

iBase csDataBuffer csParasiticDataBufferBase csParasiticDataBuffer csParasiticDataBufferPooled List of all members.

Public Member Functions

virtual char * GetData () const =0
 Get the buffer as an abstract pointer.
int8GetInt8 ()
 Get as an int8 *.
virtual size_t GetSize () const =0
 Query the buffer size.
uint8GetUint8 ()
 Get as an uint8 *.
char * operator * () const
 Get the buffer as an (char *) pointer.

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  )  const [pure virtual]
 

Get the buffer as an abstract pointer.

Implemented in csDataBuffer, and csParasiticDataBufferBase.

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

int8* iDataBuffer::GetInt8  )  [inline]
 

Get as an int8 *.

Reimplemented in csParasiticDataBufferBase.

Definition at line 49 of file databuff.h.

References GetData().

virtual size_t iDataBuffer::GetSize  )  const [pure virtual]
 

Query the buffer size.

Implemented in csDataBuffer, and csParasiticDataBufferBase.

Referenced by csDataBuffer::csDataBuffer(), and csParasiticDataBufferBase::SetContents().

uint8* iDataBuffer::GetUint8  )  [inline]
 

Get as an uint8 *.

Reimplemented in csParasiticDataBufferBase.

Definition at line 52 of file databuff.h.

References GetData().

Referenced by csParasiticDataBufferBase::SetContents().

char* iDataBuffer::operator *  )  const [inline]
 

Get the buffer as an (char *) pointer.

Reimplemented in csParasiticDataBufferBase.

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.4.4