A window renderer surface where we can render in. More...

Inheritance diagram for PLRenderer::SurfaceWindow:

Public Member Functions
virtual PLRENDERER_API	~SurfaceWindow ()
	Destructor.
SurfaceWindowHandler *	GetHandler () const
	Returns the renderer surface handler this surface is assigned with.
PLCore::handle	GetNativeWindowHandle () const
	Returns the native window the surface is assigned with.
bool	IsFullscreen () const
	Returns whether the window is in fullscreen mode or not.
virtual bool	GetGamma (float &fRed, float &fGreen, float &fBlue) const =0
	Gets the current gamma components.
virtual bool	SetGamma (float fRed=1.0f, float fGreen=1.0f, float fBlue=1.0f)=0
	Sets the current gamma components.
Protected Member Functions
PLRENDERER_API	SurfaceWindow (SurfaceWindowHandler &cHandler, PLCore::handle nNativeWindowHandle, bool bFullscreen=false)
	Constructor.
Protected Attributes
bool	m_bIsFullscreen

Detailed Description

A window renderer surface where we can render in.

Constructor & Destructor Documentation

virtual PLRENDERER_API PLRenderer::SurfaceWindow::~SurfaceWindow ( ) [virtual]

Destructor.

PLRENDERER_API PLRenderer::SurfaceWindow::SurfaceWindow	(	SurfaceWindowHandler &	cHandler,
		PLCore::handle	nNativeWindowHandle,
		bool	bFullscreen = `false`
	)		`[protected]`

Constructor.

Parameters:

[in]	cHandler	Renderer surface handler this surface is assigned with (MUST be valid!)
[in]	nNativeWindowHandle	Native window the surface is assigned with
[in]	bFullscreen	Fullscreen mode?

SurfaceWindowHandler * PLRenderer::SurfaceWindow::GetHandler ( ) const [inline]

Returns the renderer surface handler this surface is assigned with.

Returns:: The renderer surface handler this surface is assigned with, can be a null pointer

PLCore::handle PLRenderer::SurfaceWindow::GetNativeWindowHandle ( ) const [inline]

Returns the native window the surface is assigned with.

Returns:: The native window the surface is assigned with, can be a null pointer

bool PLRenderer::SurfaceWindow::IsFullscreen ( ) const [inline]

Returns whether the window is in fullscreen mode or not.

virtual bool PLRenderer::SurfaceWindow::GetGamma	(	float &	fRed,
		float &	fGreen,
		float &	fBlue
	)		const `[pure virtual]`

Gets the current gamma components.

Parameters:

[out]	fRed	Receives the red gamma component value
[out]	fGreen	Receives the green gamma component value
[out]	fBlue	Receives the blue gamma component value

Returns:: 'true' if all went fine, else 'false' (e.g. device does not support gamma correction)

virtual bool PLRenderer::SurfaceWindow::SetGamma	(	float	fRed = `1.0f`,
		float	fGreen = `1.0f`,
		float	fBlue = `1.0f`
	)		`[pure virtual]`

Sets the current gamma components.

Parameters:

Returns:: 'true' if all went fine, else 'false' (e.g. device does not support gamma correction)

Is this window in fullscreen mode?

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