Top Description Inners Fields Constructors Methods
org.lwjgl.util.freetype

public Class TT_VertHeader

extends Struct<TT_VertHeader>
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*
A structure used to model a TrueType vertical header, the vhea table, as well as the corresponding vertical metrics table, vmtx.

Layout


struct TT_VertHeader {
    FT_Fixed Version;
    FT_Short Ascender;
    FT_Short Descender;
    FT_Short Line_Gap;
    FT_UShort advance_Height_Max;
    FT_Short min_Top_Side_Bearing;
    FT_Short min_Bottom_Side_Bearing;
    FT_Short yMax_Extent;
    FT_Short caret_Slope_Rise;
    FT_Short caret_Slope_Run;
    FT_Short caret_Offset;
    FT_Short Reserved[4];
    FT_Short metric_Data_Format;
    FT_UShort number_Of_VMetrics;
    void * long_metrics;
    void * short_metrics;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
TT_VertHeader.Buffer

An array of TT_VertHeader structs.

Field Summary

Modifier and TypeField and Description
public static final int
ADVANCE_HEIGHT_MAX

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ASCENDER

The struct member offsets.

public static final int
CARET_OFFSET

The struct member offsets.

public static final int
CARET_SLOPE_RISE

The struct member offsets.

public static final int
CARET_SLOPE_RUN

The struct member offsets.

public static final int
DESCENDER

The struct member offsets.

public static final int
LINE_GAP

The struct member offsets.

public static final int
LONG_METRICS

The struct member offsets.

public static final int
METRIC_DATA_FORMAT

The struct member offsets.

public static final int
MIN_BOTTOM_SIDE_BEARING

The struct member offsets.

public static final int
MIN_TOP_SIDE_BEARING

The struct member offsets.

public static final int
NUMBER_OF_VMETRICS

The struct member offsets.

public static final int
RESERVED

The struct member offsets.

public static final int
SHORT_METRICS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
VERSION

The struct member offsets.

public static final int
YMAX_EXTENT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
TT_VertHeader(long address, ByteBuffer container)

public
TT_VertHeader(ByteBuffer container)

Creates a TT_VertHeader instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public short
advance_Height_Max()

advance height maximum

public short

Returns:

the value of the Ascender field.
Ascender()

public short

Returns:

the value of the caret_Offset field.
caret_Offset()

public short

Returns:

the value of the caret_Slope_Rise field.
caret_Slope_Rise()

public short

Returns:

the value of the caret_Slope_Run field.
caret_Slope_Run()

protected TT_VertHeader
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static TT_VertHeader
create(long address)

Returns a new TT_VertHeader instance for the specified memory address.

public static TT_VertHeader.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a TT_VertHeader.Buffer instance at the specified memory.

public static TT_VertHeader
createSafe(long address)

Like create, but returns null if address is NULL.

public static TT_VertHeader.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public short

Returns:

the value of the Descender field.
Descender()

public short

Returns:

the value of the Line_Gap field.
Line_Gap()

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the long_metrics field.
long_metrics(int
the number of elements in the returned buffer
capacity)

public short

Returns:

the value of the metric_Data_Format field.
metric_Data_Format()

public short
min_Bottom_Side_Bearing()

minimum bottom-sb

public short
min_Top_Side_Bearing()

minimum top-sb

public static short
nadvance_Height_Max(long struct)

Unsafe version of advance_Height_Max.

public static short
nAscender(long struct)

Unsafe version of Ascender.

public static short
ncaret_Offset(long struct)

Unsafe version of caret_Offset.

public static short
ncaret_Slope_Rise(long struct)

Unsafe version of caret_Slope_Rise.

public static short
ncaret_Slope_Run(long struct)

Unsafe version of caret_Slope_Run.

public static short
nDescender(long struct)

Unsafe version of Descender.

public static short
nLine_Gap(long struct)

Unsafe version of Line_Gap.

public static ByteBuffer
nlong_metrics(long struct, int capacity)

Unsafe version of long_metrics.

public static short
nmetric_Data_Format(long struct)

Unsafe version of metric_Data_Format.

public static short
nmin_Bottom_Side_Bearing(long struct)

Unsafe version of min_Bottom_Side_Bearing.

public static short
nmin_Top_Side_Bearing(long struct)

Unsafe version of min_Top_Side_Bearing.

public static short
nnumber_Of_VMetrics(long struct)

Unsafe version of number_Of_VMetrics.

public static ShortBuffer
nReserved(long struct)

Unsafe version of Reserved.

public static short
nReserved(long struct, int index)

Unsafe version of Reserved.

public static ByteBuffer
nshort_metrics(long struct, int capacity)

Unsafe version of short_metrics.

public short

Returns:

the value of the number_Of_VMetrics field.
number_Of_VMetrics()

public static long
nVersion(long struct)

Unsafe version of Version.

public static short
nyMax_Extent(long struct)

Unsafe version of yMax_Extent.

public ShortBuffer

Returns:

a ShortBuffer view of the Reserved field.
Reserved()

public short

Returns:

the value at the specified index of the Reserved field.
Reserved(int index)

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the short_metrics field.
short_metrics(int
the number of elements in the returned buffer
capacity)

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public long

Returns:

the value of the Version field.
Version()

public short
yMax_Extent()

ymax extents

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ADVANCE_HEIGHT_MAXback to summary
public static final int ADVANCE_HEIGHT_MAX

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

ASCENDERback to summary
public static final int ASCENDER

The struct member offsets.

CARET_OFFSETback to summary
public static final int CARET_OFFSET

The struct member offsets.

CARET_SLOPE_RISEback to summary
public static final int CARET_SLOPE_RISE

The struct member offsets.

CARET_SLOPE_RUNback to summary
public static final int CARET_SLOPE_RUN

The struct member offsets.

DESCENDERback to summary
public static final int DESCENDER

The struct member offsets.

LINE_GAPback to summary
public static final int LINE_GAP

The struct member offsets.

LONG_METRICSback to summary
public static final int LONG_METRICS

The struct member offsets.

METRIC_DATA_FORMATback to summary
public static final int METRIC_DATA_FORMAT

The struct member offsets.

MIN_BOTTOM_SIDE_BEARINGback to summary
public static final int MIN_BOTTOM_SIDE_BEARING

The struct member offsets.

MIN_TOP_SIDE_BEARINGback to summary
public static final int MIN_TOP_SIDE_BEARING

The struct member offsets.

NUMBER_OF_VMETRICSback to summary
public static final int NUMBER_OF_VMETRICS

The struct member offsets.

RESERVEDback to summary
public static final int RESERVED

The struct member offsets.

SHORT_METRICSback to summary
public static final int SHORT_METRICS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

VERSIONback to summary
public static final int VERSION

The struct member offsets.

YMAX_EXTENTback to summary
public static final int YMAX_EXTENT

The struct member offsets.

Constructor Detail

TT_VertHeaderback to summary
protected TT_VertHeader(long address, ByteBuffer container)
TT_VertHeaderback to summary
public TT_VertHeader(ByteBuffer container)

Creates a TT_VertHeader instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

advance_Height_Maxback to summary
public short advance_Height_Max()

advance height maximum

Annotations
@NativeType:FT_UShort
Ascenderback to summary
public short Ascender()
Returns:short

the value of the Ascender field.

Annotations
@NativeType:FT_Short
caret_Offsetback to summary
public short caret_Offset()
Returns:short

the value of the caret_Offset field.

Annotations
@NativeType:FT_Short
caret_Slope_Riseback to summary
public short caret_Slope_Rise()
Returns:short

the value of the caret_Slope_Rise field.

Annotations
@NativeType:FT_Short
caret_Slope_Runback to summary
public short caret_Slope_Run()
Returns:short

the value of the caret_Slope_Run field.

Annotations
@NativeType:FT_Short
createback to summary
protected TT_VertHeader create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static TT_VertHeader create(long address)

Returns a new TT_VertHeader instance for the specified memory address.

createback to summary
public static TT_VertHeader.Buffer create(long address, int capacity)

Create a TT_VertHeader.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static TT_VertHeader createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static TT_VertHeader.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
Descenderback to summary
public short Descender()
Returns:short

the value of the Descender field.

Annotations
@NativeType:FT_Short
Line_Gapback to summary
public short Line_Gap()
Returns:short

the value of the Line_Gap field.

Annotations
@NativeType:FT_Short
long_metricsback to summary
public ByteBuffer long_metrics(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the long_metrics field.

Annotations
@Nullable
@NativeType:void *
metric_Data_Formatback to summary
public short metric_Data_Format()
Returns:short

the value of the metric_Data_Format field.

Annotations
@NativeType:FT_Short
min_Bottom_Side_Bearingback to summary
public short min_Bottom_Side_Bearing()

minimum bottom-sb

Annotations
@NativeType:FT_Short
min_Top_Side_Bearingback to summary
public short min_Top_Side_Bearing()

minimum top-sb

Annotations
@NativeType:FT_Short
nadvance_Height_Maxback to summary
public static short nadvance_Height_Max(long struct)

Unsafe version of advance_Height_Max.

nAscenderback to summary
public static short nAscender(long struct)

Unsafe version of Ascender.

ncaret_Offsetback to summary
public static short ncaret_Offset(long struct)

Unsafe version of caret_Offset.

ncaret_Slope_Riseback to summary
public static short ncaret_Slope_Rise(long struct)

Unsafe version of caret_Slope_Rise.

ncaret_Slope_Runback to summary
public static short ncaret_Slope_Run(long struct)

Unsafe version of caret_Slope_Run.

nDescenderback to summary
public static short nDescender(long struct)

Unsafe version of Descender.

nLine_Gapback to summary
public static short nLine_Gap(long struct)

Unsafe version of Line_Gap.

nlong_metricsback to summary
public static ByteBuffer nlong_metrics(long struct, int capacity)

Unsafe version of long_metrics.

Annotations
@Nullable
nmetric_Data_Formatback to summary
public static short nmetric_Data_Format(long struct)

Unsafe version of metric_Data_Format.

nmin_Bottom_Side_Bearingback to summary
public static short nmin_Bottom_Side_Bearing(long struct)

Unsafe version of min_Bottom_Side_Bearing.

nmin_Top_Side_Bearingback to summary
public static short nmin_Top_Side_Bearing(long struct)

Unsafe version of min_Top_Side_Bearing.

nnumber_Of_VMetricsback to summary
public static short nnumber_Of_VMetrics(long struct)

Unsafe version of number_Of_VMetrics.

nReservedback to summary
public static ShortBuffer nReserved(long struct)

Unsafe version of Reserved.

nReservedback to summary
public static short nReserved(long struct, int index)

Unsafe version of Reserved.

nshort_metricsback to summary
public static ByteBuffer nshort_metrics(long struct, int capacity)

Unsafe version of short_metrics.

Annotations
@Nullable
number_Of_VMetricsback to summary
public short number_Of_VMetrics()
Returns:short

the value of the number_Of_VMetrics field.

Annotations
@NativeType:FT_UShort
nVersionback to summary
public static long nVersion(long struct)

Unsafe version of Version.

nyMax_Extentback to summary
public static short nyMax_Extent(long struct)

Unsafe version of yMax_Extent.

Reservedback to summary
public ShortBuffer Reserved()
Returns:ShortBuffer

a ShortBuffer view of the Reserved field.

Annotations
@NativeType:FT_Short[4]
Reservedback to summary
public short Reserved(int index)
Returns:short

the value at the specified index of the Reserved field.

Annotations
@NativeType:FT_Short
short_metricsback to summary
public ByteBuffer short_metrics(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the short_metrics field.

Annotations
@Nullable
@NativeType:void *
sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
Versionback to summary
public long Version()
Returns:long

the value of the Version field.

Annotations
@NativeType:FT_Fixed
yMax_Extentback to summary
public short yMax_Extent()

ymax extents

Annotations
@NativeType:FT_Short
org.lwjgl.util.freetype back to summary

public Class TT_VertHeader.Buffer

extends StructBuffer<TT_VertHeader, TT_VertHeader.Buffer>
Class Inheritance
An array of TT_VertHeader structs.

Field Summary

Modifier and TypeField and Description
private static final TT_VertHeader
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new TT_VertHeader.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public short

Returns:

the value of the TT_VertHeader#advance_Height_Max field.
advance_Height_Max()

public short

Returns:

the value of the Ascender field.
Ascender()

public short

Returns:

the value of the caret_Offset field.
caret_Offset()

public short

Returns:

the value of the caret_Slope_Rise field.
caret_Slope_Rise()

public short

Returns:

the value of the caret_Slope_Run field.
caret_Slope_Run()

public short

Returns:

the value of the Descender field.
Descender()

protected TT_VertHeader
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public short

Returns:

the value of the Line_Gap field.
Line_Gap()

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the long_metrics field.
long_metrics(int
the number of elements in the returned buffer
capacity)

public short

Returns:

the value of the metric_Data_Format field.
metric_Data_Format()

public short

Returns:

the value of the TT_VertHeader#min_Bottom_Side_Bearing field.
min_Bottom_Side_Bearing()

public short

Returns:

the value of the TT_VertHeader#min_Top_Side_Bearing field.
min_Top_Side_Bearing()

public short

Returns:

the value of the number_Of_VMetrics field.
number_Of_VMetrics()

public ShortBuffer

Returns:

a ShortBuffer view of the Reserved field.
Reserved()

public short

Returns:

the value at the specified index of the Reserved field.
Reserved(int index)

protected TT_VertHeader.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the short_metrics field.
short_metrics(int
the number of elements in the returned buffer
capacity)

public long

Returns:

the value of the Version field.
Version()

public short

Returns:

the value of the TT_VertHeader#yMax_Extent field.
yMax_Extent()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final TT_VertHeader ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new TT_VertHeader.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by TT_VertHeader#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

advance_Height_Maxback to summary
public short advance_Height_Max()
Returns:short

the value of the TT_VertHeader#advance_Height_Max field.

Annotations
@NativeType:FT_UShort
Ascenderback to summary
public short Ascender()
Returns:short

the value of the Ascender field.

Annotations
@NativeType:FT_Short
caret_Offsetback to summary
public short caret_Offset()
Returns:short

the value of the caret_Offset field.

Annotations
@NativeType:FT_Short
caret_Slope_Riseback to summary
public short caret_Slope_Rise()
Returns:short

the value of the caret_Slope_Rise field.

Annotations
@NativeType:FT_Short
caret_Slope_Runback to summary
public short caret_Slope_Run()
Returns:short

the value of the caret_Slope_Run field.

Annotations
@NativeType:FT_Short
Descenderback to summary
public short Descender()
Returns:short

the value of the Descender field.

Annotations
@NativeType:FT_Short
getElementFactoryback to summary
protected TT_VertHeader getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
Line_Gapback to summary
public short Line_Gap()
Returns:short

the value of the Line_Gap field.

Annotations
@NativeType:FT_Short
long_metricsback to summary
public ByteBuffer long_metrics(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the long_metrics field.

Annotations
@Nullable
@NativeType:void *
metric_Data_Formatback to summary
public short metric_Data_Format()
Returns:short

the value of the metric_Data_Format field.

Annotations
@NativeType:FT_Short
min_Bottom_Side_Bearingback to summary
public short min_Bottom_Side_Bearing()
Returns:short

the value of the TT_VertHeader#min_Bottom_Side_Bearing field.

Annotations
@NativeType:FT_Short
min_Top_Side_Bearingback to summary
public short min_Top_Side_Bearing()
Returns:short

the value of the TT_VertHeader#min_Top_Side_Bearing field.

Annotations
@NativeType:FT_Short
number_Of_VMetricsback to summary
public short number_Of_VMetrics()
Returns:short

the value of the number_Of_VMetrics field.

Annotations
@NativeType:FT_UShort
Reservedback to summary
public ShortBuffer Reserved()
Returns:ShortBuffer

a ShortBuffer view of the Reserved field.

Annotations
@NativeType:FT_Short[4]
Reservedback to summary
public short Reserved(int index)
Returns:short

the value at the specified index of the Reserved field.

Annotations
@NativeType:FT_Short
selfback to summary
protected TT_VertHeader.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
short_metricsback to summary
public ByteBuffer short_metrics(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the short_metrics field.

Annotations
@Nullable
@NativeType:void *
Versionback to summary
public long Version()
Returns:long

the value of the Version field.

Annotations
@NativeType:FT_Fixed
yMax_Extentback to summary
public short yMax_Extent()
Returns:short

the value of the TT_VertHeader#yMax_Extent field.

Annotations
@NativeType:FT_Short