Top Description Inners Fields Constructors Methods
org.lwjgl.system.libffi

public Class FFIClosure

extends Struct<FFIClosure>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct ffi_closure
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

The libffi closure structure.

Layout


struct ffi_closure {
    ffi_cif * cif;
    void (*)(ffi_cif*,void*,void**,void*) fun;
    void * user_data;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
FFIClosure.Buffer

An array of FFIClosure structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CIF

The struct member offsets.

public static final int
FUN

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
USER_DATA

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
FFIClosure(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static FFIClosure
calloc()

Returns a new FFIClosure instance allocated with memCalloc.

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

Returns a new FFIClosure.Buffer instance allocated with memCalloc.

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

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

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

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

public FFICIF
cif()

a pointer to an ffi_cif structure

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

Returns a new FFIClosure instance allocated with BufferUtils.

public static FFIClosure
create(long address)

Returns a new FFIClosure instance for the specified memory address.

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

Returns a new FFIClosure.Buffer instance allocated with BufferUtils.

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

Create a FFIClosure.Buffer instance at the specified memory.

public static FFIClosure
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
fun()

a pointer to a function

public static FFIClosure
malloc()

Returns a new FFIClosure instance allocated with memAlloc.

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

Returns a new FFIClosure.Buffer instance allocated with memAlloc.

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

Returns a new FFIClosure instance allocated on the specified MemoryStack.

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

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

public static FFICIF
ncif(long struct)

Unsafe version of cif.

public static long
nfun(long struct)

Unsafe version of fun.

public static long
nuser_data(long struct)

Unsafe version of user_data.

private static native int
offsets(long buffer)

public int
sizeof()

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

Returns sizeof(struct).
public long
user_data()

a pointer to user-specified data

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.

CIFback to summary
public static final int CIF

The struct member offsets.

FUNback to summary
public static final int FUN

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

USER_DATAback to summary
public static final int USER_DATA

The struct member offsets.

Constructor Detail

FFIClosureback to summary
protected FFIClosure(long address, ByteBuffer container)
FFIClosureback to summary
public FFIClosure(ByteBuffer container)

Creates a FFIClosure 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 FFIClosure calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static FFIClosure calloc(MemoryStack stack)

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

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

cifback to summary
public FFICIF cif()

a pointer to an ffi_cif structure

Annotations
@NativeType:ffi_cif *
createback to summary
protected FFIClosure 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 FFIClosure create()

Returns a new FFIClosure instance allocated with BufferUtils.

createback to summary
public static FFIClosure create(long address)

Returns a new FFIClosure instance for the specified memory address.

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

Returns a new FFIClosure.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a FFIClosure.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FFIClosure createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
funback to summary
public long fun()

a pointer to a function

Annotations
@NativeType:void (*)(ffi_cif*,void*,void**,void*)
mallocback to summary
public static FFIClosure malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static FFIClosure malloc(MemoryStack stack)

Returns a new FFIClosure instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncifback to summary
public static FFICIF ncif(long struct)

Unsafe version of cif.

nfunback to summary
public static long nfun(long struct)

Unsafe version of fun.

nuser_databack to summary
public static long nuser_data(long struct)

Unsafe version of user_data.

offsetsback to summary
private static native int offsets(long buffer)
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
user_databack to summary
public long user_data()

a pointer to user-specified data

Annotations
@NativeType:void *
org.lwjgl.system.libffi back to summary

public Class FFIClosure.Buffer

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

An array of FFIClosure structs.

Field Summary

Modifier and TypeField and Description
private static final FFIClosure

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new FFIClosure.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 FFICIF

Returns:

a FFICIF view of the struct pointed to by the FFIClosure#cif field.
cif
()

public long

Returns:

the value of the FFIClosure#fun field.
fun
()

protected FFIClosure
protected FFIClosure.Buffer
public long

Returns:

the value of the FFIClosure#user_data field.
user_data
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final FFIClosure ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

cifback to summary
public FFICIF cif()
Returns:FFICIF

a FFICIF view of the struct pointed to by the FFIClosure#cif field.

Annotations
@NativeType:ffi_cif *
funback to summary
public long fun()
Returns:long

the value of the FFIClosure#fun field.

Annotations
@NativeType:void (*)(ffi_cif*,void*,void**,void*)
getElementFactoryback to summary
protected FFIClosure getElementFactory()

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

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

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

Annotations
@Override
user_databack to summary
public long user_data()
Returns:long

the value of the FFIClosure#user_data field.

Annotations
@NativeType:void *