Top Description Inners Fields Constructors Methods
org.lwjgl.bgfx

public Class BGFXInstanceDataBuffer

extends Struct<BGFXInstanceDataBuffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct bgfx_instance_data_buffer_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Instance data buffer info.

Layout


struct bgfx_instance_data_buffer_t {
    uint8_t * data;
    uint32_t size;
    uint32_t offset;
    uint32_t num;
    uint16_t stride;
    bgfx_vertex_buffer_handle_t handle;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField 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
HANDLE

The struct member offsets.

public static final int
NUM

The struct member offsets.

public static final int
OFFSET

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STRIDE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
BGFXInstanceDataBuffer(long address, ByteBuffer container)

public
BGFXInstanceDataBuffer(ByteBuffer container)

Creates a BGFXInstanceDataBuffer instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static BGFXInstanceDataBuffer
calloc()

Returns a new BGFXInstanceDataBuffer instance allocated with memCalloc.

public static BGFXInstanceDataBuffer.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new BGFXInstanceDataBuffer.Buffer instance allocated with memCalloc.

public static BGFXInstanceDataBuffer
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static BGFXInstanceDataBuffer.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static BGFXInstanceDataBuffer
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXInstanceDataBuffer
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXInstanceDataBuffer.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXInstanceDataBuffer.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected BGFXInstanceDataBuffer
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 BGFXInstanceDataBuffer
create()

Returns a new BGFXInstanceDataBuffer instance allocated with BufferUtils.

public static BGFXInstanceDataBuffer
create(long address)

Returns a new BGFXInstanceDataBuffer instance for the specified memory address.

public static BGFXInstanceDataBuffer.Buffer
create(int
the buffer capacity
capacity
)

Returns a new BGFXInstanceDataBuffer.Buffer instance allocated with BufferUtils.

public static BGFXInstanceDataBuffer.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a BGFXInstanceDataBuffer.Buffer instance at the specified memory.

public static BGFXInstanceDataBuffer
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
data()

pointer to data

public BGFXInstanceDataBuffer
data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the data field.

public short
handle()

vertex buffer object handle

public BGFXInstanceDataBuffer
handle(short value)

Sets the specified value to the handle field.

public static BGFXInstanceDataBuffer
malloc()

Returns a new BGFXInstanceDataBuffer instance allocated with memAlloc.

public static BGFXInstanceDataBuffer.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new BGFXInstanceDataBuffer.Buffer instance allocated with memAlloc.

public static BGFXInstanceDataBuffer
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new BGFXInstanceDataBuffer instance allocated on the specified MemoryStack.

public static BGFXInstanceDataBuffer.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static BGFXInstanceDataBuffer
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXInstanceDataBuffer
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXInstanceDataBuffer.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXInstanceDataBuffer.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 short
nhandle(long struct)

Unsafe version of handle.

public static void
nhandle(long struct, short value)

Unsafe version of handle.

public static int
nnum(long struct)

Unsafe version of num.

public static void
nnum(long struct, int value)

Unsafe version of num.

public static int
noffset(long struct)

Unsafe version of offset.

public static void
noffset(long struct, int value)

Unsafe version of offset.

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 static short
nstride(long struct)

Unsafe version of stride.

public static void
nstride(long struct, short value)

Unsafe version of stride.

public int
num()

number of instances

public BGFXInstanceDataBuffer
num(int value)

Sets the specified value to the num field.

public int
offset()

offset in vertex buffer

public BGFXInstanceDataBuffer
offset(int value)

Sets the specified value to the offset field.

public BGFXInstanceDataBuffer
set(ByteBuffer data, int offset, int num, short stride, short handle)

Initializes this struct with the specified values.

public BGFXInstanceDataBuffer

Returns:

this struct
set
(BGFXInstanceDataBuffer
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 short
stride()

vertex stride

public BGFXInstanceDataBuffer
stride(short value)

Sets the specified value to the stride field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DATAback to summary
public static final int DATA

The struct member offsets.

HANDLEback to summary
public static final int HANDLE

The struct member offsets.

NUMback to summary
public static final int NUM

The struct member offsets.

OFFSETback to summary
public static final int OFFSET

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STRIDEback to summary
public static final int STRIDE

The struct member offsets.

Constructor Detail

BGFXInstanceDataBufferback to summary
protected BGFXInstanceDataBuffer(long address, ByteBuffer container)
BGFXInstanceDataBufferback to summary
public BGFXInstanceDataBuffer(ByteBuffer container)

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

callocback to summary
public static BGFXInstanceDataBuffer calloc()

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

callocback to summary
public static BGFXInstanceDataBuffer.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static BGFXInstanceDataBuffer calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static BGFXInstanceDataBuffer.Buffer calloc(int capacity, MemoryStack stack)

Returns a new BGFXInstanceDataBuffer.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

callocStackback to summary
public static BGFXInstanceDataBuffer callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static BGFXInstanceDataBuffer callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static BGFXInstanceDataBuffer.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static BGFXInstanceDataBuffer.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected BGFXInstanceDataBuffer 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
createback to summary
public static BGFXInstanceDataBuffer create()

Returns a new BGFXInstanceDataBuffer instance allocated with BufferUtils.

createback to summary
public static BGFXInstanceDataBuffer create(long address)

Returns a new BGFXInstanceDataBuffer instance for the specified memory address.

createback to summary
public static BGFXInstanceDataBuffer.Buffer create(int capacity)

Returns a new BGFXInstanceDataBuffer.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static BGFXInstanceDataBuffer.Buffer create(long address, int capacity)

Create a BGFXInstanceDataBuffer.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static BGFXInstanceDataBuffer createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static BGFXInstanceDataBuffer.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
databack to summary
public ByteBuffer data()

pointer to data

Annotations
@NativeType:uint8_t *
databack to summary
public BGFXInstanceDataBuffer data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the data field.

handleback to summary
public short handle()

vertex buffer object handle

Annotations
@NativeType:bgfx_vertex_buffer_handle_t
handleback to summary
public BGFXInstanceDataBuffer handle(short value)

Sets the specified value to the handle field.

mallocback to summary
public static BGFXInstanceDataBuffer malloc()

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

mallocback to summary
public static BGFXInstanceDataBuffer.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static BGFXInstanceDataBuffer malloc(MemoryStack stack)

Returns a new BGFXInstanceDataBuffer instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static BGFXInstanceDataBuffer.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static BGFXInstanceDataBuffer mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static BGFXInstanceDataBuffer mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static BGFXInstanceDataBuffer.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static BGFXInstanceDataBuffer.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
ndataback to summary
public static ByteBuffer ndata(long struct)

Unsafe version of data.

ndataback to summary
public static void ndata(long struct, ByteBuffer value)

Unsafe version of data.

nhandleback to summary
public static short nhandle(long struct)

Unsafe version of handle.

nhandleback to summary
public static void nhandle(long struct, short value)

Unsafe version of handle.

nnumback to summary
public static int nnum(long struct)

Unsafe version of num.

nnumback to summary
public static void nnum(long struct, int value)

Unsafe version of num.

noffsetback to summary
public static int noffset(long struct)

Unsafe version of offset.

noffsetback to summary
public static void noffset(long struct, int value)

Unsafe version of offset.

nsizeback to summary
public static int nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, int value)

Sets the specified value to the size field of the specified struct.

nstrideback to summary
public static short nstride(long struct)

Unsafe version of stride.

nstrideback to summary
public static void nstride(long struct, short value)

Unsafe version of stride.

numback to summary
public int num()

number of instances

Annotations
@NativeType:uint32_t
numback to summary
public BGFXInstanceDataBuffer num(int value)

Sets the specified value to the num field.

offsetback to summary
public int offset()

offset in vertex buffer

Annotations
@NativeType:uint32_t
offsetback to summary
public BGFXInstanceDataBuffer offset(int value)

Sets the specified value to the offset field.

setback to summary
public BGFXInstanceDataBuffer set(ByteBuffer data, int offset, int num, short stride, short handle)

Initializes this struct with the specified values.

setback to summary
public BGFXInstanceDataBuffer set(BGFXInstanceDataBuffer src)

Copies the specified struct data to this struct.

Parameters
src:BGFXInstanceDataBuffer

the source struct

Returns:BGFXInstanceDataBuffer

this struct

sizeback to summary
public int size()

data size

Annotations
@NativeType:uint32_t
sizeofback to summary
public int sizeof()

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

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

Returns sizeof(struct).

Annotations
@Override
strideback to summary
public short stride()

vertex stride

Annotations
@NativeType:uint16_t
strideback to summary
public BGFXInstanceDataBuffer stride(short value)

Sets the specified value to the stride field.

validateback to summary
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 BGFXInstanceDataBuffer.Buffer

extends StructBuffer<BGFXInstanceDataBuffer, BGFXInstanceDataBuffer.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of BGFXInstanceDataBuffer structs.

Field Summary

Modifier and TypeField and Description
private static final BGFXInstanceDataBuffer

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new BGFXInstanceDataBuffer.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 TypeMethod and Description
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the BGFXInstanceDataBuffer#data field.
data
()

public BGFXInstanceDataBuffer.Buffer
data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the BGFXInstanceDataBuffer#data field.

protected BGFXInstanceDataBuffer
public short

Returns:

the value of the BGFXInstanceDataBuffer#handle field.
handle
()

public BGFXInstanceDataBuffer.Buffer
handle(short value)

Sets the specified value to the BGFXInstanceDataBuffer#handle field.

public int

Returns:

the value of the BGFXInstanceDataBuffer#num field.
num
()

public BGFXInstanceDataBuffer.Buffer
num(int value)

Sets the specified value to the BGFXInstanceDataBuffer#num field.

public int

Returns:

the value of the BGFXInstanceDataBuffer#offset field.
offset
()

public BGFXInstanceDataBuffer.Buffer
offset(int value)

Sets the specified value to the BGFXInstanceDataBuffer#offset field.

protected BGFXInstanceDataBuffer.Buffer
public int

Returns:

the value of the BGFXInstanceDataBuffer#size field.
size
()

public short

Returns:

the value of the BGFXInstanceDataBuffer#stride field.
stride
()

public BGFXInstanceDataBuffer.Buffer
stride(short value)

Sets the specified value to the BGFXInstanceDataBuffer#stride field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final BGFXInstanceDataBuffer ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new BGFXInstanceDataBuffer.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 BGFXInstanceDataBuffer#SIZEOF, and its mark will be undefined.

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

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

Method Detail

databack to summary
public ByteBuffer data()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the BGFXInstanceDataBuffer#data field.

Annotations
@NativeType:uint8_t *
databack to summary
public BGFXInstanceDataBuffer.Buffer data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the BGFXInstanceDataBuffer#data field.

getElementFactoryback to summary
protected BGFXInstanceDataBuffer getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
handleback to summary
public short handle()
Returns:short

the value of the BGFXInstanceDataBuffer#handle field.

Annotations
@NativeType:bgfx_vertex_buffer_handle_t
handleback to summary
public BGFXInstanceDataBuffer.Buffer handle(short value)

Sets the specified value to the BGFXInstanceDataBuffer#handle field.

numback to summary
public int num()
Returns:int

the value of the BGFXInstanceDataBuffer#num field.

Annotations
@NativeType:uint32_t
numback to summary
public BGFXInstanceDataBuffer.Buffer num(int value)

Sets the specified value to the BGFXInstanceDataBuffer#num field.

offsetback to summary
public int offset()
Returns:int

the value of the BGFXInstanceDataBuffer#offset field.

Annotations
@NativeType:uint32_t
offsetback to summary
public BGFXInstanceDataBuffer.Buffer offset(int value)

Sets the specified value to the BGFXInstanceDataBuffer#offset field.

selfback to summary
protected BGFXInstanceDataBuffer.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sizeback to summary
public int size()
Returns:int

the value of the BGFXInstanceDataBuffer#size field.

Annotations
@NativeType:uint32_t
strideback to summary
public short stride()
Returns:short

the value of the BGFXInstanceDataBuffer#stride field.

Annotations
@NativeType:uint16_t
strideback to summary
public BGFXInstanceDataBuffer.Buffer stride(short value)

Sets the specified value to the BGFXInstanceDataBuffer#stride field.