Top Description Inners Fields Constructors Methods
org.lwjgl.bgfx

public Class BGFXTransientIndexBuffer

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

Layout


struct bgfx_transient_index_buffer_t {
    uint8_t * data;
    uint32_t size;
    uint32_t startIndex;
    bgfx_index_buffer_handle_t handle;
    bool isIndex16;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
BGFXTransientIndexBuffer.Buffer

An array of BGFXTransientIndexBuffer structs.

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
ISINDEX16

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
STARTINDEX

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
BGFXTransientIndexBuffer(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static BGFXTransientIndexBuffer
calloc()

Returns a new BGFXTransientIndexBuffer instance allocated with memCalloc.

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

Returns a new BGFXTransientIndexBuffer.Buffer instance allocated with memCalloc.

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

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

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

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

public static BGFXTransientIndexBuffer
callocStack()

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

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

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

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

Returns a new BGFXTransientIndexBuffer instance allocated with BufferUtils.

public static BGFXTransientIndexBuffer
create(long address)

Returns a new BGFXTransientIndexBuffer instance for the specified memory address.

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

Returns a new BGFXTransientIndexBuffer.Buffer instance allocated with BufferUtils.

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

Create a BGFXTransientIndexBuffer.Buffer instance at the specified memory.

public static BGFXTransientIndexBuffer
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
data()

pointer to data

public BGFXTransientIndexBuffer
data(ByteBuffer value)

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

public short
handle()

index buffer handle

public BGFXTransientIndexBuffer
handle(short value)

Sets the specified value to the handle field.

public boolean
isIndex16()

index buffer format is 16-bits if true, otherwise it is 32-bit

public BGFXTransientIndexBuffer
isIndex16(boolean value)

Sets the specified value to the isIndex16 field.

public static BGFXTransientIndexBuffer
malloc()

Returns a new BGFXTransientIndexBuffer instance allocated with memAlloc.

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

Returns a new BGFXTransientIndexBuffer.Buffer instance allocated with memAlloc.

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

Returns a new BGFXTransientIndexBuffer instance allocated on the specified MemoryStack.

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

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

public static BGFXTransientIndexBuffer
mallocStack()

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXTransientIndexBuffer.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 boolean
nisIndex16(long struct)

Unsafe version of isIndex16.

public static void
nisIndex16(long struct, boolean value)

Unsafe version of isIndex16.

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 int
nstartIndex(long struct)

Unsafe version of startIndex.

public static void
nstartIndex(long struct, int value)

Unsafe version of startIndex.

public BGFXTransientIndexBuffer
set(ByteBuffer data, int startIndex, short handle, boolean isIndex16)

Initializes this struct with the specified values.

public BGFXTransientIndexBuffer

Returns:

this struct
set(BGFXTransientIndexBuffer
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 int
startIndex()

first index

public BGFXTransientIndexBuffer
startIndex(int value)

Sets the specified value to the startIndex 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.

ISINDEX16back to summary
public static final int ISINDEX16

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.

STARTINDEXback to summary
public static final int STARTINDEX

The struct member offsets.

Constructor Detail

BGFXTransientIndexBufferback to summary
protected BGFXTransientIndexBuffer(long address, ByteBuffer container)
BGFXTransientIndexBufferback to summary
public BGFXTransientIndexBuffer(ByteBuffer container)

Creates a BGFXTransientIndexBuffer 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 BGFXTransientIndexBuffer calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static BGFXTransientIndexBuffer calloc(MemoryStack stack)

Returns a new BGFXTransientIndexBuffer 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 BGFXTransientIndexBuffer.Buffer calloc(int capacity, MemoryStack stack)

Returns a new BGFXTransientIndexBuffer.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 BGFXTransientIndexBuffer callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static BGFXTransientIndexBuffer.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 BGFXTransientIndexBuffer 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 BGFXTransientIndexBuffer create()

Returns a new BGFXTransientIndexBuffer instance allocated with BufferUtils.

createback to summary
public static BGFXTransientIndexBuffer create(long address)

Returns a new BGFXTransientIndexBuffer instance for the specified memory address.

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

Returns a new BGFXTransientIndexBuffer.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a BGFXTransientIndexBuffer.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static BGFXTransientIndexBuffer createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static BGFXTransientIndexBuffer.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 BGFXTransientIndexBuffer data(ByteBuffer value)

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

handleback to summary
public short handle()

index buffer handle

Annotations
@NativeType:bgfx_index_buffer_handle_t
handleback to summary
public BGFXTransientIndexBuffer handle(short value)

Sets the specified value to the handle field.

isIndex16back to summary
public boolean isIndex16()

index buffer format is 16-bits if true, otherwise it is 32-bit

Annotations
@NativeType:bool
isIndex16back to summary
public BGFXTransientIndexBuffer isIndex16(boolean value)

Sets the specified value to the isIndex16 field.

mallocback to summary
public static BGFXTransientIndexBuffer malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static BGFXTransientIndexBuffer malloc(MemoryStack stack)

Returns a new BGFXTransientIndexBuffer instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new BGFXTransientIndexBuffer.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 BGFXTransientIndexBuffer mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static BGFXTransientIndexBuffer.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.

nisIndex16back to summary
public static boolean nisIndex16(long struct)

Unsafe version of isIndex16.

nisIndex16back to summary
public static void nisIndex16(long struct, boolean value)

Unsafe version of isIndex16.

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.

nstartIndexback to summary
public static int nstartIndex(long struct)

Unsafe version of startIndex.

nstartIndexback to summary
public static void nstartIndex(long struct, int value)

Unsafe version of startIndex.

setback to summary
public BGFXTransientIndexBuffer set(ByteBuffer data, int startIndex, short handle, boolean isIndex16)

Initializes this struct with the specified values.

setback to summary
public BGFXTransientIndexBuffer set(BGFXTransientIndexBuffer src)

Copies the specified struct data to this struct.

Parameters
src:BGFXTransientIndexBuffer

the source struct

Returns:BGFXTransientIndexBuffer

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
startIndexback to summary
public int startIndex()

first index

Annotations
@NativeType:uint32_t
startIndexback to summary
public BGFXTransientIndexBuffer startIndex(int value)

Sets the specified value to the startIndex 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 BGFXTransientIndexBuffer.Buffer

extends StructBuffer<BGFXTransientIndexBuffer, BGFXTransientIndexBuffer.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of BGFXTransientIndexBuffer structs.

Field Summary

Modifier and TypeField and Description
private static final BGFXTransientIndexBuffer
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new BGFXTransientIndexBuffer.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 BGFXTransientIndexBuffer#data field.
data()

public BGFXTransientIndexBuffer.Buffer
data(ByteBuffer value)

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

protected BGFXTransientIndexBuffer
getElementFactory()

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

public short

Returns:

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

public BGFXTransientIndexBuffer.Buffer
handle(short value)

Sets the specified value to the BGFXTransientIndexBuffer#handle field.

public boolean

Returns:

the value of the BGFXTransientIndexBuffer#isIndex16 field.
isIndex16()

public BGFXTransientIndexBuffer.Buffer
isIndex16(boolean value)

Sets the specified value to the BGFXTransientIndexBuffer#isIndex16 field.

protected BGFXTransientIndexBuffer.Buffer
self()

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

public int

Returns:

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

public int

Returns:

the value of the BGFXTransientIndexBuffer#startIndex field.
startIndex()

public BGFXTransientIndexBuffer.Buffer
startIndex(int value)

Sets the specified value to the BGFXTransientIndexBuffer#startIndex field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final BGFXTransientIndexBuffer ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new BGFXTransientIndexBuffer.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 BGFXTransientIndexBuffer#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 BGFXTransientIndexBuffer#data field.

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

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

getElementFactoryback to summary
protected BGFXTransientIndexBuffer getElementFactory()

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

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

the value of the BGFXTransientIndexBuffer#handle field.

Annotations
@NativeType:bgfx_index_buffer_handle_t
handleback to summary
public BGFXTransientIndexBuffer.Buffer handle(short value)

Sets the specified value to the BGFXTransientIndexBuffer#handle field.

isIndex16back to summary
public boolean isIndex16()
Returns:boolean

the value of the BGFXTransientIndexBuffer#isIndex16 field.

Annotations
@NativeType:bool
isIndex16back to summary
public BGFXTransientIndexBuffer.Buffer isIndex16(boolean value)

Sets the specified value to the BGFXTransientIndexBuffer#isIndex16 field.

selfback to summary
protected BGFXTransientIndexBuffer.Buffer self()

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

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

the value of the BGFXTransientIndexBuffer#size field.

Annotations
@NativeType:uint32_t
startIndexback to summary
public int startIndex()
Returns:int

the value of the BGFXTransientIndexBuffer#startIndex field.

Annotations
@NativeType:uint32_t
startIndexback to summary
public BGFXTransientIndexBuffer.Buffer startIndex(int value)

Sets the specified value to the BGFXTransientIndexBuffer#startIndex field.