Package org.lwjgl.bgfx

Class BGFXTransientIndexBuffer

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<BGFXTransientIndexBuffer>

org.lwjgl.bgfx.BGFXTransientIndexBuffer

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class BGFXTransientIndexBuffer
extends Struct<BGFXTransientIndexBuffer>
implements NativeResource

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BGFXTransientIndexBuffer.Buffer	An array of BGFXTransientIndexBuffer structs.

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DATA	The struct member offsets.
static final int	HANDLE	The struct member offsets.
static final int	ISINDEX16	The struct member offsets.
static final int	SIZE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STARTINDEX	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
BGFXTransientIndexBuffer(ByteBuffer container)	Creates a BGFXTransientIndexBuffer instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static BGFXTransientIndexBuffer	calloc()	Returns a new BGFXTransientIndexBuffer instance allocated with memCalloc.
static BGFXTransientIndexBuffer.Buffer	calloc(int capacity)	Returns a new BGFXTransientIndexBuffer.Buffer instance allocated with memCalloc.
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.
static BGFXTransientIndexBuffer	calloc(MemoryStack stack)	Returns a new BGFXTransientIndexBuffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static BGFXTransientIndexBuffer	callocStack()	Deprecated.
static BGFXTransientIndexBuffer.Buffer	callocStack(int capacity)	Deprecated.
static BGFXTransientIndexBuffer.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static BGFXTransientIndexBuffer	callocStack(MemoryStack stack)	Deprecated.
static BGFXTransientIndexBuffer	create()	Returns a new BGFXTransientIndexBuffer instance allocated with BufferUtils.
static BGFXTransientIndexBuffer.Buffer	create(int capacity)	Returns a new BGFXTransientIndexBuffer.Buffer instance allocated with BufferUtils.
static BGFXTransientIndexBuffer	create(long address)	Returns a new BGFXTransientIndexBuffer instance for the specified memory address.
static BGFXTransientIndexBuffer.Buffer	create(long address, int capacity)	Create a BGFXTransientIndexBuffer.Buffer instance at the specified memory.
static @Nullable BGFXTransientIndexBuffer	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable BGFXTransientIndexBuffer.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
ByteBuffer	data()
BGFXTransientIndexBuffer	data(ByteBuffer value)	Sets the address of the specified ByteBuffer to the data field.
short	handle()
BGFXTransientIndexBuffer	handle(short value)	Sets the specified value to the handle field.
boolean	isIndex16()
BGFXTransientIndexBuffer	isIndex16(boolean value)	Sets the specified value to the isIndex16 field.
static BGFXTransientIndexBuffer	malloc()	Returns a new BGFXTransientIndexBuffer instance allocated with memAlloc.
static BGFXTransientIndexBuffer.Buffer	malloc(int capacity)	Returns a new BGFXTransientIndexBuffer.Buffer instance allocated with memAlloc.
static BGFXTransientIndexBuffer.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new BGFXTransientIndexBuffer.Buffer instance allocated on the specified MemoryStack.
static BGFXTransientIndexBuffer	malloc(MemoryStack stack)	Returns a new BGFXTransientIndexBuffer instance allocated on the specified MemoryStack.
static BGFXTransientIndexBuffer	mallocStack()	Deprecated.
static BGFXTransientIndexBuffer.Buffer	mallocStack(int capacity)	Deprecated.
static BGFXTransientIndexBuffer.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static BGFXTransientIndexBuffer	mallocStack(MemoryStack stack)	Deprecated.
static ByteBuffer	ndata(long struct)	Unsafe version of data.
static void	ndata(long struct, ByteBuffer value)	Unsafe version of data.
static short	nhandle(long struct)	Unsafe version of handle().
static void	nhandle(long struct, short value)	Unsafe version of handle.
static boolean	nisIndex16(long struct)	Unsafe version of isIndex16().
static void	nisIndex16(long struct, boolean value)	Unsafe version of isIndex16.
static int	nsize(long struct)	Unsafe version of size().
static void	nsize(long struct, int value)	Sets the specified value to the size field of the specified struct.
static int	nstartIndex(long struct)	Unsafe version of startIndex().
static void	nstartIndex(long struct, int value)	Unsafe version of startIndex.
BGFXTransientIndexBuffer	set(ByteBuffer data, int startIndex, short handle, boolean isIndex16)	Initializes this struct with the specified values.
BGFXTransientIndexBuffer	set(BGFXTransientIndexBuffer src)	Copies the specified struct data to this struct.
int	size()
int	sizeof()	Returns sizeof(struct).
int	startIndex()
BGFXTransientIndexBuffer	startIndex(int value)	Sets the specified value to the startIndex field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

