PR00FsUltimateRenderingEngine Class Reference

The primary and main class of the graphics engine. More...

Detailed Description

The primary and main class of the graphics engine.

Singleton, can be instantiated with static createAndGet(). This initializes the engine.

Definition at line 48 of file PR00FsUltimateRenderingEngine.h.

#include <PR00FsUltimateRenderingEngine.h>

Inheritance diagram for PR00FsUltimateRenderingEngine:

Public Member Functions
CConsole &	getConsole () const
	Returns access to console preset with logger module name as this class.
virtual TPureUInt	initialize (TPURE_RENDERER rndr, TPureUInt width, TPureUInt height, TPURE_DISPLAY_MODES dmode, TPureUInt freq, TPureInt cdepth, TPureInt zdepth, TPureInt stencil, TPureInt samples, HWND window=NULL)=0
	Initializes the engine.
virtual TPureBool	shutdown ()=0
	This stops the engine.
virtual TPureBool	isInitialized () const =0
	Gets the state of the engine.
virtual PureScreen &	getScreen () const =0
	Get access to screen manipulation functions.
virtual PureWindow &	getWindow () const =0
	Get access to window manipulation functions.
virtual PureHwInfo &	getHardwareInfo () const =0
	Get access to hardware information.
virtual PureImageManager &	getImageManager () const =0
	Get access to image handler functions.
virtual PureTextureManager &	getTextureManager () const =0
	Get access to texture handler functions.
virtual PureMaterialManager &	getMaterialManager () const =0
	Get access to material handler functions.
virtual PureMesh3DManager &	getMesh3DManager () const =0
	Get access to Mesh3D handler functions.
virtual PureObject3DManager &	getObject3DManager () const =0
	Get access to Object3D handler functions.
virtual PureCamera &	getCamera () const =0
	Get access to camera handler functions.
virtual PureUiManager &	getUImanager () const =0
	Get access to user interface functions.
virtual PureIRenderer *	getRenderer () const =0
	Get access to the selected renderer.
virtual void	WriteList () const =0
	Invoke WriteList() of all children instances.
virtual TPureBool	getAutoWriteStatsAtShutdown () const =0
	Checks if invoke of WriteStats() would happen at the beginning of shutdown().
virtual void	SetAutoWriteStatsAtShutdown (TPureBool state)=0
	Sets if invoke of WriteStats() should happen at the beginning of shutdown().
virtual void	CopyScreenToTexture (PureTexture &tex)=0
	Copies screen content to texture.

Static Public Member Functions
static PR00FsUltimateRenderingEngine &	createAndGet (PGEcfgProfiles &cfgProfiles, PGEInputHandler &inputHandler)
	Creates and gets the singleton implementation instance.
static const char *	getLoggerModuleName ()
	Returns the logger module name of this class.

Member Function Documentation

CopyScreenToTexture()

virtual void PR00FsUltimateRenderingEngine::CopyScreenToTexture ( PureTexture & tex )

pure virtual

Copies screen content to texture.

Implemented in PR00FsUltimateRenderingEngineImpl.

createAndGet()

PR00FsUltimateRenderingEngine & PR00FsUltimateRenderingEngine::createAndGet ( PGEcfgProfiles & cfgProfiles, PGEInputHandler & inputHandler )

static

Creates and gets the singleton implementation instance.

Creates and gets the singleton instance.

Definition at line 793 of file PR00FsUltimateRenderingEngine.cpp.

getAutoWriteStatsAtShutdown()

virtual TPureBool PR00FsUltimateRenderingEngine::getAutoWriteStatsAtShutdown ( ) const

pure virtual

Checks if invoke of WriteStats() would happen at the beginning of shutdown().

Implemented in PR00FsUltimateRenderingEngineImpl.

getCamera()

virtual PureCamera & PR00FsUltimateRenderingEngine::getCamera ( ) const

pure virtual

Get access to camera handler functions.

Implemented in PR00FsUltimateRenderingEngineImpl.

getConsole()

CConsole & PR00FsUltimateRenderingEngine::getConsole

(

)

const

Returns access to console preset with logger module name as this class.

Intentionally not virtual, so the getConsole() in derived class should hide this instead of overriding.

Returns

Console instance used by this class.

Definition at line 806 of file PR00FsUltimateRenderingEngine.cpp.

getHardwareInfo()

virtual PureHwInfo & PR00FsUltimateRenderingEngine::getHardwareInfo ( ) const

pure virtual

Get access to hardware information.

Implemented in PR00FsUltimateRenderingEngineImpl.

getImageManager()

virtual PureImageManager & PR00FsUltimateRenderingEngine::getImageManager ( ) const

pure virtual

Get access to image handler functions.

Implemented in PR00FsUltimateRenderingEngineImpl.

getLoggerModuleName()

const char * PR00FsUltimateRenderingEngine::getLoggerModuleName ( )

static

Returns the logger module name of this class.

Intentionally not virtual, so derived class should hide this instead of overriding. Not even private, so user can also access this from outside, for any reason like controlling log filtering per logger module name.

Returns

The logger module name of this class.

Definition at line 819 of file PR00FsUltimateRenderingEngine.cpp.

getMaterialManager()

virtual PureMaterialManager & PR00FsUltimateRenderingEngine::getMaterialManager ( ) const

pure virtual

Get access to material handler functions.

Implemented in PR00FsUltimateRenderingEngineImpl.

getMesh3DManager()

virtual PureMesh3DManager & PR00FsUltimateRenderingEngine::getMesh3DManager ( ) const

pure virtual

Get access to Mesh3D handler functions.

Implemented in PR00FsUltimateRenderingEngineImpl.

getObject3DManager()

virtual PureObject3DManager & PR00FsUltimateRenderingEngine::getObject3DManager ( ) const

pure virtual

Get access to Object3D handler functions.

Implemented in PR00FsUltimateRenderingEngineImpl.

getRenderer()

virtual PureIRenderer * PR00FsUltimateRenderingEngine::getRenderer ( ) const

pure virtual

Get access to the selected renderer.

Implemented in PR00FsUltimateRenderingEngineImpl.

getScreen()

virtual PureScreen & PR00FsUltimateRenderingEngine::getScreen ( ) const

pure virtual

Get access to screen manipulation functions.

Implemented in PR00FsUltimateRenderingEngineImpl.

getTextureManager()

virtual PureTextureManager & PR00FsUltimateRenderingEngine::getTextureManager ( ) const

pure virtual

Get access to texture handler functions.

Implemented in PR00FsUltimateRenderingEngineImpl.

getUImanager()

virtual PureUiManager & PR00FsUltimateRenderingEngine::getUImanager ( ) const

pure virtual

Get access to user interface functions.

Implemented in PR00FsUltimateRenderingEngineImpl.

getWindow()

virtual PureWindow & PR00FsUltimateRenderingEngine::getWindow ( ) const

pure virtual

Get access to window manipulation functions.

Implemented in PR00FsUltimateRenderingEngineImpl.

initialize()

virtual TPureUInt PR00FsUltimateRenderingEngine::initialize ( TPURE_RENDERER rndr, TPureUInt width, TPureUInt height, TPURE_DISPLAY_MODES dmode, TPureUInt freq, TPureInt cdepth, TPureInt zdepth, TPureInt stencil, TPureInt samples, HWND window = NULL )

pure virtual

Initializes the engine.

Implemented in PR00FsUltimateRenderingEngineImpl.

isInitialized()

virtual TPureBool PR00FsUltimateRenderingEngine::isInitialized ( ) const

pure virtual

Gets the state of the engine.

Implemented in PR00FsUltimateRenderingEngineImpl.

SetAutoWriteStatsAtShutdown()

virtual void PR00FsUltimateRenderingEngine::SetAutoWriteStatsAtShutdown ( TPureBool state )

pure virtual

Sets if invoke of WriteStats() should happen at the beginning of shutdown().

Implemented in PR00FsUltimateRenderingEngineImpl.

shutdown()

virtual TPureBool PR00FsUltimateRenderingEngine::shutdown ( )

pure virtual

This stops the engine.

Implemented in PR00FsUltimateRenderingEngineImpl.

WriteList()

virtual void PR00FsUltimateRenderingEngine::WriteList ( ) const

pure virtual

Invoke WriteList() of all children instances.

Implemented in PR00FsUltimateRenderingEngineImpl.

---

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

• C:/__PR00F__/___developing___/projects/PGE/PGE/PURE/include/external/PR00FsUltimateRenderingEngine.h
• C:/__PR00F__/___developing___/projects/PGE/PGE/PURE/source/PR00FsUltimateRenderingEngine.cpp