A 2D font is a font rendered onto a planar image (whatever the format), as opposed to a 3D model of the glyphs or other graphical representation.
Note, for this implementation, the loadGlyphs() and unloadGlyphs() functions will only work if called on the render thread by the process with the OpenGL context. These two methods are also not needed by Lumin clients, which can create font resources within their prisms; see Prism::createFont2dResource.
Get the advance direction.
The ascender is the vertical distance from the horizontal baseline to the highest glyph coordinate.
Gets the base path of the resource.
The descender is the vertical distance from the horizontal baseline to the lowest glyph coordinate, which is negative if any glyphs extend below the baseline (usually they do).
Gets the FileName Associated with this resource.
Get the text-flow direction.
Get the font family; e.g., "Liberation Mono".
Get the size of the font; the units are not specified by the interface.
Get the font style; e.g., "Italic".
Get the global glyph height for the font.
Formally, this is the difference between the ascender and descender, which is what getGlyphHeight() returns.
Get the glyph quality of the font resource specified in the Font2dDesc when the font resource was created.
Get the space between lines of text written with this font.
This is a value provided by the font designer to indicate how much space should separate lines of text written with the font relative to the size of a tile (which is 1 in glyph space).
Return a int that contains the result of loading this resource.
int with the result value.
Get the list of character codes for which glyphs have been loaded.
Get the minimum value of text fragments to render; see Font2dDesc.
Returns the Unique ID of this resource
Get the type of shader to use for rendering this resource.
kMAX only if an error occurred; shader type otherwise.
Get the IDs of all 2D texture arrays containing the glyphs of the font.
After the server has loaded the font resource, this will return the dimensions of the texture with the given ID.
the (height, width, depth) of the texture with the given ID, or else (0, 0, 0) if the textureID equals 0 or is not known.
Get the information for rendering a particular character.
Information about the glyph representing the given character, which will equal NONE if no such character has been loaded.
Get the size of the tiles for the glyphs managed by this resource.
Check if content is protected
true if protected
Returns True if the Resource was successfully loaded
Loading only happens on the server-side so this call is only useful to the server
TRUE = Successfully loaded
Protected/Copyrighted content, do not share with other clients
true if protected
Generated using TypeDoc