JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.graph.font.Font.Glyph Interface Reference

Glyph for font. More...

Collaboration diagram for com.jogamp.graph.font.Font.Glyph:

Public Member Functions

Font getFont ()
 Returns the Font owning this Glyph. More...
 
char getCodepoint ()
 Returns this glyph's mapped (unicode) codepoint symbol. More...
 
int getID ()
 Returns this glyph's ID. More...
 
String getName ()
 Returns the glyph's name, source from post table. More...
 
boolean isUndefined ()
 Returns true if the Glyph denotes an undefined getID() symbol, determined as follows. More...
 
boolean isWhitespace ()
 Returns true if the Glyph denotes a whitespace, determined as follows. More...
 
boolean isNonContour ()
 Returns true if isWhitespace() or isUndefined(). More...
 
AABBox getBoundsFU ()
 Returns the AABBox in font-units, borrowing internal instance. More...
 
AABBox getBoundsFU (final AABBox dest)
 Returns the AABBox in font-units, copying into given dest. More...
 
AABBox getBounds (final AABBox dest)
 Returns the AABBox in font em-size [0..1], copying into given dest. More...
 
AABBox getBounds ()
 Returns the AABBox in font em-size [0..1], creating a new copy. More...
 
int getAdvanceWidthFU ()
 Returns advance in font units, sourced from hmtx table. More...
 
float getAdvanceWidth ()
 Returns advance in font em-size [0..1], sourced from hmtx table. More...
 
int getLeftSideBearingsFU ()
 Returns leftSideBearings in font units, sourced from hmtx table. More...
 
float getLeftSideBearings ()
 Returns leftSideBearings in font em-size [0..1], sourced from hmtx table. More...
 
boolean isKerningHorizontal ()
 True if kerning values are horizontal, otherwise vertical. More...
 
boolean isKerningCrossstream ()
 True if kerning values are perpendicular to text flow, otherwise along with flow. More...
 
int getKerningPairCount ()
 Returns the number of kerning values stored for this glyph, associated to a right hand glyph. More...
 
int getKerningFU (final int right_glyphid)
 Returns the optional kerning inter-glyph distance within words between this glyph and the given right glyph_id in font-units. More...
 
float getKerning (final int right_glyphid)
 Returns the optional kerning inter-glyph distance within words between this glyph and the given right glyph_id in fractional font em-size [0..1]. More...
 
OutlineShape getShape ()
 
int hashCode ()
 
String toString ()
 
String fullString ()
 Returns all glyph details as string. More...
 

Static Public Attributes

static final int ID_UNKNOWN = 0
 

Detailed Description

Member Function Documentation

◆ fullString()

String com.jogamp.graph.font.Font.Glyph.fullString ( )

Returns all glyph details as string.

◆ getAdvanceWidth()

float com.jogamp.graph.font.Font.Glyph.getAdvanceWidth ( )

Returns advance in font em-size [0..1], sourced from hmtx table.

◆ getAdvanceWidthFU()

int com.jogamp.graph.font.Font.Glyph.getAdvanceWidthFU ( )

Returns advance in font units, sourced from hmtx table.

◆ getBounds() [1/2]

AABBox com.jogamp.graph.font.Font.Glyph.getBounds ( )

Returns the AABBox in font em-size [0..1], creating a new copy.

◆ getBounds() [2/2]

AABBox com.jogamp.graph.font.Font.Glyph.getBounds ( final AABBox  dest)

Returns the AABBox in font em-size [0..1], copying into given dest.

Parameters
destAABBox instance set to this metrics boundary in font em-size [0..1]
Returns
the given and set AABBox 'dest' in font em-size [0..1]
Here is the caller graph for this function:

◆ getBoundsFU() [1/2]

AABBox com.jogamp.graph.font.Font.Glyph.getBoundsFU ( )

Returns the AABBox in font-units, borrowing internal instance.

◆ getBoundsFU() [2/2]

AABBox com.jogamp.graph.font.Font.Glyph.getBoundsFU ( final AABBox  dest)

Returns the AABBox in font-units, copying into given dest.

