Package org.lwjgl.bgfx

Class BGFXAllocatorInterface

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<BGFXAllocatorInterface>

org.lwjgl.bgfx.BGFXAllocatorInterface

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class BGFXAllocatorInterface
extends org.lwjgl.system.Struct<BGFXAllocatorInterface>
implements org.lwjgl.system.NativeResource

Custom allocator. When custom allocator is not specified, library uses default CRT allocator. The library assumes custom allocator is thread safe.

Layout

 struct bgfx_allocator_interface_t {
     bgfx_allocator_vtbl_t const * vtbl();
 }

Nested Class Summary

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.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
BGFXAllocatorInterface(ByteBuffer container)	Creates a BGFXAllocatorInterface instance at the current position of the specified ByteBuffer container.

Method Summary

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

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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

BGFXAllocatorInterface

public BGFXAllocatorInterface(ByteBuffer container)

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

Specified by:

sizeof in class org.lwjgl.system.Struct<BGFXAllocatorInterface>

vtbl

public BGFXAllocatorVtbl vtbl()

the allocator virtual table

vtbl

public BGFXAllocatorInterface vtbl(BGFXAllocatorVtbl value)

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

set

public BGFXAllocatorInterface set(BGFXAllocatorInterface src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static BGFXAllocatorInterface malloc()

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

calloc

public static BGFXAllocatorInterface calloc()

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

create

public static BGFXAllocatorInterface create()

Returns a new BGFXAllocatorInterface instance allocated with BufferUtils.

create

public static BGFXAllocatorInterface create(long address)

Returns a new BGFXAllocatorInterface instance for the specified memory address.

createSafe

public static @Nullable BGFXAllocatorInterface createSafe(long address)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static BGFXAllocatorInterface mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static BGFXAllocatorInterface callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static BGFXAllocatorInterface mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static BGFXAllocatorInterface callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static BGFXAllocatorInterface malloc(org.lwjgl.system.MemoryStack stack)

Returns a new BGFXAllocatorInterface instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static BGFXAllocatorInterface calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

nvtbl

public static BGFXAllocatorVtbl nvtbl(long struct)

Unsafe version of vtbl().

nvtbl

public static void nvtbl(long struct,
 BGFXAllocatorVtbl 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