LWJGL 3.3.3 · org.lwjgl.system.Callback

Modifier and Type	Class and Description
private static interface	Callback.ClosureRegistry

Modifier and Type	Field and Description
private long	address
private static final long	CALLBACK_HANDLER Address of the native callback handler that will call the Java method when the native callback function is invoked.
private static final Callback.ClosureRegistry	CLOSURE_REGISTRY
private static final boolean	DEBUG_ALLOCATOR

Access	Constructor and Description
protected	Callback(FFICIF the libffi CIF cif) Creates a callback instance using the specified libffi CIF.
protected	Callback(long the function address address) Creates a callback instance using the specified function address

Method Summary

Modifier and Type	Method and Description
public long	address() Implements org.lwjgl.system.Pointer.address. Returns the raw pointer address as a `long` value.
pack-priv static long	Returns: the dynamically generated native function create(FFICIF the `libffi` CIF cif, Object the callback instance instance) Creates a native function that delegates to the specified instance when called.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public void	free() Implements org.lwjgl.system.NativeResource.free. Frees any native resources held by this object.
public static void	free(long the function pointer functionPointer) Frees any resources held by the specified function pointer.
public static < the `CallbackI` instance type T extends CallbackI> T	Returns: the `CallbackI` instance get(long a function pointer functionPointer) Converts the specified function pointer to the `CallbackI` instance associated with it.
private static native long	getCallbackHandler(Method callback)
public static <T extends CallbackI> T	getSafe(long functionPointer) Like `get`, but returns `null` if `functionPointer` is `NULL`.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

address	back to summary
private long address

CALLBACK_HANDLER	back to summary
private static final long CALLBACK_HANDLER Address of the native callback handler that will call the Java method when the native callback function is invoked.

CLOSURE_REGISTRY	back to summary
private static final Callback.ClosureRegistry CLOSURE_REGISTRY

DEBUG_ALLOCATOR	back to summary
private static final boolean DEBUG_ALLOCATOR

Callback	back to summary
protected Callback(FFICIF cif) Creates a callback instance using the specified libffi CIF. Parameters cif:FFICIF the libffi CIF

Callback	back to summary
protected Callback(long address) Creates a callback instance using the specified function address Parameters address:long the function address

Method Detail

address back to summary

address	back to summary
public long address() Implements org.lwjgl.system.Pointer.address. Doc from org.lwjgl.system.Pointer.address. Returns the raw pointer address as a `long` value. Returns:long the pointer address Annotations @Override

public long address()

Implements org.lwjgl.system.Pointer.address.

Doc from org.lwjgl.system.Pointer.address.

Returns the raw pointer address as a long value.

Returns:long

the pointer address

Annotations

@Override

create back to summary

create	back to summary
pack-priv static long create(FFICIF cif, Object instance) Creates a native function that delegates to the specified instance when called. The native function uses the default calling convention. Parameters cif:FFICIF the `libffi` CIF instance:Object the callback instance Returns:long the dynamically generated native function

pack-priv static long create(FFICIF cif, Object instance)

Creates a native function that delegates to the specified instance when called.

The native function uses the default calling convention.

Parameters

cif:FFICIF: the libffi CIF
instance:Object: the callback instance

Returns:long

the dynamically generated native function

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

free	back to summary
public void free() Implements org.lwjgl.system.NativeResource.free. Doc from org.lwjgl.system.NativeResource.free. Frees any native resources held by this object. Annotations @Override

free

back to summary

public void free()

Implements org.lwjgl.system.NativeResource.free.

Doc from org.lwjgl.system.NativeResource.free.

Frees any native resources held by this object.

Annotations

@Override

free	back to summary
public static void free(long functionPointer) Frees any resources held by the specified function pointer. Parameters functionPointer:long the function pointer

free

back to summary

public static void free(long functionPointer)

Frees any resources held by the specified function pointer.

Parameters

functionPointer:long: the function pointer

get back to summary

get	back to summary
public static <T extends CallbackI> T get(long functionPointer) Converts the specified function pointer to the `CallbackI` instance associated with it. Parameters <T> the `CallbackI` instance type functionPointer:long a function pointer Returns:T the `CallbackI` instance

public static <T extends CallbackI> T get(long functionPointer)

Converts the specified function pointer to the CallbackI instance associated with it.

Parameters

<T>: the CallbackI instance type
functionPointer:long: a function pointer

Returns:T

the CallbackI instance

getCallbackHandler	back to summary
private static native long getCallbackHandler(Method callback)

getSafe back to summary

getSafe	back to summary
public static <T extends CallbackI> T getSafe(long functionPointer) Like `get`, but returns `null` if `functionPointer` is `NULL`. Annotations @Nullable

public static <T extends CallbackI> T getSafe(long functionPointer)

Like get, but returns null if functionPointer is NULL.

Annotations

@Nullable

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations