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

public Class JNINativeMethod

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

Layout


struct JNINativeMethod {
    char * name;
    char * signature;
    void * fnPtr;
}

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
FNPTR

The struct member offsets.

public static final int
NAME

The struct member offsets.

public static final int
SIGNATURE

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

public
JNINativeMethod(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static JNINativeMethod
calloc()

Returns a new JNINativeMethod instance allocated with memCalloc.

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

Returns a new JNINativeMethod.Buffer instance allocated with memCalloc.

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

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

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

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

public static JNINativeMethod
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static JNINativeMethod
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static JNINativeMethod.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static JNINativeMethod.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected JNINativeMethod
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 JNINativeMethod
create()

Returns a new JNINativeMethod instance allocated with BufferUtils.

public static JNINativeMethod
create(long address)

Returns a new JNINativeMethod instance for the specified memory address.

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

Returns a new JNINativeMethod.Buffer instance allocated with BufferUtils.

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

Create a JNINativeMethod.Buffer instance at the specified memory.

public static JNINativeMethod
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long

Returns:

the value of the fnPtr field.
fnPtr
()

public JNINativeMethod
fnPtr(long value)

Sets the specified value to the fnPtr field.

public static JNINativeMethod
malloc()

Returns a new JNINativeMethod instance allocated with memAlloc.

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

Returns a new JNINativeMethod.Buffer instance allocated with memAlloc.

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

Returns a new JNINativeMethod instance allocated on the specified MemoryStack.

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

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

public static JNINativeMethod
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static JNINativeMethod
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static JNINativeMethod.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static JNINativeMethod.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the name field.
name
()

public JNINativeMethod
name(ByteBuffer value)

Sets the address of the specified encoded string to the name field.

public String

Returns:

the null-terminated string pointed to by the name field.
nameString
()

public static long
nfnPtr(long struct)

Unsafe version of fnPtr.

public static void
nfnPtr(long struct, long value)

Unsafe version of fnPtr.

public static ByteBuffer
nname(long struct)

Unsafe version of name.

public static void
nname(long struct, ByteBuffer value)

Unsafe version of name.

public static String
nnameString(long struct)

Unsafe version of nameString.

public static ByteBuffer
nsignature(long struct)

Unsafe version of signature.

public static void
nsignature(long struct, ByteBuffer value)

Unsafe version of signature.

public static String
nsignatureString(long struct)

Unsafe version of signatureString.

public JNINativeMethod
set(ByteBuffer name, ByteBuffer signature, long fnPtr)

Initializes this struct with the specified values.

public JNINativeMethod

Returns:

this struct
set
(JNINativeMethod
the source struct
src
)

Copies the specified struct data to this struct.

public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the signature field.
signature
()

public JNINativeMethod
signature(ByteBuffer value)

Sets the address of the specified encoded string to the signature field.

public String

Returns:

the null-terminated string pointed to by the signature field.
signatureString
()

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.

FNPTRback to summary
public static final int FNPTR

The struct member offsets.

NAMEback to summary
public static final int NAME

The struct member offsets.

SIGNATUREback to summary
public static final int SIGNATURE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

JNINativeMethodback to summary
protected JNINativeMethod(long address, ByteBuffer container)
JNINativeMethodback to summary
public JNINativeMethod(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static JNINativeMethod calloc(MemoryStack stack)

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

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

callocStackback to summary
public static JNINativeMethod callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static JNINativeMethod callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static JNINativeMethod.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static JNINativeMethod.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected JNINativeMethod 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 JNINativeMethod create()

Returns a new JNINativeMethod instance allocated with BufferUtils.

createback to summary
public static JNINativeMethod create(long address)

Returns a new JNINativeMethod instance for the specified memory address.

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

Returns a new JNINativeMethod.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a JNINativeMethod.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static JNINativeMethod createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
fnPtrback to summary
public long fnPtr()
Returns:long

the value of the fnPtr field.

Annotations
@NativeType:void *
fnPtrback to summary
public JNINativeMethod fnPtr(long value)

Sets the specified value to the fnPtr field.

mallocback to summary
public static JNINativeMethod malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static JNINativeMethod malloc(MemoryStack stack)

Returns a new JNINativeMethod instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static JNINativeMethod mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static JNINativeMethod mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static JNINativeMethod.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static JNINativeMethod.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the name field.

Annotations
@NativeType:char *
nameback to summary
public JNINativeMethod name(ByteBuffer value)

Sets the address of the specified encoded string to the name field.

nameStringback to summary
public String nameString()
Returns:String

the null-terminated string pointed to by the name field.

Annotations
@NativeType:char *
nfnPtrback to summary
public static long nfnPtr(long struct)

Unsafe version of fnPtr.

nfnPtrback to summary
public static void nfnPtr(long struct, long value)

Unsafe version of fnPtr.

nnameback to summary
public static ByteBuffer nname(long struct)

Unsafe version of name.

nnameback to summary
public static void nname(long struct, ByteBuffer value)

Unsafe version of name.

nnameStringback to summary
public static String nnameString(long struct)

Unsafe version of nameString.

nsignatureback to summary
public static ByteBuffer nsignature(long struct)

Unsafe version of signature.

nsignatureback to summary
public static void nsignature(long struct, ByteBuffer value)

Unsafe version of signature.

nsignatureStringback to summary
public static String nsignatureString(long struct)

Unsafe version of signatureString.

setback to summary
public JNINativeMethod set(ByteBuffer name, ByteBuffer signature, long fnPtr)

Initializes this struct with the specified values.

setback to summary
public JNINativeMethod set(JNINativeMethod src)

Copies the specified struct data to this struct.

Parameters
src:JNINativeMethod

the source struct

Returns:JNINativeMethod

this struct

signatureback to summary
public ByteBuffer signature()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the signature field.

Annotations
@NativeType:char *
signatureback to summary
public JNINativeMethod signature(ByteBuffer value)

Sets the address of the specified encoded string to the signature field.

signatureStringback to summary
public String signatureString()
Returns:String

the null-terminated string pointed to by the signature field.

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

public Class JNINativeMethod.Buffer

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

An array of JNINativeMethod structs.

Field Summary

Modifier and TypeField and Description
private static final JNINativeMethod

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new JNINativeMethod.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 fnPtr field.
fnPtr
()

public JNINativeMethod.Buffer
fnPtr(long value)

Sets the specified value to the fnPtr field.

protected JNINativeMethod
public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the name field.
name
()

public JNINativeMethod.Buffer
name(ByteBuffer value)

Sets the address of the specified encoded string to the name field.

public String

Returns:

the null-terminated string pointed to by the name field.
nameString
()

protected JNINativeMethod.Buffer
public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the signature field.
signature
()

public JNINativeMethod.Buffer
signature(ByteBuffer value)

Sets the address of the specified encoded string to the signature field.

public String

Returns:

the null-terminated string pointed to by the signature field.
signatureString
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final JNINativeMethod ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

fnPtrback to summary
public long fnPtr()
Returns:long

the value of the fnPtr field.

Annotations
@NativeType:void *
fnPtrback to summary
public JNINativeMethod.Buffer fnPtr(long value)

Sets the specified value to the fnPtr field.

getElementFactoryback to summary
protected JNINativeMethod getElementFactory()

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

Annotations
@Override
nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the name field.

Annotations
@NativeType:char *
nameback to summary
public JNINativeMethod.Buffer name(ByteBuffer value)

Sets the address of the specified encoded string to the name field.

nameStringback to summary
public String nameString()
Returns:String

the null-terminated string pointed to by the name field.

Annotations
@NativeType:char *
selfback to summary
protected JNINativeMethod.Buffer self()

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

Annotations
@Override
signatureback to summary
public ByteBuffer signature()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the signature field.

Annotations
@NativeType:char *
signatureback to summary
public JNINativeMethod.Buffer signature(ByteBuffer value)

Sets the address of the specified encoded string to the signature field.

signatureStringback to summary
public String signatureString()
Returns:String

the null-terminated string pointed to by the signature field.

Annotations
@NativeType:char *