Castor3D::RenderBuffer Class Reference

Render buffer base class. More...

Inheritance diagram for Castor3D::RenderBuffer:

Public Member Functions
C3D_API	RenderBuffer (eBUFFER_COMPONENT p_type, Castor::ePIXEL_FORMAT p_format)
	Constructor. More...
virtual C3D_API	~RenderBuffer ()
	Destructor. More...
virtual C3D_API bool	Create ()=0
	Creation function. More...
virtual C3D_API void	Destroy ()=0
	Destruction function. More...
virtual C3D_API bool	Initialise (Castor::Size const &p_size)=0
	Initialisation function. More...
virtual C3D_API void	Cleanup ()=0
	Cleanup function. More...
virtual C3D_API bool	Bind ()=0
	Activation function, to tell the GPU it is active. More...
virtual C3D_API void	Unbind ()=0
	Deactivation function, to tell the GPU it is inactive. More...
virtual C3D_API bool	Resize (Castor::Size const &p_size)=0
	Resizing function. More...
Castor::ePIXEL_FORMAT	GetPixelFormat () const
	Retrieves the buffer pixel format. More...
Castor::Size const &	GetDimensions () const
	Retrieves the buffer dimensions. More...
uint32_t	GetWidth () const
	Retrieves the buffer width. More...
uint32_t	GetHeight () const
	Retrieves the buffer height. More...
eBUFFER_COMPONENT	GetComponent () const
	Retrieves the buffer component. More...
void	SetSamplesCount (int p_iSamples)
	Defines the buffer samples count. More...
int	GetSamplesCount ()
	Retrieves the buffer samples count. More...

Protected Attributes
Castor::Size	m_size
	The buffer dimensions. More...

Detailed Description

Render buffer base class.

Author

Sylvain DOREMUS

Version

0.7.0.0

Date

12/11/2012

Remarks

A render buffer is a buffer that receives specific component from a frame buffer

Constructor & Destructor Documentation

RenderBuffer()

C3D_API Castor3D::RenderBuffer::RenderBuffer	(	eBUFFER_COMPONENT	p_type,
		Castor::ePIXEL_FORMAT	p_format
	)

Constructor.

Parameters

[in]	p_type	The buffer component
[in]	p_format	The buffer pixel format

~RenderBuffer()

virtual C3D_API Castor3D::RenderBuffer::~RenderBuffer ( )

virtual

Destructor.

Member Function Documentation

Bind()

virtual C3D_API bool Castor3D::RenderBuffer::Bind ( )

pure virtual

Activation function, to tell the GPU it is active.

Returns

true if successful

Cleanup()

virtual C3D_API void Castor3D::RenderBuffer::Cleanup ( )

pure virtual

Cleanup function.

Create()

virtual C3D_API bool Castor3D::RenderBuffer::Create ( )

pure virtual

Creation function.

Returns

true if OK

Destroy()

virtual C3D_API void Castor3D::RenderBuffer::Destroy ( )

pure virtual

Destruction function.

GetComponent()

eBUFFER_COMPONENT Castor3D::RenderBuffer::GetComponent ( ) const

inline

Retrieves the buffer component.

Returns

The component

GetDimensions()

Castor::Size const& Castor3D::RenderBuffer::GetDimensions ( ) const

inline

Retrieves the buffer dimensions.

Returns

The dimensions

References m_size.

GetHeight()

uint32_t Castor3D::RenderBuffer::GetHeight ( ) const

inline

Retrieves the buffer height.

Returns

The height

References m_size.

GetPixelFormat()

Castor::ePIXEL_FORMAT Castor3D::RenderBuffer::GetPixelFormat ( ) const

inline

Retrieves the buffer pixel format.

Returns

The pixel format

GetSamplesCount()

int Castor3D::RenderBuffer::GetSamplesCount ( )

inline

Retrieves the buffer samples count.

Returns

The samples count

GetWidth()

uint32_t Castor3D::RenderBuffer::GetWidth ( ) const

inline

Retrieves the buffer width.

Returns

The width

References m_size.

Initialise()

virtual C3D_API bool Castor3D::RenderBuffer::Initialise ( Castor::Size const &  p_size )

pure virtual

Initialisation function.

Parameters

[in]

p_size

The buffer dimensions

Returns

true if OK

Resize()

virtual C3D_API bool Castor3D::RenderBuffer::Resize ( Castor::Size const &  p_size )

pure virtual

Resizing function.

Parameters

[in]

p_size

The buffer dimensions

Returns

true if OK

SetSamplesCount()

void Castor3D::RenderBuffer::SetSamplesCount ( int  p_iSamples )

inline

Defines the buffer samples count.

Parameters

[in]

p_iSamples

The samples count

Unbind()

virtual C3D_API void Castor3D::RenderBuffer::Unbind ( )

pure virtual

Deactivation function, to tell the GPU it is inactive.

Member Data Documentation

m_size

Castor::Size Castor3D::RenderBuffer::m_size

protected

The buffer dimensions.

Referenced by GetDimensions(), GetHeight(), and GetWidth().

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/RenderBuffer.hpp