Collaboration diagram for JFont:

Typedefs
typedef struct _jfont	t_jfont
	An instance of a jgraphics font.

Enumerations
enum	t_jgraphics_font_slant { JGRAPHICS_FONT_SLANT_NORMAL , JGRAPHICS_FONT_SLANT_ITALIC }
	Enumeration of slanting options for font display. More...

enum	t_jgraphics_font_weight { JGRAPHICS_FONT_WEIGHT_NORMAL , JGRAPHICS_FONT_WEIGHT_BOLD }
	Enumeration of font weight options for font display. More...

Functions
t_jfont *	jfont_create (const char *family, t_jgraphics_font_slant slant, t_jgraphics_font_weight weight, double size)
	Create a new font object. More...

t_jfont *	jfont_create_withstylename (const char family, const char stylename, double size)
	Create a new font object using a style instead of style flags. More...

t_jfont *	jfont_reference (t_jfont *font)
	Create new reference to an existing font object. More...

void	jfont_destroy (t_jfont *font)
	Release or free a font object. More...

long	jfont_isequalto (t_jfont font, t_jfont other)
	Compare two fonts to see if they are equivalent. More...

void	jfont_set_family (t_jfont font, t_symbol family)
	Set the name of the font family (e.g. More...

t_symbol *	jfont_get_family (t_jfont *font)
	Get the name of the font family (e.g. More...

void	jfont_set_style (t_jfont font, t_symbol style)
	Set the style of a font family (e.g. More...

t_symbol *	jfont_get_style (t_jfont *font)
	Get the style of the given font (e.g. More...

void	jfont_set_slant (t_jfont *font, t_jgraphics_font_slant slant)
	Set the slant of the font. More...

t_jgraphics_font_slant	jfont_get_slant (t_jfont *font)
	Get the slant of the font. More...

void	jfont_set_weight (t_jfont *font, t_jgraphics_font_weight weight)
	Set the weight of the font. More...

t_jgraphics_font_weight	jfont_get_weight (t_jfont *font)
	Get the weight of the font. More...

void	jfont_set_font_size (t_jfont *font, double size)
	Set the size of a font object. More...

double	jfont_get_font_size (t_jfont *font)
	Get the size of a font object. More...

void	jfont_set_underline (t_jfont *font, char ul)
	Set the underlining of a font object. More...

char	jfont_get_underline (t_jfont *font)
	Get the underline state of a font object. More...

void	jfont_extents (t_jfont font, t_jgraphics_font_extents extents)
	Get extents of this font. More...

void	jfont_text_measure (t_jfont font, const char utf8, double width, double height)
	Given a font, find out how much area is required to render a string of text. More...

void	jfont_text_measuretext_wrapped (t_jfont font, const char utf8, double wrapwidth, long includewhitespace, double width, double height, long *numlines)
	Given a font, find out how much area is required to render a string of text, provided a horizontal maximum limit at which the text is wrapped. More...

void	jfont_get_em_dimensions (t_jfont font, double width, double *height)
	Given a font, find out the width and height of the 'M' character. More...

t_max_err	jfont_getfontlist (long count, t_symbol **list)
	Get a list of font names. More...

t_max_err	jfont_getfontstylenames (t_symbol fontname, long count, t_symbol ***stylenames)
	Get a list of font styles available for a given font face. More...

void	jfont_normalizefontname (t_symbol fontfacewithstyle, t_symbol fontface, t_symbol *style)
	Given a font name with style appended separate into the component parts. More...

long	jbox_get_font_weight (t_object *b)
	Get the slant box's font. More...

long	jbox_get_font_slant (t_object *b)
	Get the slant box's font. More...

const char *	systemfontname (void)
	Retrieve the name of Max's system font. More...

const char *	systemfontname_bold (void)
	Retrieve the name of Max's bold system font. More...

const char *	systemfontname_light (void)
	Retrieve the name of Max's light system font. More...

t_symbol *	systemfontsym (void)
	Retrieve the name of Max's system font as a symbol. More...

Detailed Description

Enumeration Type Documentation

◆ t_jgraphics_font_slant

enum t_jgraphics_font_slant

Enumeration of slanting options for font display.

Enumerator
JGRAPHICS_FONT_SLANT_NORMAL	Normal slanting (typically this means no slanting)
JGRAPHICS_FONT_SLANT_ITALIC	Italic slanting.

◆ t_jgraphics_font_weight

enum t_jgraphics_font_weight

Enumeration of font weight options for font display.

Enumerator
JGRAPHICS_FONT_WEIGHT_NORMAL	Normal font weight.
JGRAPHICS_FONT_WEIGHT_BOLD	Bold font weight.

Function Documentation

◆ jbox_get_font_slant()

long jbox_get_font_slant ( t_object * b )

Get the slant box's font.

Parameters

b	An object's box.

Returns: A value from the t_jgraphics_font_slant enum.

◆ jbox_get_font_weight()

long jbox_get_font_weight ( t_object * b )

Get the slant box's font.

Parameters

b	An object's box.

Returns: A value from the t_jgraphics_font_weight enum.

◆ jfont_create()

t_jfont* jfont_create	(	const char *	family,
		t_jgraphics_font_slant	slant,
		t_jgraphics_font_weight	weight,
		double	size
	)

Create a new font object.

Parameters

family	The name of the font family (e.g. Arial).
slant	The type of slant for the font.
weight	The type of weight for the font.
size	The size of the font.

Returns: The new font object. Needs to be freed via jfont_destroy() when done.

◆ jfont_create_withstylename()

t_jfont* jfont_create_withstylename	(	const char *	family,
		const char *	stylename,
		double	size
	)

Create a new font object using a style instead of style flags.

Parameters

family	The name of the font family (e.g. Arial).
stylename	The name of the font style (e.g. Narrow Bold Italic).
size	The size of the font.

Returns: The new font object. Needs to be freed via jfont_destroy() when done.

◆ jfont_destroy()

void jfont_destroy ( t_jfont * font )

Release or free a font object.

Parameters

font	The font object to release.

◆ jfont_extents()

void jfont_extents	(	t_jfont *	font,
		t_jgraphics_font_extents *	extents
	)

Get extents of this font.

Parameters

font	The font object.
extents	The font extents upon return/

◆ jfont_get_em_dimensions()

void jfont_get_em_dimensions	(	t_jfont *	font,
		double *	width,
		double *	height
	)

Given a font, find out the width and height of the 'M' character.

This is equivalent to jfont_text_measure(font, "M", width, height) but is faster.

Parameters

font	The font object.
width	The address of a variable to hold the width upon return.
height	The address of a variable to hold the height upon return.

◆ jfont_get_family()

t_symbol* jfont_get_family ( t_jfont * font )

Get the name of the font family (e.g.

Arial).

Parameters

font	The font object.

Returns: A t_symbol representing the name of the font family.

◆ jfont_get_font_size()

double jfont_get_font_size ( t_jfont * font )

Get the size of a font object.

Parameters

font	The font object.

Returns: The size of the font.

◆ jfont_get_slant()

t_jgraphics_font_slant jfont_get_slant ( t_jfont * font )

Get the slant of the font.

Parameters

font	The font object.

Returns: The current slant setting for the font.

◆ jfont_get_style()

t_symbol* jfont_get_style ( t_jfont * font )

Get the style of the given font (e.g.

Narrow Bold Italic).

Parameters

font	The font object.

Returns: A t_symbol representing the name of the font style.

◆ jfont_get_underline()

char jfont_get_underline ( t_jfont * font )

Get the underline state of a font object.

Parameters

font	The font object.

Returns: Nonzero value if the font will be underlined.

◆ jfont_get_weight()

t_jgraphics_font_weight jfont_get_weight ( t_jfont * font )

Get the weight of the font.

Parameters

font	The font object.

Returns: The current weight setting for the font.

◆ jfont_getfontlist()

t_max_err jfont_getfontlist	(	long *	count,
		t_symbol ***	list
	)

Get a list of font names.

Note, this includes each font style in each font family.

Parameters

count	The address of a variable to hold the count of font names in list upon return.
list	The address of a t_symbol** initialized to NULL. Upon return this will be set to an array of count t_symbol pointers. This array should be freed using sysmem_freeptr() when you are done with it.

Returns: A Max error code.

◆ jfont_getfontstylenames()

t_max_err jfont_getfontstylenames	(	t_symbol *	fontname,
		long *	count,
		t_symbol ***	stylenames
	)

Get a list of font styles available for a given font face.

Parameters

fontanme	A symbol with the name of the font whose styles are to be retrieved.
count	The address of a variable to hold the count of font styles in the list upon return.
list	The address of a t_symbol** initialized to NULL. Upon return this will be set to an array of count t_symbol pointers. This array should b freed using sysmem_freptr() when you are done with it.

Returns: A Max error code.

◆ jfont_isequalto()

long jfont_isequalto	(	t_jfont *	font,
		t_jfont *	other
	)

Compare two fonts to see if they are equivalent.

Parameters

font	The first font object that is being compared.
other	The second font object that is being compared.

Returns: Nonzero value if the two fonts are equivalent.

◆ jfont_normalizefontname()

void jfont_normalizefontname	(	t_symbol *	fontfacewithstyle,
		t_symbol **	fontface,
		t_symbol **	style
	)

Given a font name with style appended separate into the component parts.

(e.g. "Arial Narrow Bold Italic" -> "Arial" and "Narrow Bold Italic".

Parameters

fontfacewithstyle	The name with style appended (e.g. "Arial Narrow Bold Italic")
fontface	The address of a t_symbol*. On return is set to the name of the font (e.g. "Arial")
style	The address of a t_symbol*. On return is set to the name of the font style (e.g. "Narrow Bold Italic")

◆ jfont_reference()

t_jfont* jfont_reference ( t_jfont * font )

Create new reference to an existing font object.

Parameters

font	The font object for which to obtain a reference.

Returns: The new font object reference.

◆ jfont_set_family()

void jfont_set_family	(	t_jfont *	font,
		t_symbol *	family
	)

Set the name of the font family (e.g.

Arial).

Parameters

font	The font object.
family	A t_symbol containing the name of the desired font family.

◆ jfont_set_font_size()

void jfont_set_font_size	(	t_jfont *	font,
		double	size
	)

Set the size of a font object.

Parameters

font	The font object.
size	The new size for the font object.

◆ jfont_set_slant()

void jfont_set_slant	(	t_jfont *	font,
		t_jgraphics_font_slant	slant
	)

Set the slant of the font.

Parameters

font	The font object
slant	The desired slant.

◆ jfont_set_style()

void jfont_set_style	(	t_jfont *	font,
		t_symbol *	style
	)

Set the style of a font family (e.g.

Narrow Bold Italic).

Parameters

font	The font object.
style	The desired style.

◆ jfont_set_underline()

void jfont_set_underline	(	t_jfont *	font,
		char	ul
	)

Set the underlining of a font object.

Parameters

font	The font object.
ul	Pass true to underline, or false for no underlining.

◆ jfont_set_weight()

void jfont_set_weight	(	t_jfont *	font,
		t_jgraphics_font_weight	weight
	)

Set the weight of the font.

Parameters

font	The font object
weight	The desired weight (e.g. bold).

◆ jfont_text_measure()

void jfont_text_measure	(	t_jfont *	font,
		const char *	utf8,
		double *	width,
		double *	height
	)

Given a font, find out how much area is required to render a string of text.

Parameters

font	The font object.
utf8	The text whose rendering will be measured.
width	The address of a variable to hold the width upon return.
height	The address of a variable to hold the height upon return.

◆ jfont_text_measuretext_wrapped()

void jfont_text_measuretext_wrapped	(	t_jfont *	font,
		const char *	utf8,
		double	wrapwidth,
		long	includewhitespace,
		double *	width,
		double *	height,
		long *	numlines
	)

Given a font, find out how much area is required to render a string of text, provided a horizontal maximum limit at which the text is wrapped.

Parameters

font	The font object.
utf8	The text whose rendering will be measured.
wrapwidth	The maximum width, above which text should wrap onto a new line.
includewhitespace	If non-zero, include whitespace in the measurement.
width	The address of a variable to hold the width upon return.
height	The address of a variable to hold the height upon return.
numlines	The address of a variable to hold the number of lines of text after wrapping upon return.

◆ systemfontname()

const char* systemfontname ( void )

Retrieve the name of Max's system font.

Returns: The name of Max's system font.

◆ systemfontname_bold()

const char* systemfontname_bold ( void )

Retrieve the name of Max's bold system font.

Returns: The name of Max's bold system font.

◆ systemfontname_light()

const char* systemfontname_light ( void )

Retrieve the name of Max's light system font.

Returns: The name of Max's light system font.

◆ systemfontsym()

t_symbol* systemfontsym ( void )

Retrieve the name of Max's system font as a symbol.

Returns: The name of Max's system font.

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ t_jgraphics_font_slant

◆ t_jgraphics_font_weight

Function Documentation

◆ jbox_get_font_slant()

◆ jbox_get_font_weight()

◆ jfont_create()

◆ jfont_create_withstylename()

◆ jfont_destroy()

◆ jfont_extents()

◆ jfont_get_em_dimensions()

◆ jfont_get_family()

◆ jfont_get_font_size()

◆ jfont_get_slant()

◆ jfont_get_style()

◆ jfont_get_underline()

◆ jfont_get_weight()

◆ jfont_getfontlist()

◆ jfont_getfontstylenames()

◆ jfont_isequalto()

◆ jfont_normalizefontname()

◆ jfont_reference()

◆ jfont_set_family()

◆ jfont_set_font_size()

◆ jfont_set_slant()

◆ jfont_set_style()

◆ jfont_set_underline()

◆ jfont_set_weight()

◆ jfont_text_measure()

◆ jfont_text_measuretext_wrapped()

◆ systemfontname()

◆ systemfontname_bold()

◆ systemfontname_light()

◆ systemfontsym()