GeometryBuffer_wrapper Struct Reference

Inheritance diagram for GeometryBuffer_wrapper:

Collaboration diagram for GeometryBuffer_wrapper:

Public Member Functions
virtual void	appendGeometry (::CEGUI::Vertex const *const vbuff,::CEGUI::uint vertex_count)
virtual void	appendVertex (::CEGUI::Vertex const &vertex)
virtual void	draw () const
	Draw the geometry buffered within this GeometryBuffer object.
virtual ::CEGUI::Texture *	getActiveTexture () const
	Return a pointer to the currently active Texture object. This may return 0 if no texture is set. More...
virtual ::CEGUI::uint	getBatchCount () const
	Return the number of batches of geometry that this GeometryBuffer has split the vertices into. More...
virtual ::CEGUI::BlendMode	getBlendMode () const
	Return the blend mode that is set to be used for this GeometryBuffer. More...
::CEGUI::BlendMode	default_getBlendMode () const
virtual ::CEGUI::RenderEffect *	getRenderEffect ()
	Return the RenderEffect object that is assigned to this GeometryBuffer or 0 if none.
virtual ::CEGUI::uint	getVertexCount () const
	Return the total number of vertices currently held by this GeometryBuffer object. More...
virtual bool	isClippingActive () const
virtual void	reset ()
	Clear all buffered data and reset the GeometryBuffer to the default state.
virtual void	setActiveTexture (::CEGUI::Texture *texture)
virtual void	setBlendMode (::CEGUI::BlendMode const mode)
void	default_setBlendMode (::CEGUI::BlendMode const mode)
virtual void	setClippingActive (bool const active)
	Set whether clipping will be active for subsequently added vertices. More...
virtual void	setClippingRegion (::CEGUI::Rectf const &region)
virtual void	setPivot (::CEGUI::Vector3f const &p)
virtual void	setRenderEffect (::CEGUI::RenderEffect *effect)
virtual void	setRotation (::CEGUI::Quaternion const &r)
virtual void	setTranslation (::CEGUI::Vector3f const &v)
Public Member Functions inherited from CEGUI::GeometryBuffer
virtual	~GeometryBuffer ()
	Destructor.
virtual void	setTranslation (const Vector3f &v)=0
	Set the translation to be applied to the geometry in the buffer when it is subsequently rendered. More...
virtual void	setRotation (const Quaternion &r)=0
	Set the rotations to be applied to the geometry in the buffer when it is subsequently rendered. More...
virtual void	setPivot (const Vector3f &p)=0
	Set the pivot point to be used when applying the rotations. More...
virtual void	setClippingRegion (const Rectf &region)=0
	Set the clipping region to be used when rendering this buffer.
virtual void	appendVertex (const Vertex &vertex)=0
	Append a single vertex to the buffer. More...
virtual void	appendGeometry (const Vertex *const vbuff, uint vertex_count)=0
	Append a number of vertices from an array to the GeometryBuffer. More...
virtual void	setActiveTexture (Texture *texture)=0
	Set the active texture to be used with all subsequently added vertices. More...
virtual void	setRenderEffect (RenderEffect *effect)=0
	Set the RenderEffect to be used by this GeometryBuffer. More...
virtual void	setBlendMode (const BlendMode mode)
	Set the blend mode option to use when rendering this GeometryBuffer. More...
virtual	~GeometryBuffer ()
	Destructor.
virtual void	setTranslation (const Vector3f &v)=0
	Set the translation to be applied to the geometry in the buffer when it is subsequently rendered. More...
virtual void	setRotation (const Quaternion &r)=0
	Set the rotations to be applied to the geometry in the buffer when it is subsequently rendered. More...
virtual void	setPivot (const Vector3f &p)=0
	Set the pivot point to be used when applying the rotations. More...
virtual void	setClippingRegion (const Rectf &region)=0
	Set the clipping region to be used when rendering this buffer.
virtual void	appendVertex (const Vertex &vertex)=0
	Append a single vertex to the buffer. More...
virtual void	appendGeometry (const Vertex *const vbuff, uint vertex_count)=0
	Append a number of vertices from an array to the GeometryBuffer. More...
virtual void	setActiveTexture (Texture *texture)=0
	Set the active texture to be used with all subsequently added vertices. More...
virtual void	setRenderEffect (RenderEffect *effect)=0
	Set the RenderEffect to be used by this GeometryBuffer. More...
virtual void	setBlendMode (const BlendMode mode)
	Set the blend mode option to use when rendering this GeometryBuffer. More...

Additional Inherited Members
Protected Member Functions inherited from CEGUI::GeometryBuffer
	GeometryBuffer ()
	Constructor.
	GeometryBuffer ()
	Constructor.
Protected Attributes inherited from CEGUI::GeometryBuffer
BlendMode	d_blendMode
	The BlendMode to use when rendering this GeometryBuffer.

Member Function Documentation

virtual ::CEGUI::Texture* GeometryBuffer_wrapper::getActiveTexture ( ) const

inlinevirtual

Return a pointer to the currently active Texture object. This may return 0 if no texture is set.

Returns

Pointer the Texture object that is currently active, or 0 if texturing is not being used.

Implements CEGUI::GeometryBuffer.

virtual ::CEGUI::uint GeometryBuffer_wrapper::getBatchCount ( ) const

inlinevirtual

Return the number of batches of geometry that this GeometryBuffer has split the vertices into.

Note

How batching is done will be largely implementation specific, although it would be reasonable to expect that you will have at least one batch of geometry per texture switch.

Returns

The number of batches of geometry held by the GeometryBuffer.

Implements CEGUI::GeometryBuffer.

virtual ::CEGUI::BlendMode GeometryBuffer_wrapper::getBlendMode ( ) const

inlinevirtual

Return the blend mode that is set to be used for this GeometryBuffer.

Returns

One of the BlendMode enumerated values indicating the blending mode that will be used when rendering all geometry added to this GeometryBuffer object.

Reimplemented from CEGUI::GeometryBuffer.

References CEGUI::GeometryBuffer::getBlendMode().

virtual ::CEGUI::uint GeometryBuffer_wrapper::getVertexCount ( ) const

inlinevirtual

Return the total number of vertices currently held by this GeometryBuffer object.

Returns

The number of vertices that have been appended to this GeometryBuffer.

Implements CEGUI::GeometryBuffer.

virtual void GeometryBuffer_wrapper::setClippingActive ( bool const  active )

inlinevirtual

Set whether clipping will be active for subsequently added vertices.

Parameters

active

true if vertices added after this call should be clipped to the clipping region defined for this GeometryBuffer. false if vertices added after this call should not be clipped (other than to the edges of rendering target.

Implements CEGUI::GeometryBuffer.

References CEGUI::GeometryBuffer::appendGeometry(), CEGUI::GeometryBuffer::appendVertex(), CEGUI::GeometryBuffer::draw(), CEGUI::GeometryBuffer::getActiveTexture(), CEGUI::GeometryBuffer::getBatchCount(), CEGUI::GeometryBuffer::getBlendMode(), CEGUI::GeometryBuffer::getRenderEffect(), CEGUI::GeometryBuffer::getVertexCount(), CEGUI::GeometryBuffer::reset(), CEGUI::GeometryBuffer::setActiveTexture(), CEGUI::GeometryBuffer::setBlendMode(), CEGUI::GeometryBuffer::setClippingActive(), CEGUI::GeometryBuffer::setClippingRegion(), CEGUI::GeometryBuffer::setPivot(), CEGUI::GeometryBuffer::setRenderEffect(), CEGUI::GeometryBuffer::setRotation(), and CEGUI::GeometryBuffer::setTranslation().