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

public Class FFICIF

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

Contains information about a libffi call interface.

Layout


struct ffi_cif {
    ffi_abi abi;
    unsigned nargs;
    ffi_type ** arg_types;
    ffi_type * rtype;
    unsigned bytes;
    unsigned flags;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
FFICIF.Buffer

An array of FFICIF structs.

Field Summary

Modifier and TypeField and Description
public static final int
ABI

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ARG_TYPES

The struct member offsets.

public static final int
BYTES

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
NARGS

The struct member offsets.

public static final int
RTYPE

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

public
FFICIF(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the abi field.
abi
()

public PointerBuffer

Returns:

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

public int

Returns:

the value of the bytes field.
bytes
()

public static FFICIF
calloc()

Returns a new FFICIF instance allocated with memCalloc.

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

Returns a new FFICIF.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new FFICIF instance allocated with BufferUtils.

public static FFICIF
create(long address)

Returns a new FFICIF instance for the specified memory address.

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

Returns a new FFICIF.Buffer instance allocated with BufferUtils.

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

Create a FFICIF.Buffer instance at the specified memory.

public static FFICIF
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the flags field.
flags
()

public static FFICIF
malloc()

Returns a new FFICIF instance allocated with memAlloc.

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

Returns a new FFICIF.Buffer instance allocated with memAlloc.

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

Returns a new FFICIF instance allocated on the specified MemoryStack.

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

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

public static int
nabi(long struct)

Unsafe version of abi.

public static PointerBuffer
narg_types(long struct, int capacity)

Unsafe version of arg_types.

public int

Returns:

the value of the nargs field.
nargs
()

public static int
nbytes(long struct)

Unsafe version of bytes.

public static int
nflags(long struct)

Unsafe version of flags.

public static int
nnargs(long struct)

Unsafe version of nargs.

public static FFIType
nrtype(long struct)

Unsafe version of rtype.

private static native int
offsets(long buffer)

public FFIType

Returns:

a FFIType view of the struct pointed to by the rtype field.
rtype
()

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

ABIback to summary
public static final int ABI

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

ARG_TYPESback to summary
public static final int ARG_TYPES

The struct member offsets.

BYTESback to summary
public static final int BYTES

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

NARGSback to summary
public static final int NARGS

The struct member offsets.

RTYPEback to summary
public static final int RTYPE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

FFICIFback to summary
protected FFICIF(long address, ByteBuffer container)
FFICIFback to summary
public FFICIF(ByteBuffer container)

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

abiback to summary
public int abi()
Returns:int

the value of the abi field.

Annotations
@NativeType:ffi_abi
arg_typesback to summary
public PointerBuffer arg_types(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 arg_types field.

Annotations
@NativeType:ffi_type **
bytesback to summary
public int bytes()
Returns:int

the value of the bytes field.

Annotations
@NativeType:unsigned
callocback to summary
public static FFICIF calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static FFICIF calloc(MemoryStack stack)

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

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

Returns a new FFICIF instance allocated with BufferUtils.

createback to summary
public static FFICIF create(long address)

Returns a new FFICIF instance for the specified memory address.

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

Returns a new FFICIF.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a FFICIF.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FFICIF createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()
Returns:int

the value of the flags field.

Annotations
@NativeType:unsigned
mallocback to summary
public static FFICIF malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static FFICIF malloc(MemoryStack stack)

Returns a new FFICIF instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nabiback to summary
public static int nabi(long struct)

Unsafe version of abi.

narg_typesback to summary
public static PointerBuffer narg_types(long struct, int capacity)

Unsafe version of arg_types.

nargsback to summary
public int nargs()
Returns:int

the value of the nargs field.

Annotations
@NativeType:unsigned
nbytesback to summary
public static int nbytes(long struct)

Unsafe version of bytes.

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nnargsback to summary
public static int nnargs(long struct)

Unsafe version of nargs.

nrtypeback to summary
public static FFIType nrtype(long struct)

Unsafe version of rtype.

offsetsback to summary
private static native int offsets(long buffer)
rtypeback to summary
public FFIType rtype()
Returns:FFIType

a FFIType view of the struct pointed to by the rtype field.

Annotations
@NativeType:ffi_type *
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.system.libffi back to summary

public Class FFICIF.Buffer

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

An array of FFICIF structs.

Field Summary

Modifier and TypeField and Description
private static final FFICIF

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new FFICIF.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 abi field.
abi
()

public PointerBuffer

Returns:

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

public int

Returns:

the value of the bytes field.
bytes
()

public int

Returns:

the value of the flags field.
flags
()

protected FFICIF
public int

Returns:

the value of the nargs field.
nargs
()

public FFIType

Returns:

a FFIType view of the struct pointed to by the rtype field.
rtype
()

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

Field Detail

ELEMENT_FACTORYback to summary
private static final FFICIF ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

abiback to summary
public int abi()
Returns:int

the value of the abi field.

Annotations
@NativeType:ffi_abi
arg_typesback to summary
public PointerBuffer arg_types(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 arg_types field.

Annotations
@NativeType:ffi_type **
bytesback to summary
public int bytes()
Returns:int

the value of the bytes field.

Annotations
@NativeType:unsigned
flagsback to summary
public int flags()
Returns:int

the value of the flags field.

Annotations
@NativeType:unsigned
getElementFactoryback to summary
protected FFICIF getElementFactory()

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

Annotations
@Override
nargsback to summary
public int nargs()
Returns:int

the value of the nargs field.

Annotations
@NativeType:unsigned
rtypeback to summary
public FFIType rtype()
Returns:FFIType

a FFIType view of the struct pointed to by the rtype field.

Annotations
@NativeType:ffi_type *
selfback to summary
protected FFICIF.Buffer self()

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

Annotations
@Override