Modifier and Type	Class and Description
public static class	BGFXMemory.Buffer An array of `BGFXMemory` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	DATA The struct member offsets.
public static final int	SIZE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Access	Constructor and Description
protected	BGFXMemory(long address, ByteBuffer container)
public	BGFXMemory(ByteBuffer container) Creates a `BGFXMemory` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static BGFXMemory	calloc() Returns a new `BGFXMemory` instance allocated with `memCalloc`.
public static BGFXMemory.Buffer	calloc(int the buffer capacity capacity) Returns a new `BGFXMemory.Buffer` instance allocated with `memCalloc`.
public static BGFXMemory	calloc(MemoryStack the stack from which to allocate stack) Returns a new `BGFXMemory` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static BGFXMemory.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `BGFXMemory.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static BGFXMemory	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static BGFXMemory	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static BGFXMemory.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static BGFXMemory.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected BGFXMemory	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static BGFXMemory	create() Returns a new `BGFXMemory` instance allocated with `BufferUtils`.
public static BGFXMemory	create(long address) Returns a new `BGFXMemory` instance for the specified memory address.
public static BGFXMemory.Buffer	create(int the buffer capacity capacity) Returns a new `BGFXMemory.Buffer` instance allocated with `BufferUtils`.
public static BGFXMemory.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `BGFXMemory.Buffer` instance at the specified memory.
public static BGFXMemory	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static BGFXMemory.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public ByteBuffer	data() pointer to data
public BGFXMemory	data(ByteBuffer value) Sets the address of the specified `ByteBuffer` to the `data` field.
public static BGFXMemory	malloc() Returns a new `BGFXMemory` instance allocated with `memAlloc`.
public static BGFXMemory.Buffer	malloc(int the buffer capacity capacity) Returns a new `BGFXMemory.Buffer` instance allocated with `memAlloc`.
public static BGFXMemory	malloc(MemoryStack the stack from which to allocate stack) Returns a new `BGFXMemory` instance allocated on the specified `MemoryStack`.
public static BGFXMemory.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `BGFXMemory.Buffer` instance allocated on the specified `MemoryStack`.
public static BGFXMemory	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static BGFXMemory	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static BGFXMemory.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static BGFXMemory.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static ByteBuffer	ndata(long struct) Unsafe version of `data`.
public static void	ndata(long struct, ByteBuffer value) Unsafe version of `data`.
public static int	nsize(long struct) Unsafe version of `size`.
public static void	nsize(long struct, int value) Sets the specified value to the `size` field of the specified `struct`.
public BGFXMemory	Returns: this struct set(BGFXMemory the source struct src) Copies the specified struct data to this struct.
public int	size() data size
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

DATA	back to summary
public static final int DATA The struct member offsets.

SIZE	back to summary
public static final int SIZE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

BGFXMemory	back to summary
protected BGFXMemory(long address, ByteBuffer container)

BGFXMemory back to summary

BGFXMemory	back to summary
public BGFXMemory(ByteBuffer container) Creates a `BGFXMemory` 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.

public BGFXMemory(ByteBuffer container)

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

calloc	back to summary
public static BGFXMemory calloc() Returns a new `BGFXMemory` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static BGFXMemory.Buffer calloc(int capacity) Returns a new `BGFXMemory.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static BGFXMemory.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static BGFXMemory calloc(MemoryStack stack) Returns a new `BGFXMemory` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static BGFXMemory calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static BGFXMemory.Buffer calloc(int capacity, MemoryStack stack) Returns a new `BGFXMemory.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

callocStack back to summary

callocStack	back to summary
public static BGFXMemory callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static BGFXMemory callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static BGFXMemory callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static BGFXMemory callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static BGFXMemory.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static BGFXMemory.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static BGFXMemory.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static BGFXMemory.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected BGFXMemory create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected BGFXMemory create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static BGFXMemory create() Returns a new `BGFXMemory` instance allocated with `BufferUtils`.

create	back to summary
public static BGFXMemory create(long address) Returns a new `BGFXMemory` instance for the specified memory address.

create back to summary

create	back to summary
public static BGFXMemory.Buffer create(int capacity) Returns a new `BGFXMemory.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static BGFXMemory.Buffer create(int capacity)

Returns a new BGFXMemory.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static BGFXMemory.Buffer create(long address, int capacity) Create a `BGFXMemory.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a BGFXMemory.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static BGFXMemory createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static BGFXMemory createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static BGFXMemory.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static BGFXMemory.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations

@Nullable

data	back to summary
public ByteBuffer data() pointer to data Annotations @NativeType:uint8_t *

data	back to summary
public BGFXMemory data(ByteBuffer value) Sets the address of the specified `ByteBuffer` to the `data` field.

malloc	back to summary
public static BGFXMemory malloc() Returns a new `BGFXMemory` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static BGFXMemory.Buffer malloc(int capacity) Returns a new `BGFXMemory.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static BGFXMemory.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static BGFXMemory malloc(MemoryStack stack) Returns a new `BGFXMemory` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static BGFXMemory malloc(MemoryStack stack)

Returns a new BGFXMemory instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static BGFXMemory.Buffer malloc(int capacity, MemoryStack stack) Returns a new `BGFXMemory.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static BGFXMemory mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static BGFXMemory mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static BGFXMemory mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static BGFXMemory mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static BGFXMemory.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static BGFXMemory.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static BGFXMemory.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static BGFXMemory.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

ndata	back to summary
public static ByteBuffer ndata(long struct) Unsafe version of `data`.

ndata	back to summary
public static void ndata(long struct, ByteBuffer value) Unsafe version of `data`.

nsize	back to summary
public static int nsize(long struct) Unsafe version of `size`.

nsize	back to summary
public static void nsize(long struct, int value) Sets the specified value to the `size` field of the specified `struct`.

set	back to summary
public BGFXMemory set(BGFXMemory src) Copies the specified struct data to this struct. Parameters src:BGFXMemory the source struct Returns:BGFXMemory this struct

set

back to summary

public BGFXMemory set(BGFXMemory src)

Copies the specified struct data to this struct.

Parameters

src:BGFXMemory: the source struct

Returns:BGFXMemory

this struct

size	back to summary
public int size() data size Annotations @NativeType:uint32_t

size

back to summary

public int size()

data size

Annotations

@NativeType:uint32_t

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

validate back to summary

validate	back to summary
public static void validate(long struct) Validates pointer members that should not be `NULL`. Parameters struct:long the struct to validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

org.lwjgl.bgfx back to summary

public Class BGFXMemory.Buffer

Class Inheritance

extends StructBuffer<BGFXMemory, BGFXMemory.Buffer>
implements NativeResource

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of BGFXMemory structs.

Field Summary

Modifier and Type	Field and Description
private static final BGFXMemory	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `BGFXMemory.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
public ByteBuffer	Returns: a `ByteBuffer` view of the data pointed to by the `BGFXMemory#data` field. data()
public BGFXMemory.Buffer	data(ByteBuffer value) Sets the address of the specified `ByteBuffer` to the `BGFXMemory#data` field.
protected BGFXMemory	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected BGFXMemory.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `BGFXMemory#size` field. size()

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final BGFXMemory ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `BGFXMemory.Buffer` instance backed by the specified container. Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by `BGFXMemory#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new BGFXMemory.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by BGFXMemory#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

data	back to summary
public ByteBuffer data() Returns:ByteBuffer a `ByteBuffer` view of the data pointed to by the `BGFXMemory#data` field. Annotations @NativeType:uint8_t *