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

public Class hb_font_extents_t

extends Struct<hb_font_extents_t>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Font-wide extent values, measured in font units.

Note that typically ascender is positive and descender negative, in coordinate systems that grow up.

Layout


struct hb_font_extents_t {
    hb_position_t ascender;
    hb_position_t descender;
    hb_position_t line_gap;
    hb_position_t reserved9;
    hb_position_t reserved8;
    hb_position_t reserved7;
    hb_position_t reserved6;
    hb_position_t reserved5;
    hb_position_t reserved4;
    hb_position_t reserved3;
    hb_position_t reserved2;
    hb_position_t reserved1;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ASCENDER

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
RESERVED1

The struct member offsets.

public static final int
RESERVED2

The struct member offsets.

public static final int
RESERVED3

The struct member offsets.

public static final int
RESERVED4

The struct member offsets.

public static final int
RESERVED5

The struct member offsets.

public static final int
RESERVED6

The struct member offsets.

public static final int
RESERVED7

The struct member offsets.

public static final int
RESERVED8

The struct member offsets.

public static final int
RESERVED9

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
hb_font_extents_t(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
ascender()

the height of typographic ascenders

public hb_font_extents_t
ascender(int value)

Sets the specified value to the ascender field.

public static hb_font_extents_t
calloc()

Returns a new hb_font_extents_t instance allocated with memCalloc.

public static hb_font_extents_t.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new hb_font_extents_t.Buffer instance allocated with memCalloc.

public static hb_font_extents_t
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new hb_font_extents_t instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static hb_font_extents_t.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new hb_font_extents_t.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected hb_font_extents_t
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 hb_font_extents_t
create()

Returns a new hb_font_extents_t instance allocated with BufferUtils.

public static hb_font_extents_t
create(long address)

Returns a new hb_font_extents_t instance for the specified memory address.

public static hb_font_extents_t.Buffer
create(int
the buffer capacity
capacity
)

Returns a new hb_font_extents_t.Buffer instance allocated with BufferUtils.

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

Create a hb_font_extents_t.Buffer instance at the specified memory.

public static hb_font_extents_t
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
descender()

the depth of typographic descenders

public hb_font_extents_t
descender(int value)

Sets the specified value to the descender field.

public int
line_gap()

the suggested line-spacing gap

public hb_font_extents_t
line_gap(int value)

Sets the specified value to the line_gap field.

public static hb_font_extents_t
malloc()

Returns a new hb_font_extents_t instance allocated with memAlloc.

public static hb_font_extents_t.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new hb_font_extents_t.Buffer instance allocated with memAlloc.

public static hb_font_extents_t
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new hb_font_extents_t instance allocated on the specified MemoryStack.

public static hb_font_extents_t.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new hb_font_extents_t.Buffer instance allocated on the specified MemoryStack.

public static int
nascender(long struct)

Unsafe version of ascender.

public static void
nascender(long struct, int value)

Unsafe version of ascender.

public static int
ndescender(long struct)

Unsafe version of descender.

public static void
ndescender(long struct, int value)

Unsafe version of descender.

public static int
nline_gap(long struct)

Unsafe version of line_gap.

public static void
nline_gap(long struct, int value)

Unsafe version of line_gap.

public static int
nreserved1(long struct)

public static void
nreserved1(long struct, int value)

public static int
nreserved2(long struct)

public static void
nreserved2(long struct, int value)

public static int
nreserved3(long struct)

public static void
nreserved3(long struct, int value)

public static int
nreserved4(long struct)

public static void
nreserved4(long struct, int value)

public static int
nreserved5(long struct)

public static void
nreserved5(long struct, int value)

public static int
nreserved6(long struct)

public static void
nreserved6(long struct, int value)

public static int
nreserved7(long struct)

public static void
nreserved7(long struct, int value)

public static int
nreserved8(long struct)

public static void
nreserved8(long struct, int value)

public static int
nreserved9(long struct)

public static void
nreserved9(long struct, int value)

public hb_font_extents_t
set(int ascender, int descender, int line_gap)

Initializes this struct with the specified values.

public hb_font_extents_t

Returns:

this struct
set
(hb_font_extents_t
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
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

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.

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.

RESERVED1back to summary
public static final int RESERVED1

The struct member offsets.

RESERVED2back to summary
public static final int RESERVED2

The struct member offsets.

RESERVED3back to summary
public static final int RESERVED3

The struct member offsets.

RESERVED4back to summary
public static final int RESERVED4

The struct member offsets.

RESERVED5back to summary
public static final int RESERVED5

The struct member offsets.

RESERVED6back to summary
public static final int RESERVED6

The struct member offsets.

RESERVED7back to summary
public static final int RESERVED7

The struct member offsets.

RESERVED8back to summary
public static final int RESERVED8

The struct member offsets.

RESERVED9back to summary
public static final int RESERVED9

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

hb_font_extents_tback to summary
protected hb_font_extents_t(long address, ByteBuffer container)
hb_font_extents_tback to summary
public hb_font_extents_t(ByteBuffer container)

Creates a hb_font_extents_t 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

ascenderback to summary
public int ascender()

the height of typographic ascenders

Annotations
@NativeType:hb_position_t
ascenderback to summary
public hb_font_extents_t ascender(int value)

Sets the specified value to the ascender field.

callocback to summary
public static hb_font_extents_t calloc()

Returns a new hb_font_extents_t instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static hb_font_extents_t.Buffer calloc(int capacity)

Returns a new hb_font_extents_t.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static hb_font_extents_t calloc(MemoryStack stack)

Returns a new hb_font_extents_t instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static hb_font_extents_t.Buffer calloc(int capacity, MemoryStack stack)

Returns a new hb_font_extents_t.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected hb_font_extents_t 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 hb_font_extents_t create()

Returns a new hb_font_extents_t instance allocated with BufferUtils.

createback to summary
public static hb_font_extents_t create(long address)

Returns a new hb_font_extents_t instance for the specified memory address.

createback to summary
public static hb_font_extents_t.Buffer create(int capacity)

Returns a new hb_font_extents_t.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a hb_font_extents_t.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static hb_font_extents_t createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
descenderback to summary
public int descender()

the depth of typographic descenders

Annotations
@NativeType:hb_position_t
descenderback to summary
public hb_font_extents_t descender(int value)

Sets the specified value to the descender field.

line_gapback to summary
public int line_gap()

the suggested line-spacing gap

Annotations
@NativeType:hb_position_t
line_gapback to summary
public hb_font_extents_t line_gap(int value)

Sets the specified value to the line_gap field.

mallocback to summary
public static hb_font_extents_t malloc()

Returns a new hb_font_extents_t instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static hb_font_extents_t.Buffer malloc(int capacity)

Returns a new hb_font_extents_t.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static hb_font_extents_t malloc(MemoryStack stack)

Returns a new hb_font_extents_t instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static hb_font_extents_t.Buffer malloc(int capacity, MemoryStack stack)

Returns a new hb_font_extents_t.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nascenderback to summary
public static int nascender(long struct)

Unsafe version of ascender.

nascenderback to summary
public static void nascender(long struct, int value)

Unsafe version of ascender.

ndescenderback to summary
public static int ndescender(long struct)

Unsafe version of descender.

ndescenderback to summary
public static void ndescender(long struct, int value)

Unsafe version of descender.

nline_gapback to summary
public static int nline_gap(long struct)

Unsafe version of line_gap.

nline_gapback to summary
public static void nline_gap(long struct, int value)

Unsafe version of line_gap.

nreserved1back to summary
public static int nreserved1(long struct)
nreserved1back to summary
public static void nreserved1(long struct, int value)
nreserved2back to summary
public static int nreserved2(long struct)
nreserved2back to summary
public static void nreserved2(long struct, int value)
nreserved3back to summary
public static int nreserved3(long struct)
nreserved3back to summary
public static void nreserved3(long struct, int value)
nreserved4back to summary
public static int nreserved4(long struct)
nreserved4back to summary
public static void nreserved4(long struct, int value)
nreserved5back to summary
public static int nreserved5(long struct)
nreserved5back to summary
public static void nreserved5(long struct, int value)
nreserved6back to summary
public static int nreserved6(long struct)
nreserved6back to summary
public static void nreserved6(long struct, int value)
nreserved7back to summary
public static int nreserved7(long struct)
nreserved7back to summary
public static void nreserved7(long struct, int value)
nreserved8back to summary
public static int nreserved8(long struct)
nreserved8back to summary
public static void nreserved8(long struct, int value)
nreserved9back to summary
public static int nreserved9(long struct)
nreserved9back to summary
public static void nreserved9(long struct, int value)
setback to summary
public hb_font_extents_t set(int ascender, int descender, int line_gap)

Initializes this struct with the specified values.

setback to summary
public hb_font_extents_t set(hb_font_extents_t src)

Copies the specified struct data to this struct.

Parameters
src:hb_font_extents_t

the source struct

Returns:hb_font_extents_t

this struct

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
org.lwjgl.util.harfbuzz back to summary

public Class hb_font_extents_t.Buffer

extends StructBuffer<hb_font_extents_t, hb_font_extents_t.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of hb_font_extents_t structs.

Field Summary

Modifier and TypeField and Description
private static final hb_font_extents_t

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new hb_font_extents_t.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 int

Returns:

the value of the hb_font_extents_t#ascender field.
ascender
()

public hb_font_extents_t.Buffer
ascender(int value)

Sets the specified value to the hb_font_extents_t#ascender field.

public int

Returns:

the value of the hb_font_extents_t#descender field.
descender
()

public hb_font_extents_t.Buffer
descender(int value)

Sets the specified value to the hb_font_extents_t#descender field.

protected hb_font_extents_t
public int

Returns:

the value of the hb_font_extents_t#line_gap field.
line_gap
()

public hb_font_extents_t.Buffer
line_gap(int value)

Sets the specified value to the hb_font_extents_t#line_gap field.

protected hb_font_extents_t.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final hb_font_extents_t ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new hb_font_extents_t.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 hb_font_extents_t#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

ascenderback to summary
public int ascender()
Returns:int

the value of the hb_font_extents_t#ascender field.

Annotations
@NativeType:hb_position_t
ascenderback to summary
public hb_font_extents_t.Buffer ascender(int value)

Sets the specified value to the hb_font_extents_t#ascender field.

descenderback to summary
public int descender()
Returns:int

the value of the hb_font_extents_t#descender field.

Annotations
@NativeType:hb_position_t
descenderback to summary
public hb_font_extents_t.Buffer descender(int value)

Sets the specified value to the hb_font_extents_t#descender field.

getElementFactoryback to summary
protected hb_font_extents_t getElementFactory()

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

Annotations
@Override
line_gapback to summary
public int line_gap()
Returns:int

the value of the hb_font_extents_t#line_gap field.

Annotations
@NativeType:hb_position_t
line_gapback to summary
public hb_font_extents_t.Buffer line_gap(int value)

Sets the specified value to the hb_font_extents_t#line_gap field.

selfback to summary
protected hb_font_extents_t.Buffer self()

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

Annotations
@Override