java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.glfw.GLFWAllocator

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

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

A custom memory allocator that can be set with InitAllocator.

Layout


 struct GLFWallocator {
     GLFWallocatefun allocate();
     GLFWreallocatefun reallocate();
     GLFWdeallocatefun deallocate();
     void * user();
 }

Since:: version 3.4

Nested Class Summary

Nested Classes
Modifier and Type Class Description

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

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`ALLOCATE DEALLOCATE REALLOCATE`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`USER`	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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GLFWAllocateCallback`	`allocate()`	the memory allocation callback
`GLFWAllocator`	`allocate(GLFWAllocateCallbackI value)`	Sets the specified value to the `allocate()` field.
`static GLFWAllocator`	`calloc()`	Returns a new `GLFWAllocator` instance allocated with `memCalloc`.
`static GLFWAllocator.Buffer`	`calloc(int capacity)`	Returns a new `GLFWAllocator.Buffer` instance allocated with `memCalloc`.
`static GLFWAllocator.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `GLFWAllocator.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static GLFWAllocator`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `GLFWAllocator` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static GLFWAllocator`	`create()`	Returns a new `GLFWAllocator` instance allocated with `BufferUtils`.
`static GLFWAllocator.Buffer`	`create(int capacity)`	Returns a new `GLFWAllocator.Buffer` instance allocated with `BufferUtils`.
`static GLFWAllocator`	`create(long address)`	Returns a new `GLFWAllocator` instance for the specified memory address.
`static GLFWAllocator.Buffer`	`create(long address, int capacity)`	Create a `GLFWAllocator.Buffer` instance at the specified memory.
`static GLFWAllocator`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static GLFWAllocator.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`GLFWDeallocateCallback`	`deallocate()`	the memory deallocation callback
`GLFWAllocator`	`deallocate(GLFWDeallocateCallbackI value)`	Sets the specified value to the `deallocate()` field.
`static GLFWAllocator`	`malloc()`	Returns a new `GLFWAllocator` instance allocated with `memAlloc`.
`static GLFWAllocator.Buffer`	`malloc(int capacity)`	Returns a new `GLFWAllocator.Buffer` instance allocated with `memAlloc`.
`static GLFWAllocator.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `GLFWAllocator.Buffer` instance allocated on the specified `MemoryStack`.
`static GLFWAllocator`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `GLFWAllocator` instance allocated on the specified `MemoryStack`.
`static GLFWAllocateCallback`	`nallocate(long struct)`	Unsafe version of `allocate()`.
`static void`	`nallocate(long struct, GLFWAllocateCallbackI value)`	Unsafe version of `allocate`.
`static GLFWDeallocateCallback`	`ndeallocate(long struct)`	Unsafe version of `deallocate()`.
`static void`	`ndeallocate(long struct, GLFWDeallocateCallbackI value)`	Unsafe version of `deallocate`.
`static GLFWReallocateCallback`	`nreallocate(long struct)`	Unsafe version of `reallocate()`.
`static void`	`nreallocate(long struct, GLFWReallocateCallbackI value)`	Unsafe version of `reallocate`.
`static long`	`nuser(long struct)`	Unsafe version of `user()`.
`static void`	`nuser(long struct, long value)`	Unsafe version of `user`.
`GLFWReallocateCallback`	`reallocate()`	the memory reallocation callback
`GLFWAllocator`	`reallocate(GLFWReallocateCallbackI value)`	Sets the specified value to the `reallocate()` field.
`GLFWAllocator`	`set(GLFWAllocateCallbackI allocate, GLFWReallocateCallbackI reallocate, GLFWDeallocateCallbackI deallocate, long user)`	Initializes this struct with the specified values.
`GLFWAllocator`	`set(GLFWAllocator src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`long`	`user()`	a user-defined pointer that will be passed to the callbacks
`GLFWAllocator`	`user(long value)`	Sets the specified value to the `user()` field.
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

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

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - ALLOCATE, REALLOCATE, DEALLOCATE, USER
    
    The struct member offsets.
- Constructor Detail
  - GLFWAllocator
```
public GLFWAllocator(java.nio.ByteBuffer container)
```
    Creates a GLFWAllocator 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
  - allocate
```
public GLFWAllocateCallback allocate()
```
    the memory allocation callback
  - reallocate
```
public GLFWReallocateCallback reallocate()
```
    the memory reallocation callback
  - deallocate
```
public GLFWDeallocateCallback deallocate()
```
    the memory deallocation callback
  - user
```
public long user()
```
    a user-defined pointer that will be passed to the callbacks
  - allocate
```
public GLFWAllocator allocate(GLFWAllocateCallbackI value)
```
    Sets the specified value to the allocate() field.
  - reallocate
```
public GLFWAllocator reallocate(GLFWReallocateCallbackI value)
```
    Sets the specified value to the reallocate() field.
  - deallocate
```
public GLFWAllocator deallocate(GLFWDeallocateCallbackI value)
```
    Sets the specified value to the deallocate() field.
  - user
```
public GLFWAllocator user(long value)
```
    Sets the specified value to the user() field.
  - set
```
public GLFWAllocator set(GLFWAllocateCallbackI allocate,
                         GLFWReallocateCallbackI reallocate,
                         GLFWDeallocateCallbackI deallocate,
                         long user)
