Package org.lwjgl.bgfx

Class BGFXInstanceDataBuffer

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<BGFXInstanceDataBuffer>

org.lwjgl.bgfx.BGFXInstanceDataBuffer

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class BGFXInstanceDataBuffer
extends Struct<BGFXInstanceDataBuffer>
implements NativeResource

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 Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BGFXInstanceDataBuffer.Buffer	An array of BGFXInstanceDataBuffer 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	NUM	The struct member offsets.
static final int	OFFSET	The struct member offsets.
static final int	SIZE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STRIDE	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
BGFXInstanceDataBuffer(ByteBuffer container)	Creates a BGFXInstanceDataBuffer instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static BGFXInstanceDataBuffer	calloc()	Returns a new BGFXInstanceDataBuffer instance allocated with memCalloc.
static BGFXInstanceDataBuffer.Buffer	calloc(int capacity)	Returns a new BGFXInstanceDataBuffer.Buffer instance allocated with memCalloc.
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.
static BGFXInstanceDataBuffer	calloc(MemoryStack stack)	Returns a new BGFXInstanceDataBuffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static BGFXInstanceDataBuffer	callocStack()	Deprecated.
static BGFXInstanceDataBuffer.Buffer	callocStack(int capacity)	Deprecated.
static BGFXInstanceDataBuffer.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static BGFXInstanceDataBuffer	callocStack(MemoryStack stack)	Deprecated.
static BGFXInstanceDataBuffer	create()	Returns a new BGFXInstanceDataBuffer instance allocated with BufferUtils.
static BGFXInstanceDataBuffer.Buffer	create(int capacity)	Returns a new BGFXInstanceDataBuffer.Buffer instance allocated with BufferUtils.
static BGFXInstanceDataBuffer	create(long address)	Returns a new BGFXInstanceDataBuffer instance for the specified memory address.
static BGFXInstanceDataBuffer.Buffer	create(long address, int capacity)	Create a BGFXInstanceDataBuffer.Buffer instance at the specified memory.
static BGFXInstanceDataBuffer	createSafe(long address)	Like create, but returns null if address is NULL.
static BGFXInstanceDataBuffer.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
ByteBuffer	data()	pointer to data
BGFXInstanceDataBuffer	data(ByteBuffer value)	Sets the address of the specified ByteBuffer to the data() field.
short	handle()	vertex buffer object handle
BGFXInstanceDataBuffer	handle(short value)	Sets the specified value to the handle() field.
static BGFXInstanceDataBuffer	malloc()	Returns a new BGFXInstanceDataBuffer instance allocated with memAlloc.
static BGFXInstanceDataBuffer.Buffer	malloc(int capacity)	Returns a new BGFXInstanceDataBuffer.Buffer instance allocated with memAlloc.
static BGFXInstanceDataBuffer.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new BGFXInstanceDataBuffer.Buffer instance allocated on the specified MemoryStack.
static BGFXInstanceDataBuffer	malloc(MemoryStack stack)	Returns a new BGFXInstanceDataBuffer instance allocated on the specified MemoryStack.
static BGFXInstanceDataBuffer	mallocStack()	Deprecated.
static BGFXInstanceDataBuffer.Buffer	mallocStack(int capacity)	Deprecated.
static BGFXInstanceDataBuffer.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static BGFXInstanceDataBuffer	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 int	nnum(long struct)	Unsafe version of num().
static void	nnum(long struct, int value)	Unsafe version of num.
static int	noffset(long struct)	Unsafe version of offset().
static void	noffset(long struct, int value)	Unsafe version of offset.
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 short	nstride(long struct)	Unsafe version of stride().
static void	nstride(long struct, short value)	Unsafe version of stride.
int	num()	number of instances
BGFXInstanceDataBuffer	num(int value)	Sets the specified value to the num() field.
int	offset()	offset in vertex buffer
BGFXInstanceDataBuffer	offset(int value)	Sets the specified value to the offset() field.
BGFXInstanceDataBuffer	set(ByteBuffer data, int offset, int num, short stride, short handle)	Initializes this struct with the specified values.
BGFXInstanceDataBuffer	set(BGFXInstanceDataBuffer src)	Copies the specified struct data to this struct.
int	size()	data size
int	sizeof()	Returns sizeof(struct).
short	stride()	vertex stride
BGFXInstanceDataBuffer	stride(short value)	Sets the specified value to the stride() 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

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.

OFFSET

public static final int OFFSET

The struct member offsets.

NUM

public static final int NUM

The struct member offsets.

STRIDE

public static final int STRIDE

The struct member offsets.

HANDLE

public static final int HANDLE

The struct member offsets.

Constructor Details

BGFXInstanceDataBuffer

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<BGFXInstanceDataBuffer>

data

public ByteBuffer data()

pointer to data

size

public int size()

data size

offset

public int offset()

offset in vertex buffer

num

public int num()

number of instances

stride

public short stride()

vertex stride

handle

public short handle()

vertex buffer object handle

data

public BGFXInstanceDataBuffer data(ByteBuffer value)

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

offset

public BGFXInstanceDataBuffer offset(int value)

Sets the specified value to the offset() field.

num

public BGFXInstanceDataBuffer num(int value)

Sets the specified value to the num() field.

stride

public BGFXInstanceDataBuffer stride(short value)

Sets the specified value to the stride() field.

handle

public BGFXInstanceDataBuffer handle(short value)

Sets the specified value to the handle() field.

set

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

Initializes this struct with the specified values.

set

public BGFXInstanceDataBuffer set(BGFXInstanceDataBuffer src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static BGFXInstanceDataBuffer malloc()

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

calloc

public static BGFXInstanceDataBuffer calloc()

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

create

public static BGFXInstanceDataBuffer create()

Returns a new BGFXInstanceDataBuffer instance allocated with BufferUtils.

create

public static BGFXInstanceDataBuffer create(long address)

Returns a new BGFXInstanceDataBuffer instance for the specified memory address.

createSafe

@Nullable
public static BGFXInstanceDataBuffer createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static BGFXInstanceDataBuffer.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static BGFXInstanceDataBuffer.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static BGFXInstanceDataBuffer.Buffer create(int capacity)

Returns a new BGFXInstanceDataBuffer.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a BGFXInstanceDataBuffer.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static BGFXInstanceDataBuffer mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static BGFXInstanceDataBuffer callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static BGFXInstanceDataBuffer mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static BGFXInstanceDataBuffer callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static BGFXInstanceDataBuffer malloc(MemoryStack stack)

Returns a new BGFXInstanceDataBuffer instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - 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().

noffset

public static int noffset(long struct)

Unsafe version of offset().

nnum

public static int nnum(long struct)

Unsafe version of num().

nstride

public static short nstride(long struct)

Unsafe version of stride().

nhandle

public static short nhandle(long struct)

Unsafe version of handle().

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.

noffset

public static void noffset(long struct,
 int value)

Unsafe version of offset.

nnum

public static void nnum(long struct,
 int value)

Unsafe version of num.

nstride

public static void nstride(long struct,
 short value)

Unsafe version of stride.

nhandle

public static void nhandle(long struct,
 short value)

Unsafe version of handle.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate