Package org.lwjgl.bgfx

Class BGFXAllocatorVtbl

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<BGFXAllocatorVtbl>

org.lwjgl.bgfx.BGFXAllocatorVtbl

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class BGFXAllocatorVtbl
extends Struct<BGFXAllocatorVtbl>
implements NativeResource

 struct bgfx_allocator_vtbl_t {
     void * (* realloc) (bgfx_allocator_interface_t * _this, void * _ptr, size_t _size, size_t _align, char * _file, uint32_t _line);
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BGFXAllocatorVtbl.Buffer	An array of BGFXAllocatorVtbl structs.

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	REALLOC	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static BGFXAllocatorVtbl	calloc()	Returns a new BGFXAllocatorVtbl instance allocated with memCalloc.
static BGFXAllocatorVtbl.Buffer	calloc(int capacity)	Returns a new BGFXAllocatorVtbl.Buffer instance allocated with memCalloc.
static BGFXAllocatorVtbl.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new BGFXAllocatorVtbl.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static BGFXAllocatorVtbl	calloc(MemoryStack stack)	Returns a new BGFXAllocatorVtbl instance allocated on the specified MemoryStack and initializes all its bits to zero.
static BGFXAllocatorVtbl	callocStack()	Deprecated.
static BGFXAllocatorVtbl.Buffer	callocStack(int capacity)	Deprecated.
static BGFXAllocatorVtbl.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static BGFXAllocatorVtbl	callocStack(MemoryStack stack)	Deprecated.
static BGFXAllocatorVtbl	create()	Returns a new BGFXAllocatorVtbl instance allocated with BufferUtils.
static BGFXAllocatorVtbl.Buffer	create(int capacity)	Returns a new BGFXAllocatorVtbl.Buffer instance allocated with BufferUtils.
static BGFXAllocatorVtbl	create(long address)	Returns a new BGFXAllocatorVtbl instance for the specified memory address.
static BGFXAllocatorVtbl.Buffer	create(long address, int capacity)	Create a BGFXAllocatorVtbl.Buffer instance at the specified memory.
static @Nullable BGFXAllocatorVtbl	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable BGFXAllocatorVtbl.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static BGFXAllocatorVtbl	malloc()	Returns a new BGFXAllocatorVtbl instance allocated with memAlloc.
static BGFXAllocatorVtbl.Buffer	malloc(int capacity)	Returns a new BGFXAllocatorVtbl.Buffer instance allocated with memAlloc.
static BGFXAllocatorVtbl.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new BGFXAllocatorVtbl.Buffer instance allocated on the specified MemoryStack.
static BGFXAllocatorVtbl	malloc(MemoryStack stack)	Returns a new BGFXAllocatorVtbl instance allocated on the specified MemoryStack.
static BGFXAllocatorVtbl	mallocStack()	Deprecated.
static BGFXAllocatorVtbl.Buffer	mallocStack(int capacity)	Deprecated.
static BGFXAllocatorVtbl.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static BGFXAllocatorVtbl	mallocStack(MemoryStack stack)	Deprecated.
static BGFXReallocCallback	nrealloc(long struct)	Unsafe version of realloc().
static void	nrealloc(long struct, BGFXReallocCallbackI value)	Unsafe version of realloc.
BGFXReallocCallback	realloc()
BGFXAllocatorVtbl	realloc(BGFXReallocCallbackI value)	Sets the specified value to the realloc field.
BGFXAllocatorVtbl	set(BGFXAllocatorVtbl 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.

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.

REALLOC

public static final int REALLOC

The struct member offsets.

Constructor Details

BGFXAllocatorVtbl

public BGFXAllocatorVtbl(ByteBuffer container)

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

realloc

public BGFXReallocCallback realloc()

Returns:

the value of the realloc field.

realloc

public BGFXAllocatorVtbl realloc(BGFXReallocCallbackI value)

Sets the specified value to the realloc field.

set

public BGFXAllocatorVtbl set(BGFXAllocatorVtbl src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static BGFXAllocatorVtbl malloc()

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

calloc

public static BGFXAllocatorVtbl calloc()

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

create

public static BGFXAllocatorVtbl create()

Returns a new BGFXAllocatorVtbl instance allocated with BufferUtils.

create

public static BGFXAllocatorVtbl create(long address)

Returns a new BGFXAllocatorVtbl instance for the specified memory address.

createSafe

public static @Nullable BGFXAllocatorVtbl createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static BGFXAllocatorVtbl.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static BGFXAllocatorVtbl.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static BGFXAllocatorVtbl.Buffer create(int capacity)

Returns a new BGFXAllocatorVtbl.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static BGFXAllocatorVtbl.Buffer create(long address,
 int capacity)

Create a BGFXAllocatorVtbl.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable BGFXAllocatorVtbl.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static BGFXAllocatorVtbl mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static BGFXAllocatorVtbl callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static BGFXAllocatorVtbl mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static BGFXAllocatorVtbl callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static BGFXAllocatorVtbl.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static BGFXAllocatorVtbl.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static BGFXAllocatorVtbl.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static BGFXAllocatorVtbl.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static BGFXAllocatorVtbl malloc(MemoryStack stack)

Returns a new BGFXAllocatorVtbl instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static BGFXAllocatorVtbl calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static BGFXAllocatorVtbl.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static BGFXAllocatorVtbl.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nrealloc

public static BGFXReallocCallback nrealloc(long struct)

Unsafe version of realloc().

nrealloc

public static void nrealloc(long struct,
 BGFXReallocCallbackI value)

Unsafe version of realloc.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate