NullRenderer_wrapper Struct Reference

Inheritance diagram for NullRenderer_wrapper:

Collaboration diagram for NullRenderer_wrapper:

Public Member Functions
virtual void	beginRendering ()
	Perform any operations required to put the system into a state ready for rendering operations to begin.
void	default_beginRendering ()
void	constructor_impl ()
virtual ::CEGUI::TextureTarget *	createTextureTarget ()
	Create a TextureTarget that can be used to cache imagery; this is a RenderTarget that does not lose it's content from one frame to another. More...
::CEGUI::TextureTarget *	default_createTextureTarget ()
virtual void	destroyAllGeometryBuffers ()
	Destroy all GeometryBuffer objects created by this Renderer.
void	default_destroyAllGeometryBuffers ()
virtual void	destroyAllTextureTargets ()
	Destory all TextureTarget objects created by this Renderer.
void	default_destroyAllTextureTargets ()
virtual void	destroyAllTextures ()
	Destroy all Texture objects created by this Renderer.
void	default_destroyAllTextures ()
virtual void	destroyGeometryBuffer (::CEGUI::GeometryBuffer const &buffer)
void	default_destroyGeometryBuffer (::CEGUI::GeometryBuffer const &buffer)
virtual void	destroyTexture (::CEGUI::Texture &texture)
void	default_destroyTexture (::CEGUI::Texture &texture)
virtual void	destroyTexture (::CEGUI::String const &name)
void	default_destroyTexture (::CEGUI::String const &name)
virtual void	destroyTextureTarget (::CEGUI::TextureTarget *target)
void	default_destroyTextureTarget (::CEGUI::TextureTarget *target)
virtual void	endRendering ()
	Perform any operations required to finalise rendering.
void	default_endRendering ()
virtual ::CEGUI::uint	getMaxTextureSize () const
	Return the pixel size of the maximum supported texture. More...
::CEGUI::uint	default_getMaxTextureSize () const
virtual bool	isTextureDefined (::CEGUI::String const &name) const
bool	default_isTextureDefined (::CEGUI::String const &name) const
virtual void	setDisplaySize (::CEGUI::Sizef const &sz)
void	default_setDisplaySize (::CEGUI::Sizef const &sz)
void	throwIfNameExists (::CEGUI::String const &name) const
Public Member Functions inherited from CEGUI::NullRenderer
RenderTarget &	getDefaultRenderTarget ()
	Returns the default RenderTarget object. The default render target is is typically one that targets the entire screen (or rendering window). More...
GeometryBuffer &	createGeometryBuffer ()
	Create a new GeometryBuffer and return a reference to it. You should remove the GeometryBuffer from any RenderQueues and call destroyGeometryBuffer when you want to destroy the GeometryBuffer. More...
void	destroyGeometryBuffer (const GeometryBuffer &buffer)
	Destroy a GeometryBuffer that was returned when calling the createGeometryBuffer function. Before destroying any GeometryBuffer you should ensure that it has been removed from any RenderQueue that was using it. More...
void	destroyTextureTarget (TextureTarget *target)
	Function that cleans up TextureTarget objects created with the createTextureTarget function. More...
Texture &	createTexture (const String &name)
	Create a 'null' Texture object. More...
Texture &	createTexture (const String &name, const String &filename, const String &resourceGroup)
	Create a Texture object using the given image file. More...
Texture &	createTexture (const String &name, const Sizef &size)
	Create a Texture object with the given pixel dimensions as specified by size. More...
void	destroyTexture (Texture &texture)
	Destroy a Texture object that was previously created by calling the createTexture functions. More...
void	destroyTexture (const String &name)
	Destroy a Texture object that was previously created by calling the createTexture functions. More...
Texture &	getTexture (const String &name) const
	Return a Texture object that was previously created by calling the createTexture functions. More...
bool	isTextureDefined (const String &name) const
	Return whether a texture with the given name exists.
void	setDisplaySize (const Sizef &sz)
	Set the size of the display or host window in pixels for this Renderer object. More...
const Sizef &	getDisplaySize () const
	Return the size of the display or host window in pixels. More...
const Vector2f &	getDisplayDPI () const
	Return the resolution of the display or host window in dots per inch. More...
const String &	getIdentifierString () const
	Return identification string for the renderer module. More...
RenderTarget &	getDefaultRenderTarget ()
	Returns the default RenderTarget object. The default render target is is typically one that targets the entire screen (or rendering window). More...
GeometryBuffer &	createGeometryBuffer ()
	Create a new GeometryBuffer and return a reference to it. You should remove the GeometryBuffer from any RenderQueues and call destroyGeometryBuffer when you want to destroy the GeometryBuffer. More...
void	destroyGeometryBuffer (const GeometryBuffer &buffer)
	Destroy a GeometryBuffer that was returned when calling the createGeometryBuffer function. Before destroying any GeometryBuffer you should ensure that it has been removed from any RenderQueue that was using it. More...
void	destroyAllGeometryBuffers ()
	Destroy all GeometryBuffer objects created by this Renderer.
TextureTarget *	createTextureTarget ()
	Create a TextureTarget that can be used to cache imagery; this is a RenderTarget that does not lose it's content from one frame to another. More...
void	destroyTextureTarget (TextureTarget *target)
	Function that cleans up TextureTarget objects created with the createTextureTarget function. More...
void	destroyAllTextureTargets ()
	Destory all TextureTarget objects created by this Renderer.
Texture &	createTexture (const String &name)
	Create a 'null' Texture object. More...
Texture &	createTexture (const String &name, const String &filename, const String &resourceGroup)
	Create a Texture object using the given image file. More...
Texture &	createTexture (const String &name, const Sizef &size)
	Create a Texture object with the given pixel dimensions as specified by size. More...
void	destroyTexture (Texture &texture)
	Destroy a Texture object that was previously created by calling the createTexture functions. More...
void	destroyTexture (const String &name)
	Destroy a Texture object that was previously created by calling the createTexture functions. More...
void	destroyAllTextures ()
	Destroy all Texture objects created by this Renderer.
Texture &	getTexture (const String &name) const
	Return a Texture object that was previously created by calling the createTexture functions. More...
bool	isTextureDefined (const String &name) const
	Return whether a texture with the given name exists.
void	beginRendering ()
	Perform any operations required to put the system into a state ready for rendering operations to begin.
void	endRendering ()
	Perform any operations required to finalise rendering.
void	setDisplaySize (const Sizef &sz)
	Set the size of the display or host window in pixels for this Renderer object. More...
const Sizef &	getDisplaySize () const
	Return the size of the display or host window in pixels. More...
const Vector2f &	getDisplayDPI () const
	Return the resolution of the display or host window in dots per inch. More...
uint	getMaxTextureSize () const
	Return the pixel size of the maximum supported texture. More...
const String &	getIdentifierString () const
	Return identification string for the renderer module. More...
Public Member Functions inherited from CEGUI::Renderer
virtual	~Renderer ()
	Destructor.
virtual	~Renderer ()
	Destructor.

Static Public Member Functions
static void	logTextureCreation (::CEGUI::String const &name)
static void	logTextureDestruction (::CEGUI::String const &name)
Static Public Member Functions inherited from CEGUI::NullRenderer
static NullRenderer &	bootstrapSystem (const int abi=CEGUI_VERSION_ABI)
	Convenience function that creates all the necessary objects then initialises the CEGUI system with them. More...
static void	destroySystem ()
	Convenience function to cleanup the CEGUI system and related objects that were created by calling the bootstrapSystem function. More...
static NullRenderer &	create (const int abi=CEGUI_VERSION_ABI)
	Create an NullRenderer object.
static void	destroy (NullRenderer &renderer)
	destory an NullRenderer object.
static NullRenderer &	bootstrapSystem (const int abi=CEGUI_VERSION_ABI)
	Convenience function that creates all the necessary objects then initialises the CEGUI system with them. More...
static void	destroySystem ()
	Convenience function to cleanup the CEGUI system and related objects that were created by calling the bootstrapSystem function. More...
static NullRenderer &	create (const int abi=CEGUI_VERSION_ABI)
	Create an NullRenderer object.
static void	destroy (NullRenderer &renderer)
	destory an NullRenderer object.

Additional Inherited Members
Protected Types inherited from CEGUI::NullRenderer
typedef std::vector< TextureTarget * >	TextureTargetList
	container type used to hold TextureTargets we create.
typedef std::vector< NullGeometryBuffer * >	GeometryBufferList
	container type used to hold GeometryBuffers we create.
typedef std::map< String, NullTexture *, StringFastLessCompare CEGUI_MAP_ALLOC(String, NullTexture *)>	TextureMap
	container type used to hold Textures we create.
typedef std::vector< TextureTarget * >	TextureTargetList
	container type used to hold TextureTargets we create.
typedef std::vector< NullGeometryBuffer * >	GeometryBufferList
	container type used to hold GeometryBuffers we create.
typedef std::map< String, NullTexture *, StringFastLessCompare CEGUI_MAP_ALLOC(String, NullTexture *)>	TextureMap
	container type used to hold Textures we create.
Protected Member Functions inherited from CEGUI::NullRenderer
	NullRenderer ()
	default constructor.
void	constructor_impl ()
	common construction things.
virtual	~NullRenderer ()
	destructor.
void	throwIfNameExists (const String &name) const
	helper to throw exception if name is already used.
	NullRenderer ()
	default constructor.
void	constructor_impl ()
	common construction things.
virtual	~NullRenderer ()
	destructor.
void	throwIfNameExists (const String &name) const
	helper to throw exception if name is already used.
Static Protected Member Functions inherited from CEGUI::NullRenderer
static void	logTextureCreation (const String &name)
	helper to safely log the creation of a named texture
static void	logTextureDestruction (const String &name)
	helper to safely log the destruction of a named texture
static void	logTextureCreation (const String &name)
	helper to safely log the creation of a named texture
static void	logTextureDestruction (const String &name)
	helper to safely log the destruction of a named texture
Protected Attributes inherited from CEGUI::NullRenderer
Sizef	d_displaySize
	What the renderer considers to be the current display size.
Vector2f	d_displayDPI
	What the renderer considers to be the current display DPI resolution.
RenderTarget *	d_defaultTarget
	The default RenderTarget.
TextureTargetList	d_textureTargets
	Container used to track texture targets.
GeometryBufferList	d_geometryBuffers
	Container used to track geometry buffers.
TextureMap	d_textures
	Container used to track textures.
uint	d_maxTextureSize
	What the renderer thinks the max texture size is.
Static Protected Attributes inherited from CEGUI::NullRenderer
static String	d_rendererID
	String holding the renderer identification text.

Member Function Documentation

virtual ::CEGUI::TextureTarget* NullRenderer_wrapper::createTextureTarget ( )

inlinevirtual

Create a TextureTarget that can be used to cache imagery; this is a RenderTarget that does not lose it's content from one frame to another.

If the renderer is unable to offer such a thing, 0 should be returned.

Returns

Pointer to a TextureTarget object that is suitable for caching imagery, or 0 if the renderer is unable to offer such a thing.

Reimplemented from CEGUI::NullRenderer.

References CEGUI::NullRenderer::createTextureTarget().

virtual ::CEGUI::uint NullRenderer_wrapper::getMaxTextureSize ( ) const

inlinevirtual

Return the pixel size of the maximum supported texture.

Returns

Size of the maximum supported texture in pixels.

Reimplemented from CEGUI::NullRenderer.

References CEGUI::NullRenderer::beginRendering(), CEGUI::NullRenderer::bootstrapSystem(), CEGUI::NullRenderer::create(), CEGUI::NullRenderer::createGeometryBuffer(), CEGUI::NullRenderer::createTexture(), CEGUI::NullRenderer::createTextureTarget(), CEGUI::NullRenderer::destroy(), CEGUI::NullRenderer::destroyAllGeometryBuffers(), CEGUI::NullRenderer::destroyAllTextures(), CEGUI::NullRenderer::destroyAllTextureTargets(), CEGUI::NullRenderer::destroyGeometryBuffer(), CEGUI::NullRenderer::destroySystem(), CEGUI::NullRenderer::destroyTexture(), CEGUI::NullRenderer::destroyTextureTarget(), CEGUI::NullRenderer::endRendering(), CEGUI::NullRenderer::getDefaultRenderTarget(), CEGUI::NullRenderer::getDisplayDPI(), CEGUI::NullRenderer::getDisplaySize(), CEGUI::NullRenderer::getIdentifierString(), CEGUI::NullRenderer::getMaxTextureSize(), CEGUI::NullRenderer::getTexture(), CEGUI::NullRenderer::isTextureDefined(), CEGUI::NullRenderer::logTextureCreation(), CEGUI::NullRenderer::logTextureDestruction(), CEGUI::NullRenderer::setDisplaySize(), and CEGUI::NullRenderer::throwIfNameExists().