Rocket::Core::FontEffectShadow Class Reference

#include <FontEffectShadow.h>

Inheritance diagram for Rocket::Core::FontEffectShadow:

Collaboration diagram for Rocket::Core::FontEffectShadow:


Public Member Functions
bool	Initialise (const Vector2i &offset)
virtual bool	HasUniqueTexture () const
virtual bool	GetGlyphMetrics (Vector2i &origin, Vector2i &dimensions, const FontGlyph &glyph) const

Detailed Description

A concrete font effect for rendering text shadows.

bool Rocket::Core::FontEffectShadow::Initialise ( const Vector2i & offset )

Initialise the shadow effect.

Parameters:

[in] offset The offset, in pixels, of the shadow from the original text.

bool Rocket::Core::FontEffectShadow::HasUniqueTexture ( ) const [virtual]

Returns false.

virtual bool Rocket::Core::FontEffectShadow::GetGlyphMetrics	(	Vector2i &	origin,
		Vector2i &	dimensions,
		const FontGlyph &	glyph
	)			const `[virtual]`

Repositions the glyph by the offset.

Parameters:

`[out]`	origin	The desired origin of the effect's glyph bitmap, as a pixel offset from its original origin. This defaults to (0, 0).
`[out]`	dimensions	The desired dimensions of the effect's glyph bitmap, in pixels. This defaults to the dimensions of the glyph's original bitmap.
`[in]`	glyph	The glyph the effect is being asked to size.

Returns:: False if the effect is not providing support for the glyph, true otherwise.

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