Castor3D::Generator Class Reference

Collaboration diagram for Castor3D::Generator:

Classes
class	Thread

Public Member Functions
C3D_API	Generator (Engine *p_engine, int p_width, int p_height)
virtual C3D_API	~Generator ()
virtual C3D_API bool	Step ()
virtual C3D_API void	SetRed (uint8_t val)
virtual C3D_API void	SetGreen (uint8_t val)
virtual C3D_API void	SetBlue (uint8_t val)
virtual C3D_API void	SwapBuffers ()
virtual C3D_API void	InitialiseStep ()
virtual C3D_API void	ClearAllThreads ()
C3D_API bool	AllEnded ()
C3D_API void	Suspend ()
C3D_API void	SetSize (int p_iWidth, int p_iHeight)
C3D_API void	SetSize (Castor::Point2i const &p_size)
C3D_API void	SaveFrame ()
template<class ThreadClass >
ThreadClass *	CreateThread (int iWidth, int iTop, int iBottom, int iTotalHeight, Castor::UbPixel const &p_pxColour)
uint8_t	GetRed () const
uint8_t	GetGreen () const
uint8_t	GetBlue () const
bool	IsInitialised () const
Castor::PixelBuffer const *	GetPixelsBuffer () const
Castor::PixelBuffer *	GetPixelsBuffer ()
int	GetWidth () const
int	GetHeight () const

Protected Member Functions
C3D_API void	DoCleanup ()
uint32_t	DoGetThreadsCount ()
C3D_API Castor::Point2i	_loadImage (Castor::String const &p_strImagePath, Castor::Image &p_pImage)
C3D_API void	_subRender ()
C3D_API void	_saveFrame ()

Protected Attributes
int	m_iWidth
int	m_iHeight
unsigned long long	m_ullStep
Castor::PixelBuffer	m_frontBuffer
Castor::PixelBuffer	m_backBuffer
Castor::UbPixel	m_pxColour
uint32_t	m_uiThreadCount
bool	m_bEnded
std::vector< Thread * >	m_arraySlaveThreads
bool	m_initialised
TextureUnit *	m_pTexture
Engine *	m_engine

Constructor & Destructor Documentation

Generator()

C3D_API Castor3D::Generator::Generator	(	Engine *	p_engine,
		int	p_width,
		int	p_height
	)

~Generator()

virtual C3D_API Castor3D::Generator::~Generator ( )

virtual

Member Function Documentation

_loadImage()

C3D_API Castor::Point2i Castor3D::Generator::_loadImage ( Castor::String const &  p_strImagePath, Castor::Image &  p_pImage  )

protected

_saveFrame()

C3D_API void Castor3D::Generator::_saveFrame ( )

protected

_subRender()

C3D_API void Castor3D::Generator::_subRender ( )

protected

AllEnded()

C3D_API bool Castor3D::Generator::AllEnded

(

)

ClearAllThreads()

virtual C3D_API void Castor3D::Generator::ClearAllThreads ( )

virtual

CreateThread()

template<class ThreadClass >

ThreadClass* Castor3D::Generator::CreateThread ( int  iWidth, int  iTop, int  iBottom, int  iTotalHeight, Castor::UbPixel const &  p_pxColour  )

inline

References m_arraySlaveThreads, and m_iWidth.

DoCleanup()

C3D_API void Castor3D::Generator::DoCleanup ( )

protected

DoGetThreadsCount()

uint32_t Castor3D::Generator::DoGetThreadsCount ( )

inlineprotected

References m_arraySlaveThreads.

GetBlue()

uint8_t Castor3D::Generator::GetBlue ( ) const

inline

References m_pxColour.

GetGreen()

uint8_t Castor3D::Generator::GetGreen ( ) const

inline

References m_pxColour.

GetHeight()

int Castor3D::Generator::GetHeight ( ) const

inline

References m_iHeight.

GetPixelsBuffer() [1/2]

Castor::PixelBuffer const* Castor3D::Generator::GetPixelsBuffer ( ) const

inline

References m_frontBuffer.

GetPixelsBuffer() [2/2]

Castor::PixelBuffer* Castor3D::Generator::GetPixelsBuffer ( )

inline

References m_frontBuffer.

GetRed()

uint8_t Castor3D::Generator::GetRed ( ) const

inline

References m_pxColour.

GetWidth()

int Castor3D::Generator::GetWidth ( ) const

inline

References m_iWidth.

InitialiseStep()

virtual C3D_API void Castor3D::Generator::InitialiseStep ( )

virtual

IsInitialised()

bool Castor3D::Generator::IsInitialised ( ) const

inline

References m_initialised.

SaveFrame()

C3D_API void Castor3D::Generator::SaveFrame

(

)

SetBlue()

virtual C3D_API void Castor3D::Generator::SetBlue ( uint8_t  val )

virtual

SetGreen()

virtual C3D_API void Castor3D::Generator::SetGreen ( uint8_t  val )

virtual

SetRed()

virtual C3D_API void Castor3D::Generator::SetRed ( uint8_t  val )

virtual

SetSize() [1/2]

C3D_API void Castor3D::Generator::SetSize	(	int	p_iWidth,
		int	p_iHeight
	)

SetSize() [2/2]

C3D_API void Castor3D::Generator::SetSize

(

Castor::Point2i const &

p_size

)

Step()

virtual C3D_API bool Castor3D::Generator::Step ( )

virtual

Suspend()

C3D_API void Castor3D::Generator::Suspend

(

)

SwapBuffers()

virtual C3D_API void Castor3D::Generator::SwapBuffers ( )

virtual

Member Data Documentation

m_arraySlaveThreads

std::vector<Thread *> Castor3D::Generator::m_arraySlaveThreads

protected

Referenced by CreateThread(), and DoGetThreadsCount().

m_backBuffer

Castor::PixelBuffer Castor3D::Generator::m_backBuffer

protected

m_bEnded

bool Castor3D::Generator::m_bEnded

protected

m_engine

Engine* Castor3D::Generator::m_engine

protected

m_frontBuffer

Castor::PixelBuffer Castor3D::Generator::m_frontBuffer

protected

Referenced by GetPixelsBuffer().

m_iHeight

int Castor3D::Generator::m_iHeight

protected

Referenced by GetHeight().

m_initialised

bool Castor3D::Generator::m_initialised

protected

Referenced by IsInitialised().

m_iWidth

int Castor3D::Generator::m_iWidth

protected

Referenced by CreateThread(), and GetWidth().

m_pTexture

TextureUnit* Castor3D::Generator::m_pTexture

protected

m_pxColour

Castor::UbPixel Castor3D::Generator::m_pxColour

protected

Referenced by GetBlue(), GetGreen(), and GetRed().

m_uiThreadCount

uint32_t Castor3D::Generator::m_uiThreadCount

protected

m_ullStep

unsigned long long Castor3D::Generator::m_ullStep

protected

---

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

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