xl7::direct3d::fonts::TextStyle Class Reference

#include <TextStyle.h>

List of all members.

Public Types
enum	AlignX { Left = -1, Center = 0, Right = 1 }
enum	AlignY { Top = -1, Middle = 0, Bottom = 1 }
Public Member Functions
	TextStyle (void)
	~TextStyle (void)
	TextStyle (const TextStyle &rhs)
TextStyle &	operator= (const TextStyle &rhs)
AlignX	GetAlignX () const
AlignY	GetAlignY () const
const ml7::Vector2 &	GetScaling () const
float	GetLetterSpacing () const
float	GetBold () const
float	GetItalic () const
D3DCOLOR	GetColor () const
void	SetAlignX (const AlignX align_x)
void	SetAlignY (const AlignY align_y)
void	SetScaling (const ml7::Vector2 &scaling)
void	SetLetterSpacing (const float letter_spacing)
void	SetBold (const float bold)
void	SetItalic (const float italic)
void	SetColor (const D3DCOLOR color)

---

Detailed Description

Holds information about specific styles to use to display text of a certain font.

---

Member Enumeration Documentation

enum xl7::direct3d::fonts::TextStyle::AlignX

Enumerator:

Left
Center
Right

enum xl7::direct3d::fonts::TextStyle::AlignY

Enumerator:

Top
Middle
Bottom

---

Constructor & Destructor Documentation

xl7::direct3d::fonts::TextStyle::TextStyle

(

void

)

Default constructor.

xl7::direct3d::fonts::TextStyle::~TextStyle

(

void

)

[inline]

Destructor.

xl7::direct3d::fonts::TextStyle::TextStyle

(

const TextStyle &

rhs

)

Copy constructor.

---

Member Function Documentation

AlignX xl7::direct3d::fonts::TextStyle::GetAlignX

(

)

const [inline]

Returns the horizontal text alignment (default is Left).

AlignY xl7::direct3d::fonts::TextStyle::GetAlignY

(

)

const [inline]

Returns the vertical text alignment (default is Top).

float xl7::direct3d::fonts::TextStyle::GetBold

(

)

const [inline]

Returns the bold amount of the text (default is 0).

D3DCOLOR xl7::direct3d::fonts::TextStyle::GetColor

(

)

const [inline]

Returns the ARGB color of the text (default is 0xffffffff).

float xl7::direct3d::fonts::TextStyle::GetItalic

(

)

const [inline]

Returns the italic amount of the text (default is 0).

float xl7::direct3d::fonts::TextStyle::GetLetterSpacing

(

)

const [inline]

Returns the amount of additional space between letters (default is 0).

const ml7::Vector2& xl7::direct3d::fonts::TextStyle::GetScaling

(

)

const [inline]

Returns the relative scaling of the text (default is 1).

TextStyle & xl7::direct3d::fonts::TextStyle::operator=

(

const TextStyle &

rhs

)

Copy assignment operator.

void xl7::direct3d::fonts::TextStyle::SetAlignX

(

const AlignX

align_x

)

[inline]

Sets the horizontal text alignment.

void xl7::direct3d::fonts::TextStyle::SetAlignY

(

const AlignY

align_y

)

[inline]

Sets the vertical text alignment.

void xl7::direct3d::fonts::TextStyle::SetBold

(

const float

bold

)

[inline]

Sets the bold amount of the text (default is 1).

void xl7::direct3d::fonts::TextStyle::SetColor

(

const D3DCOLOR

color

)

[inline]

Sets the ARGB color of the text (default is 0xffffffff).

void xl7::direct3d::fonts::TextStyle::SetItalic

(

const float

italic

)

[inline]

Sets the italic amount of the text (default is 0).

void xl7::direct3d::fonts::TextStyle::SetLetterSpacing

(

const float

letter_spacing

)

[inline]

Sets the amount of additional space between letters (default is 0).

void xl7::direct3d::fonts::TextStyle::SetScaling

(

const ml7::Vector2 &

scaling

)

[inline]

Sets the relative scaling of the text (default is 1).

---

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

• TextStyle.h
• TextStyle.cpp