Package org.lwjgl.bgfx

Class BGFXCallbackInterface

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<BGFXCallbackInterface>

org.lwjgl.bgfx.BGFXCallbackInterface

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class BGFXCallbackInterface
extends Struct<BGFXCallbackInterface>
implements NativeResource

Callback interface to implement application specific behavior.

Cached items are currently used for OpenGL and Direct3D 12 binary shaders.

fatal and trace_vargs callbacks can be called from any thread. Other callbacks are called from the render thread.

Layout

 struct bgfx_callback_interface_t {
     bgfx_callback_vtbl_t const * vtbl();
 }

Nested Class Summary

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	SIZEOF	The struct size in bytes.
static final int	VTBL	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
BGFXCallbackInterface(ByteBuffer container)	Creates a BGFXCallbackInterface instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static BGFXCallbackInterface	calloc()	Returns a new BGFXCallbackInterface instance allocated with memCalloc.
static BGFXCallbackInterface	calloc(MemoryStack stack)	Returns a new BGFXCallbackInterface instance allocated on the specified MemoryStack and initializes all its bits to zero.
static BGFXCallbackInterface	callocStack()	Deprecated.
static BGFXCallbackInterface	callocStack(MemoryStack stack)	Deprecated.
static BGFXCallbackInterface	create()	Returns a new BGFXCallbackInterface instance allocated with BufferUtils.
static BGFXCallbackInterface	create(long address)	Returns a new BGFXCallbackInterface instance for the specified memory address.
static BGFXCallbackInterface	createSafe(long address)	Like create, but returns null if address is NULL.
static BGFXCallbackInterface	malloc()	Returns a new BGFXCallbackInterface instance allocated with memAlloc.
static BGFXCallbackInterface	malloc(MemoryStack stack)	Returns a new BGFXCallbackInterface instance allocated on the specified MemoryStack.
static BGFXCallbackInterface	mallocStack()	Deprecated.
static BGFXCallbackInterface	mallocStack(MemoryStack stack)	Deprecated.
static BGFXCallbackVtbl	nvtbl(long struct)	Unsafe version of vtbl().
static void	nvtbl(long struct, BGFXCallbackVtbl value)	Unsafe version of vtbl.
BGFXCallbackInterface	set(BGFXCallbackInterface src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.
BGFXCallbackVtbl	vtbl()	the callback virtual table
BGFXCallbackInterface	vtbl(BGFXCallbackVtbl value)	Sets the address of the specified BGFXCallbackVtbl to the vtbl() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

VTBL

public static final int VTBL

The struct member offsets.

Constructor Details

BGFXCallbackInterface

public BGFXCallbackInterface(ByteBuffer container)

Creates a BGFXCallbackInterface 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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<BGFXCallbackInterface>

vtbl

public BGFXCallbackVtbl vtbl()

the callback virtual table

vtbl

public BGFXCallbackInterface vtbl(BGFXCallbackVtbl value)

Sets the address of the specified BGFXCallbackVtbl to the vtbl() field.

set

public BGFXCallbackInterface set(BGFXCallbackInterface src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static BGFXCallbackInterface malloc()

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

calloc

public static BGFXCallbackInterface calloc()

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

create

public static BGFXCallbackInterface create()

Returns a new BGFXCallbackInterface instance allocated with BufferUtils.

create

public static BGFXCallbackInterface create(long address)

Returns a new BGFXCallbackInterface instance for the specified memory address.

createSafe

@Nullable
public static BGFXCallbackInterface createSafe(long address)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static BGFXCallbackInterface mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static BGFXCallbackInterface callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static BGFXCallbackInterface mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static BGFXCallbackInterface callocStack(MemoryStack stack)

Deprecated.

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

malloc

public static BGFXCallbackInterface malloc(MemoryStack stack)

Returns a new BGFXCallbackInterface instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static BGFXCallbackInterface calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

nvtbl

public static BGFXCallbackVtbl nvtbl(long struct)

Unsafe version of vtbl().

nvtbl

public static void nvtbl(long struct,
 BGFXCallbackVtbl value)

Unsafe version of vtbl.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate