CL_PixelBufferProvider Class Reference [clanDisplay Display]

Element Array Buffer provider. More...

#include <pixel_buffer_provider.h>

List of all members.

Public Member Functions
Construction
virtual	~CL_PixelBufferProvider ()
virtual void	create (const void *data, int new_width, int new_height, CL_PixelBufferDirection direction, CL_TextureFormat new_format, CL_BufferUsage usage)=0
	Create.
virtual void	destroy ()=0
	Destroys the element array buffer provider.
Attributes
virtual void *	get_data ()=0
	Retrieves a pointer to the mapped buffer.
Operations
virtual void	lock (CL_BufferAccess access)=0
	Maps buffer into system memory.
virtual void	unlock ()=0
	Unmaps element buffer.
virtual void	upload_data (const CL_Rect &dest_rect, const void *data)=0
	Uploads data to buffer.

---

Detailed Description

Element Array Buffer provider.

---

Constructor & Destructor Documentation

virtual CL_PixelBufferProvider::~CL_PixelBufferProvider

(

)

[inline, virtual]

---

Member Function Documentation

virtual void CL_PixelBufferProvider::create	(	const void *	data,
		int	new_width,
		int	new_height,
		CL_PixelBufferDirection	direction,
		CL_TextureFormat	new_format,
		CL_BufferUsage	usage
	)			[pure virtual]

Create.

Parameters:

	data	= void
	new_width	= New width
	new_height	= New height
	direction	= Direction
	new_format	= New format
	usage	= Buffer Usage

virtual void CL_PixelBufferProvider::destroy

(

)

[pure virtual]

Destroys the element array buffer provider.

virtual void* CL_PixelBufferProvider::get_data

(

)

[pure virtual]

Retrieves a pointer to the mapped buffer.

virtual void CL_PixelBufferProvider::lock

(

CL_BufferAccess

access

)

[pure virtual]

Maps buffer into system memory.

virtual void CL_PixelBufferProvider::unlock

(

)

[pure virtual]

Unmaps element buffer.

virtual void CL_PixelBufferProvider::upload_data	(	const CL_Rect &	dest_rect,
		const void *	data
	)			[pure virtual]

Uploads data to buffer.

---

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

• pixel_buffer_provider.h