Font

Data Structures
struct	_ps_font_info
	A structure that contains font information. More...
Typedefs
typedef enum _ps_charset	ps_charset
	Charset for a font.
typedef enum _ps_font_weight	ps_font_weight
	Font weight.
typedef struct _ps_font_info	ps_font_info
	A structure that contains font information.
Enumerations
enum	_ps_charset { CHARSET_ANSI, CHARSET_UNICODE }
	Charset for a font. More...
enum	_ps_font_weight { FONT_WEIGHT_REGULAR = 400, FONT_WEIGHT_MEDIUM = 500, FONT_WEIGHT_BOLD = 700, FONT_WEIGHT_HEAVY = 900 }
	Font weight. More...
Functions
PEXPORT ps_font *PICAPI	ps_font_create (const char *name, ps_charset charset, float size, int weight, ps_bool italic)
	Create a font object using the given parameters.
PEXPORT ps_font *PICAPI	ps_font_create_copy (const ps_font *font)
	Create a copy from an existing font object.
PEXPORT ps_font *PICAPI	ps_font_ref (ps_font *font)
	Increases the reference count of the font by 1.
PEXPORT void PICAPI	ps_font_unref (ps_font *font)
	Decrements the reference count for the font object. If the reference count on the font falls to 0, the font is freed.
PEXPORT void PICAPI	ps_font_set_size (ps_font *font, float size)
	Set size for a font object.
PEXPORT void PICAPI	ps_font_set_weight (ps_font *font, int weight)
	Set weight for a font object.
PEXPORT void PICAPI	ps_font_set_italic (ps_font *font, ps_bool italic)
	Set italic for a font object.
PEXPORT void PICAPI	ps_font_set_charset (ps_font *font, ps_charset charset)
	Set charset for a font object.
PEXPORT void PICAPI	ps_font_set_hint (ps_font *font, ps_bool hint)
	Set hiting for a font object.
PEXPORT void PICAPI	ps_font_set_flip (ps_font *font, ps_bool flip)
	Set flip for a font object.
PEXPORT ps_bool PICAPI	ps_get_font_info (ps_context *ctx, ps_font_info *info)
	Return the font information from the graphics context.
PEXPORT ps_font *PICAPI	ps_set_font (ps_context *ctx, const ps_font *font)
	Set a new font to graphics context.

---

Enumeration Type Documentation

enum _ps_charset

Charset for a font.

Enumerator:

CHARSET_ANSI	Ansi ISO-8859-x charset
CHARSET_UNICODE	Unicode UCS-2 charset

Definition at line 1939 of file picasso.h.

enum _ps_font_weight

Font weight.

Enumerator:

FONT_WEIGHT_REGULAR	Regular weight.
FONT_WEIGHT_MEDIUM	Medium weight.
FONT_WEIGHT_BOLD	Bold weight.
FONT_WEIGHT_HEAVY	Heavy weight.

Definition at line 1953 of file picasso.h.

---

Function Documentation

ps_font * ps_font_create	(	const char *	name,
		ps_charset	charset,
		float	size,
		int	weight,
		ps_bool	italic
	)

Create a font object using the given parameters.

Parameters:

name	The font family name.
charset	The charset type.
size	The font size.
weight	The font weight.
italic	Whether or not it is italic.

Returns:

If the function succeeds, the return value is the pointer to a new font object. If the function fails, the return value is NULL.

Note:

To get extended error information, call ps_last_status.

See also:

ps_font_create_copy, ps_font_ref, ps_font_unref

ps_font * ps_font_create_copy

(

const ps_font *

font

)

Create a copy from an existing font object.

Parameters:

font	Pointer to an existing font object.

Returns:

If the function succeeds, the return value is the pointer to a new font object. If the function fails, the return value is NULL.

Note:

To get extended error information, call ps_last_status.

See also:

ps_font_create, ps_font_ref, ps_font_unref

ps_font * ps_font_ref

(

ps_font *

font

)

Increases the reference count of the font by 1.

Parameters:

font	Pointer to an existing font object.

Returns:

If the function succeeds, the return value is the pointer to the font object. If the function fails, the return value is NULL.

Note:

To get extended error information, call ps_last_status.

See also:

ps_font_create, ps_font_create_copy, ps_font_unref

void ps_font_set_charset	(	ps_font *	font,
		ps_charset	charset
	)

Set charset for a font object.

Parameters:

font	Pointer to an existing font object.
charset	Charset for the font.

See also:

ps_font_set_size, ps_font_set_weight, ps_font_set_italic, ps_font_set_hint, ps_font_set_flip

void ps_font_set_flip	(	ps_font *	font,
		ps_bool	flip
	)

Set flip for a font object.

Parameters:

font	Pointer to an existing font object.
flip	Whether or not flip y for the font. (False default)

See also:

ps_font_set_size, ps_font_set_weight, ps_font_set_italic, ps_font_set_charset, ps_font_set_hint

void ps_font_set_hint	(	ps_font *	font,
		ps_bool	hint
	)

Set hiting for a font object.

Parameters:

font	Pointer to an existing font object.
hint	Whether or not auto hiting for the font. (True default)

See also:

ps_font_set_size, ps_font_set_weight, ps_font_set_italic, ps_font_set_charset, ps_font_set_flip

void ps_font_set_italic	(	ps_font *	font,
		ps_bool	italic
	)

Set italic for a font object.

Parameters:

font	Pointer to an existing font object.
italic	Whether or not italic for the font. (False default)

See also:

ps_font_set_size, ps_font_set_weight, ps_font_set_charset, ps_font_set_hint, ps_font_set_flip

void ps_font_set_size	(	ps_font *	font,
		float	size
	)

Set size for a font object.

Parameters:

font	Pointer to an existing font object.
size	Size for the font.

See also:

ps_font_set_weight, ps_font_set_italic, ps_font_set_charset, ps_font_set_hint, ps_font_set_flip

void ps_font_set_weight	(	ps_font *	font,
		int	weight
	)

Set weight for a font object.

Parameters:

font	Pointer to an existing font object.
weight	Weight for the font.

See also:

ps_font_set_size, ps_font_set_italic, ps_font_set_charset, ps_font_set_hint, ps_font_set_flip

void ps_font_unref

(

ps_font *

font

)

Decrements the reference count for the font object. If the reference count on the font falls to 0, the font is freed.

Parameters:

font	Pointer to an existing font object.

See also:

ps_font_create, ps_font_create_copy, ps_font_ref

ps_bool ps_get_font_info	(	ps_context *	ctx,
		ps_font_info *	info
	)

Return the font information from the graphics context.

Parameters:

ctx	Pointer to an existing context object.
info	Pointer to a structure to receiving the font information.

Returns:

True if is success, otherwise False.

See also:

ps_set_font

ps_font * ps_set_font	(	ps_context *	ctx,
		const ps_font *	font
	)

Set a new font to graphics context.

Parameters:

ctx	Pointer to an existing context object.
font	The new font to be set.

Returns:

If the function succeeds, the return value is the pointer to old font object. If the function fails, the return value is NULL.

Note:

To get extended error information, call ps_last_status.

See also:

ps_get_font_info