TextureFont.API

Class: TextureFont

TextureFont

new TextureFont(arraybuffer, textureUnit)

A glyphmap representation of a font.

Parameters:

Name	Type	Argument	Description
arraybuffer	ArrayBuffer		The font data
textureUnit	Number	<optional>	The target texture unit

Source:

• gl/TextureFont.js , lineno 84

Methods

<static> getSupportedCharsDefault() → {String}

Return the default renderable chracters.

Source:

• gl/TextureFont.js , lineno 179

Returns:

Type

String

deleteGlTexture()

Delete the glyphmap texture.

Source:

• gl/TextureFont.js , lineno 960

drawText(str, color)

Draw a string on the xy-plane.

Parameters:

Name	Type	Argument	Default	Description
str	String			The string
color	Color	<optional>	Color.white()	The color send to the shader.

Source:

• gl/TextureFont.js , lineno 848

drawTextBox(str, size, color)

Draw a size constrained string on the xy-plane.

Parameters:

Name	Type	Argument	Default	Description
str	String			The string
size	Vec2			The size of the bounding box
color	Color	<optional>	Color.white()	The color send to the shader

Source:

• gl/TextureFont.js , lineno 864

getCharsSupported() → {String}

Return the currently renderable characters.

Source:

• gl/TextureFont.js , lineno 170

Returns:

Type

String

getFontSize() → {Number}

Return the current fontsize;

Source:

• gl/TextureFont.js , lineno 214

Returns:

Type

Number

getGlyphTableGLTexture() → {WebGLTexture}

Return the glyphmap texture.

Source:

• gl/TextureFont.js , lineno 969

Returns:

Type

WebGLTexture

getGlyphTableGLTextureSize(v) → {Vec2}

Return the current glyphmap texture size.

Parameters:

Name	Type	Argument	Description
v	Vec2	<optional>	Out size

Source:

• gl/TextureFont.js , lineno 979

Returns:

Type

Vec2

getLineHeight() → {Number}

Return the current line height.

Source:

• gl/TextureFont.js , lineno 232

Returns:

Type

Number

getTextBounds(str, rect) → {Rect}

Return the bounding box of a string

Parameters:

Name	Type	Description
str	String	The string
rect	Rect	Out rect

Source:

• gl/TextureFont.js , lineno 921

Returns:

Type

Rect

getTextWidth(str) → {Number}

Return the width of a string.

Parameters:

Name	Type	Description
str	String	The string

Source:

• gl/TextureFont.js , lineno 947

Returns:

Type

Number

setCharsSupported(chars)

Set the renderable characters.

Parameters:

Name	Type	Description
chars	String	The characters

Source:

• gl/TextureFont.js , lineno 160

setFontSize(fontSize)

Set the fontsize.

Parameters:

Name	Type	Description
fontSize	Number	The size

Source:

• gl/TextureFont.js , lineno 204

setLineHeight(lineHeight)

Set the line height.

Parameters:

Name	Type	Description
lineHeight	Number	The height

Source:

• gl/TextureFont.js , lineno 223

Generated with wicked.