clan::PixelBufferProvider Class Referenceabstract

Element Array Buffer provider. More...

#include <pixel_buffer_provider.h>

Public Member Functions

virtual ~PixelBufferProvider ()
virtual void create (const void *data, const Size &new_size, PixelBufferDirection direction, TextureFormat new_format, BufferUsage usage)=0
 Create. More...
virtual void * get_data ()=0
 Retrieves a pointer to the mapped buffer. More...
virtual TextureFormat get_format () const =0
 Returns the pixel format. More...
virtual int get_pitch () const =0
 Retrieves the pitch of the mapped buffer. Use this after get_data() More...
virtual Size get_size () const =0
virtual bool is_gpu () const =0
 Returns true if this pixel buffer is a GPU based one. More...
virtual void lock (GraphicContext &gc, BufferAccess access)=0
 Maps buffer into system memory. More...
virtual void unlock ()=0
 Unmaps element buffer. More...
virtual void upload_data (GraphicContext &gc, const Rect &dest_rect, const void *data)=0
 Uploads data to buffer. More...

Detailed Description

Element Array Buffer provider.

Constructor & Destructor Documentation

virtual clan::PixelBufferProvider::~PixelBufferProvider ( )

Member Function Documentation

virtual void clan::PixelBufferProvider::create ( const void *  data,
const Size new_size,
PixelBufferDirection  direction,
TextureFormat  new_format,
BufferUsage  usage 
pure virtual


data= void
new_width= New width
new_height= New height
direction= Direction
new_format= New format
usage= Buffer Usage
virtual void* clan::PixelBufferProvider::get_data ( )
pure virtual

Retrieves a pointer to the mapped buffer.

virtual TextureFormat clan::PixelBufferProvider::get_format ( ) const
pure virtual

Returns the pixel format.

virtual int clan::PixelBufferProvider::get_pitch ( ) const
pure virtual

Retrieves the pitch of the mapped buffer. Use this after get_data()

virtual Size clan::PixelBufferProvider::get_size ( ) const
pure virtual
virtual bool clan::PixelBufferProvider::is_gpu ( ) const
pure virtual

Returns true if this pixel buffer is a GPU based one.

virtual void clan::PixelBufferProvider::lock ( GraphicContext gc,
BufferAccess  access 
pure virtual

Maps buffer into system memory.

virtual void clan::PixelBufferProvider::unlock ( )
pure virtual

Unmaps element buffer.

virtual void clan::PixelBufferProvider::upload_data ( GraphicContext gc,
const Rect dest_rect,
const void *  data 
pure virtual

Uploads data to buffer.

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