Parameters
destAABBox instance set to this metrics boundary in font-units
Returns
the given and set AABBox 'dest' in font-units

◆ getCodepoint()

char com.jogamp.graph.font.Font.Glyph.getCodepoint ( )

Returns this glyph's mapped (unicode) codepoint symbol.

Here is the caller graph for this function:

◆ getFont()

Font com.jogamp.graph.font.Font.Glyph.getFont ( )

Returns the Font owning this Glyph.

Here is the caller graph for this function:

◆ getID()

int com.jogamp.graph.font.Font.Glyph.getID ( )

Returns this glyph's ID.

◆ getKerning()

float com.jogamp.graph.font.Font.Glyph.getKerning ( final int  right_glyphid)

Returns the optional kerning inter-glyph distance within words between this glyph and the given right glyph_id in fractional font em-size [0..1].

Parameters
right_glyphidright glyph code id
Returns
fractional font em-size distance [0..1]

◆ getKerningFU()

int com.jogamp.graph.font.Font.Glyph.getKerningFU ( final int  right_glyphid)

Returns the optional kerning inter-glyph distance within words between this glyph and the given right glyph_id in font-units.

Parameters
right_glyphidright glyph code id
Returns
font-units

◆ getKerningPairCount()

int com.jogamp.graph.font.Font.Glyph.getKerningPairCount ( )

Returns the number of kerning values stored for this glyph, associated to a right hand glyph.

◆ getLeftSideBearings()

float com.jogamp.graph.font.Font.Glyph.getLeftSideBearings ( )

Returns leftSideBearings in font em-size [0..1], sourced from hmtx table.

◆ getLeftSideBearingsFU()

int com.jogamp.graph.font.Font.Glyph.getLeftSideBearingsFU ( )

Returns leftSideBearings in font units, sourced from hmtx table.

◆ getName()

String com.jogamp.graph.font.Font.Glyph.getName ( )

Returns the glyph's name, source from post table.

◆ getShape()

OutlineShape com.jogamp.graph.font.Font.Glyph.getShape ( )
Here is the caller graph for this function:

◆ hashCode()

int com.jogamp.graph.font.Font.Glyph.hashCode ( )

◆ isKerningCrossstream()

boolean com.jogamp.graph.font.Font.Glyph.isKerningCrossstream ( )

True if kerning values are perpendicular to text flow, otherwise along with flow.

◆ isKerningHorizontal()

boolean com.jogamp.graph.font.Font.Glyph.isKerningHorizontal ( )

True if kerning values are horizontal, otherwise vertical.

◆ isNonContour()

boolean com.jogamp.graph.font.Font.Glyph.isNonContour ( )

Returns true if isWhitespace() or isUndefined().

See also
isWhitespace()
isUndefined()
Here is the caller graph for this function:

◆ isUndefined()

boolean com.jogamp.graph.font.Font.Glyph.isUndefined ( )

Returns true if the Glyph denotes an undefined getID() symbol, determined as follows.

  • it's glyph index is ID_UNKNOWN, i.e. 0x00
  • has the name .notdef, NULL, null or .null

An undefined glyph has no getShape() if glyph index is not ID_UNKNOWN.

An undefined glyph has a default getBounds() and getAdvanceWidth().

Being an undefined shape excludes isWhitespace().

See also
isWhitespace()
isNonContour()

◆ isWhitespace()

boolean com.jogamp.graph.font.Font.Glyph.isWhitespace ( )

Returns true if the Glyph denotes a whitespace, determined as follows.

  • is not isUndefined()
  • has no original underlying shape
  • has an underlying shape with a zero sized area

A whitespace glyph has no getShape(), but a valid getBounds() and getAdvanceWidth().

Being a whitespace glyph excludes isUndefined().

See also
isUndefined()
isNonContour()

◆ toString()

String com.jogamp.graph.font.Font.Glyph.toString ( )
Here is the caller graph for this function:

Member Data Documentation

◆ ID_UNKNOWN

final int com.jogamp.graph.font.Font.Glyph.ID_UNKNOWN = 0
static

Definition at line 167 of file Font.java.


The documentation for this interface was generated from the following file: