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

public Class FT_Generic

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

Client applications often need to associate their own data to a variety of FreeType core objects. For example, a text layout API might want to associate a glyph cache to a given size object.

Layout


struct FT_Generic {
    void * data;
    FT_Generic_Finalizer finalizer;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
FT_Generic.Buffer

An array of FT_Generic structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DATA

The struct member offsets.

public static final int
FINALIZER

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
FT_Generic(long address, ByteBuffer container)

public
FT_Generic(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static FT_Generic
calloc()

Returns a new FT_Generic instance allocated with memCalloc.

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

Returns a new FT_Generic.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new FT_Generic instance allocated with BufferUtils.

public static FT_Generic
create(long address)

Returns a new FT_Generic instance for the specified memory address.

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

Returns a new FT_Generic.Buffer instance allocated with BufferUtils.

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

Create a FT_Generic.Buffer instance at the specified memory.

public static FT_Generic
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long

Returns:

the value of the data field.
data
()

public FT_Generic
data(long value)

Sets the specified value to the data field.

public FT_Generic_Finalizer

Returns:

the value of the finalizer field.
finalizer
()

public FT_Generic
finalizer(FT_Generic_FinalizerI value)

Sets the specified value to the finalizer field.

public static FT_Generic
malloc()

Returns a new FT_Generic instance allocated with memAlloc.

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

Returns a new FT_Generic.Buffer instance allocated with memAlloc.

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

Returns a new FT_Generic instance allocated on the specified MemoryStack.

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

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

public static long
ndata(long struct)

Unsafe version of data.

public static void
ndata(long struct, long value)

Unsafe version of data.

public static FT_Generic_Finalizer
nfinalizer(long struct)

Unsafe version of finalizer.

public static void
nfinalizer(long struct, FT_Generic_FinalizerI value)

Unsafe version of finalizer.

public FT_Generic
set(long data, FT_Generic_FinalizerI finalizer)

Initializes this struct with the specified values.

public FT_Generic

Returns:

this struct
set
(FT_Generic
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).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

DATAback to summary
public static final int DATA

The struct member offsets.

FINALIZERback to summary
public static final int FINALIZER

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

FT_Genericback to summary
protected FT_Generic(long address, ByteBuffer container)
FT_Genericback to summary
public FT_Generic(ByteBuffer container)

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

callocback to summary
public static FT_Generic calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static FT_Generic calloc(MemoryStack stack)

Returns a new FT_Generic 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 FT_Generic.Buffer calloc(int capacity, MemoryStack stack)

Returns a new FT_Generic.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 FT_Generic 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 FT_Generic create()

Returns a new FT_Generic instance allocated with BufferUtils.

createback to summary
public static FT_Generic create(long address)

Returns a new FT_Generic instance for the specified memory address.

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

Returns a new FT_Generic.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a FT_Generic.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FT_Generic createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
databack to summary
public long data()
Returns:long

the value of the data field.

Annotations
@NativeType:void *
databack to summary
public FT_Generic data(long value)

Sets the specified value to the data field.

finalizerback to summary
public FT_Generic_Finalizer finalizer()
Returns:FT_Generic_Finalizer

the value of the finalizer field.

finalizerback to summary
public FT_Generic finalizer(FT_Generic_FinalizerI value)

Sets the specified value to the finalizer field.

mallocback to summary
public static FT_Generic malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static FT_Generic malloc(MemoryStack stack)

Returns a new FT_Generic instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndataback to summary
public static long ndata(long struct)

Unsafe version of data.

ndataback to summary
public static void ndata(long struct, long value)

Unsafe version of data.

nfinalizerback to summary
public static FT_Generic_Finalizer nfinalizer(long struct)

Unsafe version of finalizer.

nfinalizerback to summary
public static void nfinalizer(long struct, FT_Generic_FinalizerI value)

Unsafe version of finalizer.

setback to summary
public FT_Generic set(long data, FT_Generic_FinalizerI finalizer)

Initializes this struct with the specified values.

setback to summary
public FT_Generic set(FT_Generic src)

Copies the specified struct data to this struct.

Parameters
src:FT_Generic

the source struct

Returns:FT_Generic

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
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.util.freetype back to summary

public Class FT_Generic.Buffer

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

An array of FT_Generic structs.

Field Summary

Modifier and TypeField and Description
private static final FT_Generic

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new FT_Generic.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 long

Returns:

the value of the data field.
data
()

public FT_Generic.Buffer
data(long value)

Sets the specified value to the data field.

public FT_Generic_Finalizer

Returns:

the value of the finalizer field.
finalizer
()

public FT_Generic.Buffer
finalizer(FT_Generic_FinalizerI value)

Sets the specified value to the finalizer field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final FT_Generic ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

databack to summary
public long data()
Returns:long

the value of the data field.

Annotations
@NativeType:void *
databack to summary
public FT_Generic.Buffer data(long value)

Sets the specified value to the data field.

finalizerback to summary
public FT_Generic_Finalizer finalizer()
Returns:FT_Generic_Finalizer

the value of the finalizer field.

finalizerback to summary
public FT_Generic.Buffer finalizer(FT_Generic_FinalizerI value)

Sets the specified value to the finalizer field.

getElementFactoryback to summary
protected FT_Generic getElementFactory()

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

Annotations
@Override
selfback to summary
protected FT_Generic.Buffer self()

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

Annotations
@Override