```
    Initializes this struct with the specified values.
  - set
```
public GLFWAllocator set(GLFWAllocator src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static GLFWAllocator malloc()
```
    Returns a new GLFWAllocator instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static GLFWAllocator calloc()
```
    Returns a new GLFWAllocator instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static GLFWAllocator create()
```
    Returns a new GLFWAllocator instance allocated with BufferUtils.
  - create
```
public static GLFWAllocator create(long address)
```
    Returns a new GLFWAllocator instance for the specified memory address.
  - createSafe
```
@Nullable
public static GLFWAllocator createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static GLFWAllocator.Buffer malloc(int capacity)
```
    Returns a new GLFWAllocator.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static GLFWAllocator.Buffer calloc(int capacity)
```
    Returns a new GLFWAllocator.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static GLFWAllocator.Buffer create(int capacity)
```
    Returns a new GLFWAllocator.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static GLFWAllocator.Buffer create(long address,
                                          int capacity)
```
    Create a GLFWAllocator.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static GLFWAllocator.Buffer createSafe(long address,
                                              int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static GLFWAllocator malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new GLFWAllocator instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static GLFWAllocator calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new GLFWAllocator instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static GLFWAllocator.Buffer malloc(int capacity,
                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new GLFWAllocator.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static GLFWAllocator.Buffer calloc(int capacity,
                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new GLFWAllocator.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
  - nallocate
```
public static GLFWAllocateCallback nallocate(long struct)
```
    Unsafe version of allocate().
  - nreallocate
```
public static GLFWReallocateCallback nreallocate(long struct)
```
    Unsafe version of reallocate().
  - ndeallocate
```
public static GLFWDeallocateCallback ndeallocate(long struct)
```
    Unsafe version of deallocate().
  - nuser
```
public static long nuser(long struct)
```
    Unsafe version of user().
  - nallocate
```
public static void nallocate(long struct,
                             GLFWAllocateCallbackI value)
```
    Unsafe version of allocate.
  - nreallocate
```
public static void nreallocate(long struct,
                               GLFWReallocateCallbackI value)
```
    Unsafe version of reallocate.
  - ndeallocate
```
public static void ndeallocate(long struct,
                               GLFWDeallocateCallbackI value)
```
    Unsafe version of deallocate.
  - nuser
```
public static void nuser(long struct,
                         long value)
```
    Unsafe version of user.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate

Class GLFWAllocator

Layout

Nested Class Summary

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

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

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

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

ALLOCATE, REALLOCATE, DEALLOCATE, USER

Constructor Detail

GLFWAllocator

Method Detail

sizeof

allocate

reallocate

deallocate

user

allocate

reallocate

deallocate

user

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nallocate

nreallocate

ndeallocate

nuser

nallocate

nreallocate

ndeallocate

nuser

validate