BGFXAllocatorInterface (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class BGFXAllocatorInterface
extends org.lwjgl.system.Struct
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.
Member documentation
- vtbl – the allocator virtual table
Layout
```
 struct bgfx_allocator_interface_t {
     bgfx_allocator_vtbl_t const * vtbl;
 }
```

Nested Class Summary
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Field Summary

Fields
Modifier and Type Field and Description

static int ALIGNOF
The struct alignment in bytes.

static int SIZEOF
The struct size in bytes.

static int VTBL
The struct member offsets.
- Fields inherited from interface org.lwjgl.system.Pointer
  BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

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

Constructor Summary

Constructors
Constructor and Description
`BGFXAllocatorInterface(java.nio.ByteBuffer container)` Creates a `BGFXAllocatorInterface` 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 BGFXAllocatorInterface`	`calloc()` Returns a new `BGFXAllocatorInterface` instance allocated with `memCalloc`.
`static BGFXAllocatorInterface`	`callocStack()` Returns a new `BGFXAllocatorInterface` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXAllocatorInterface`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXAllocatorInterface` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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 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`	`mallocStack()` Returns a new `BGFXAllocatorInterface` instance allocated on the thread-local `MemoryStack`.
`static BGFXAllocatorInterface`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXAllocatorInterface` instance allocated on the specified `MemoryStack`.
`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`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.
`BGFXAllocatorVtbl`	`vtbl()` Returns a `BGFXAllocatorVtbl` view of the struct pointed to by the `vtbl` field.
`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

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.
  - VTBL
```
public static final int VTBL
```
    The struct member offsets.
- Constructor Detail
  - BGFXAllocatorInterface
```
public BGFXAllocatorInterface(java.nio.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 Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - vtbl
```
public BGFXAllocatorVtbl vtbl()
```
    Returns a BGFXAllocatorVtbl view of the struct pointed to by the vtbl field.
  - 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
```
@Nullable
public static BGFXAllocatorInterface createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static BGFXAllocatorInterface mallocStack()
```
    Returns a new BGFXAllocatorInterface instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static BGFXAllocatorInterface callocStack()
```
    Returns a new BGFXAllocatorInterface instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static BGFXAllocatorInterface mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXAllocatorInterface instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static BGFXAllocatorInterface callocStack(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
  - 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 BGFXAllocatorInterface

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

VTBL

Constructor Detail

BGFXAllocatorInterface

Method Detail

sizeof

vtbl

vtbl

set

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

nvtbl

nvtbl

validate

validate