BGFXAllocatorVtbl (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.bgfx.BGFXAllocatorVtbl

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class BGFXAllocatorVtbl
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Allocator virtual table

Member documentation

realloc – the reallocation callback

Layout


 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 and Description

static class BGFXAllocatorVtbl.Buffer
An array of BGFXAllocatorVtbl structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`REALLOC` The struct member offsets.
`static 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 and Description

BGFXAllocatorVtbl(java.nio.ByteBuffer container)
Creates a BGFXAllocatorVtbl instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`BGFXAllocatorVtbl(java.nio.ByteBuffer container)` Creates a `BGFXAllocatorVtbl` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`callocStack()` Returns a new `BGFXAllocatorVtbl` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXAllocatorVtbl.Buffer`	`callocStack(int capacity)` Returns a new `BGFXAllocatorVtbl.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXAllocatorVtbl.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXAllocatorVtbl.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static BGFXAllocatorVtbl`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXAllocatorVtbl` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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 BGFXAllocatorVtbl`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static 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`	`mallocStack()` Returns a new `BGFXAllocatorVtbl` instance allocated on the thread-local `MemoryStack`.
`static BGFXAllocatorVtbl.Buffer`	`mallocStack(int capacity)` Returns a new `BGFXAllocatorVtbl.Buffer` instance allocated on the thread-local `MemoryStack`.
`static BGFXAllocatorVtbl.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXAllocatorVtbl.Buffer` instance allocated on the specified `MemoryStack`.
`static BGFXAllocatorVtbl`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXAllocatorVtbl` instance allocated on the specified `MemoryStack`.
`static BGFXReallocCallback`	`nrealloc(long struct)` Unsafe version of `realloc()`.
`static void`	`nrealloc(long struct, BGFXReallocCallbackI value)` Unsafe version of `realloc`.
`BGFXReallocCallback`	`realloc()` Returns the value of the `realloc` field.
`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()`
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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 Detail
  - BGFXAllocatorVtbl
```
public BGFXAllocatorVtbl(java.nio.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 Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - 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
```
@Nullable
public static 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
```
@Nullable
public static BGFXAllocatorVtbl.Buffer createSafe(long address,
                                                            int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static BGFXAllocatorVtbl mallocStack()
```
    Returns a new BGFXAllocatorVtbl instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static BGFXAllocatorVtbl callocStack()
```
    Returns a new BGFXAllocatorVtbl instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static BGFXAllocatorVtbl mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXAllocatorVtbl instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static BGFXAllocatorVtbl callocStack(org.lwjgl.system.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
  - mallocStack
```
public static BGFXAllocatorVtbl.Buffer mallocStack(int capacity)
```
    Returns a new BGFXAllocatorVtbl.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static BGFXAllocatorVtbl.Buffer callocStack(int capacity)
```
    Returns a new BGFXAllocatorVtbl.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static BGFXAllocatorVtbl.Buffer mallocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXAllocatorVtbl.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static BGFXAllocatorVtbl.Buffer callocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXAllocatorVtbl.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class BGFXAllocatorVtbl

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

REALLOC

Constructor Detail

BGFXAllocatorVtbl

Method Detail

sizeof

realloc

realloc

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nrealloc

nrealloc

validate

validate