Modifier and Type	Class and Description
public static class	FFIType.Buffer An array of `FFIType` structs.

Modifier and Type	Field and Description
public static final int	ALIGNMENT The struct member offsets.
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	ELEMENTS The struct member offsets.
public static final int	SIZE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	TYPE The struct member offsets.

Access	Constructor and Description
protected	FFIType(long address, ByteBuffer container)
public	FFIType(ByteBuffer container) Creates a `FFIType` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public short	alignment() set by libffi; you should initialize it to zero.
public FFIType	alignment(short value) Sets the specified value to the `alignment` field.
public static FFIType	calloc() Returns a new `FFIType` instance allocated with `memCalloc`.
public static FFIType.Buffer	calloc(int the buffer capacity capacity) Returns a new `FFIType.Buffer` instance allocated with `memCalloc`.
public static FFIType	calloc(MemoryStack the stack from which to allocate stack) Returns a new `FFIType` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static FFIType.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `FFIType.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected FFIType	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 FFIType	create() Returns a new `FFIType` instance allocated with `BufferUtils`.
public static FFIType	create(long address) Returns a new `FFIType` instance for the specified memory address.
public static FFIType.Buffer	create(int the buffer capacity capacity) Returns a new `FFIType.Buffer` instance allocated with `BufferUtils`.
public static FFIType.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `FFIType.Buffer` instance at the specified memory.
public static FFIType	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static FFIType.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public PointerBuffer	Returns: a null-terminated array of pointers to `ffi_type` objects. There is one element per field of the struct. elements(int the number of elements in the returned buffer capacity)
public FFIType	elements(PointerBuffer value) Sets the address of the specified `PointerBuffer` to the `elements` field.
public static FFIType	malloc() Returns a new `FFIType` instance allocated with `memAlloc`.
public static FFIType.Buffer	malloc(int the buffer capacity capacity) Returns a new `FFIType.Buffer` instance allocated with `memAlloc`.
public static FFIType	malloc(MemoryStack the stack from which to allocate stack) Returns a new `FFIType` instance allocated on the specified `MemoryStack`.
public static FFIType.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `FFIType.Buffer` instance allocated on the specified `MemoryStack`.
public static short	nalignment(long struct) Unsafe version of `alignment`.
public static void	nalignment(long struct, short value) Unsafe version of `alignment`.
public static PointerBuffer	nelements(long struct, int capacity) Unsafe version of `elements`.
public static void	nelements(long struct, PointerBuffer value) Unsafe version of `elements`.
public static long	nsize(long struct) Unsafe version of `size`.
public static void	nsize(long struct, long value) Unsafe version of `size`.
public static short	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, short value) Unsafe version of `type`.
public FFIType	set(long size, short alignment, short type, PointerBuffer elements) Initializes this struct with the specified values.
public FFIType	Returns: this struct set(FFIType the source struct src) Copies the specified struct data to this struct.
public long	size() set by libffi; you should initialize it to zero.
public FFIType	size(long value) Sets the specified value to the `size` field.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public short	type() for a structure, this should be set to `TYPE_STRUCT`.
public FFIType	type(short value) Sets the specified value to the `type` field.

Field Detail

ALIGNMENT	back to summary
public static final int ALIGNMENT The struct member offsets.

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

ELEMENTS	back to summary
public static final int ELEMENTS The struct member offsets.

SIZE	back to summary
public static final int SIZE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

TYPE	back to summary
public static final int TYPE The struct member offsets.

Constructor Detail

FFIType	back to summary
protected FFIType(long address, ByteBuffer container)

FFIType back to summary

FFIType	back to summary
public FFIType(ByteBuffer container) Creates a `FFIType` 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.

public FFIType(ByteBuffer container)

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

alignment	back to summary
public short alignment() set by libffi; you should initialize it to zero. Annotations @NativeType:unsigned short

alignment

back to summary

public short alignment()

set by libffi; you should initialize it to zero.

Annotations

@NativeType:unsigned short

alignment	back to summary
public FFIType alignment(short value) Sets the specified value to the `alignment` field.

calloc	back to summary
public static FFIType calloc() Returns a new `FFIType` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static FFIType.Buffer calloc(int capacity) Returns a new `FFIType.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static FFIType.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static FFIType calloc(MemoryStack stack) Returns a new `FFIType` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static FFIType calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static FFIType.Buffer calloc(int capacity, MemoryStack stack) Returns a new `FFIType.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

public static FFIType.Buffer calloc(int capacity, MemoryStack stack)

Returns a new FFIType.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

create back to summary

create	back to summary
protected FFIType 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

protected FFIType 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

create	back to summary
public static FFIType create() Returns a new `FFIType` instance allocated with `BufferUtils`.

create	back to summary
public static FFIType create(long address) Returns a new `FFIType` instance for the specified memory address.

create back to summary

create	back to summary
public static FFIType.Buffer create(int capacity) Returns a new `FFIType.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static FFIType.Buffer create(int capacity)

Returns a new FFIType.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static FFIType.Buffer create(long address, int capacity) Create a `FFIType.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static FFIType.Buffer create(long address, int capacity)

Create a FFIType.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static FFIType createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static FFIType createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static FFIType.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

elements	back to summary
public PointerBuffer elements(int capacity) Parameters capacity:int the number of elements in the returned buffer Returns:PointerBuffer a null-terminated array of pointers to `ffi_type` objects. There is one element per field of the struct. Annotations @Nullable @NativeType:ffi_type *

elements	back to summary
public FFIType elements(PointerBuffer value) Sets the address of the specified `PointerBuffer` to the `elements` field.

malloc	back to summary
public static FFIType malloc() Returns a new `FFIType` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static FFIType.Buffer malloc(int capacity) Returns a new `FFIType.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static FFIType.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static FFIType malloc(MemoryStack stack) Returns a new `FFIType` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static FFIType malloc(MemoryStack stack)

Returns a new FFIType instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static FFIType.Buffer malloc(int capacity, MemoryStack stack) Returns a new `FFIType.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static FFIType.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

nalignment	back to summary
public static short nalignment(long struct) Unsafe version of `alignment`.

nalignment	back to summary
public static void nalignment(long struct, short value) Unsafe version of `alignment`.

nelements back to summary

nelements	back to summary
public static PointerBuffer nelements(long struct, int capacity) Unsafe version of `elements`. Annotations @Nullable

public static PointerBuffer nelements(long struct, int capacity)

Unsafe version of elements.

Annotations

@Nullable

nelements	back to summary
public static void nelements(long struct, PointerBuffer value) Unsafe version of `elements`.

nsize	back to summary
public static long nsize(long struct) Unsafe version of `size`.

nsize	back to summary
public static void nsize(long struct, long value) Unsafe version of `size`.

ntype	back to summary
public static short ntype(long struct) Unsafe version of `type`.

ntype	back to summary
public static void ntype(long struct, short value) Unsafe version of `type`.

set	back to summary
public FFIType set(long size, short alignment, short type, PointerBuffer elements) Initializes this struct with the specified values.

set	back to summary
public FFIType set(FFIType src) Copies the specified struct data to this struct. Parameters src:FFIType the source struct Returns:FFIType this struct

set

back to summary

public FFIType set(FFIType src)

Copies the specified struct data to this struct.

Parameters

src:FFIType: the source struct

Returns:FFIType

this struct

size	back to summary
public long size() set by libffi; you should initialize it to zero. Annotations @NativeType:size_t

size

back to summary

public long size()

set by libffi; you should initialize it to zero.

Annotations

@NativeType:size_t

size	back to summary
public FFIType size(long value) Sets the specified value to the `size` field.

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

type back to summary

type	back to summary
public short type() for a structure, this should be set to `TYPE_STRUCT`. Annotations @NativeType:unsigned short

public short type()

for a structure, this should be set to TYPE_STRUCT.

Annotations

@NativeType:unsigned short

type	back to summary
public FFIType type(short value) Sets the specified value to the `type` field.

org.lwjgl.system.libffi back to summary

public Class FFIType.Buffer

Class Inheritance

extends StructBuffer<FFIType, FFIType.Buffer>
implements NativeResource

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of FFIType structs.

Field Summary

Modifier and Type	Field and Description
private static final FFIType	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `FFIType.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 Type	Method and Description
public short	Returns: the value of the `FFIType#alignment` field. alignment()
public FFIType.Buffer	alignment(short value) Sets the specified value to the `FFIType#alignment` field.
public PointerBuffer	Returns: a `PointerBuffer` view of the data pointed to by the `FFIType#elements` field. elements(int the number of elements in the returned buffer capacity)
public FFIType.Buffer	elements(PointerBuffer value) Sets the address of the specified `PointerBuffer` to the `FFIType#elements` field.
protected FFIType	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected FFIType.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `FFIType#size` field. size()
public FFIType.Buffer	size(long value) Sets the specified value to the `FFIType#size` field.
public short	Returns: the value of the `FFIType#type` field. type()
public FFIType.Buffer	type(short value) Sets the specified value to the `FFIType#type` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final FFIType ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new FFIType.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 FFIType#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

alignment	back to summary
public short alignment() Returns:short the value of the `FFIType#alignment` field. Annotations @NativeType:unsigned short

alignment	back to summary
public FFIType.Buffer alignment(short value) Sets the specified value to the `FFIType#alignment` field.

elements	back to summary
public PointerBuffer elements(int capacity) Parameters capacity:int the number of elements in the returned buffer Returns:PointerBuffer a `PointerBuffer` view of the data pointed to by the `FFIType#elements` field. Annotations @Nullable @NativeType:ffi_type *