DATA

public static final int DATA

The struct member offsets.

SIZE

public static final int SIZE

The struct member offsets.

STARTINDEX

public static final int STARTINDEX

The struct member offsets.

HANDLE

public static final int HANDLE

The struct member offsets.

ISINDEX16

public static final int ISINDEX16

The struct member offsets.

Constructor Details

BGFXTransientIndexBuffer

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<BGFXTransientIndexBuffer>

data

public ByteBuffer data()

Returns:

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

size

public int size()

Returns:

the value of the size field.

startIndex

public int startIndex()

Returns:

the value of the startIndex field.

handle

public short handle()

Returns:

the value of the handle field.

isIndex16

public boolean isIndex16()

Returns:

the value of the isIndex16 field.

data

public BGFXTransientIndexBuffer data(ByteBuffer value)

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

startIndex

public BGFXTransientIndexBuffer startIndex(int value)

Sets the specified value to the startIndex field.

handle

public BGFXTransientIndexBuffer handle(short value)

Sets the specified value to the handle field.

isIndex16

public BGFXTransientIndexBuffer isIndex16(boolean value)

Sets the specified value to the isIndex16 field.

set

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

Initializes this struct with the specified values.

set

public BGFXTransientIndexBuffer set(BGFXTransientIndexBuffer src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static BGFXTransientIndexBuffer malloc()

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

calloc

public static BGFXTransientIndexBuffer calloc()

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

create

public static BGFXTransientIndexBuffer create()

Returns a new BGFXTransientIndexBuffer instance allocated with BufferUtils.

create

public static BGFXTransientIndexBuffer create(long address)

Returns a new BGFXTransientIndexBuffer instance for the specified memory address.

createSafe

public static @Nullable BGFXTransientIndexBuffer createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static BGFXTransientIndexBuffer.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static BGFXTransientIndexBuffer.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static BGFXTransientIndexBuffer.Buffer create(int capacity)

Returns a new BGFXTransientIndexBuffer.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a BGFXTransientIndexBuffer.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static BGFXTransientIndexBuffer mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static BGFXTransientIndexBuffer callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static BGFXTransientIndexBuffer mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static BGFXTransientIndexBuffer callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static BGFXTransientIndexBuffer.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static BGFXTransientIndexBuffer.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static BGFXTransientIndexBuffer.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static BGFXTransientIndexBuffer.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static BGFXTransientIndexBuffer malloc(MemoryStack stack)

Returns a new BGFXTransientIndexBuffer instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

ndata

public static ByteBuffer ndata(long struct)

Unsafe version of data.

nsize

public static int nsize(long struct)

Unsafe version of size().

nstartIndex

public static int nstartIndex(long struct)

Unsafe version of startIndex().

nhandle

public static short nhandle(long struct)

Unsafe version of handle().

nisIndex16

public static boolean nisIndex16(long struct)

Unsafe version of isIndex16().

ndata

public static void ndata(long struct,
 ByteBuffer value)

Unsafe version of data.

nsize

public static void nsize(long struct,
 int value)

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

nstartIndex

public static void nstartIndex(long struct,
 int value)

Unsafe version of startIndex.

nhandle

public static void nhandle(long struct,
 short value)

Unsafe version of handle.

nisIndex16

public static void nisIndex16(long struct,
 boolean value)

Unsafe version of isIndex16.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate