BGFXInstanceDataBuffer (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.bgfx.BGFXInstanceDataBuffer

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class BGFXInstanceDataBuffer
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Instance data buffer info.
Member documentation
- data – pointer to data
- size – data size
- offset – offset in vertex buffer
- num – number of instances
- stride – vertex stride
- handle – vertex buffer object handle
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 and Description

static class BGFXInstanceDataBuffer.Buffer
An array of BGFXInstanceDataBuffer structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`BGFXInstanceDataBuffer.Buffer` An array of `BGFXInstanceDataBuffer` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DATA` The struct member offsets.
`static int`	`HANDLE` The struct member offsets.
`static int`	`NUM` The struct member offsets.
`static int`	`OFFSET` The struct member offsets.
`static int`	`SIZE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static 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 and Description
`BGFXInstanceDataBuffer(java.nio.ByteBuffer container)` Creates a `BGFXInstanceDataBuffer` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`callocStack()` Returns a new `BGFXInstanceDataBuffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXInstanceDataBuffer.Buffer`	`callocStack(int capacity)` Returns a new `BGFXInstanceDataBuffer.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXInstanceDataBuffer.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXInstanceDataBuffer.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static BGFXInstanceDataBuffer`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXInstanceDataBuffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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`.
`java.nio.ByteBuffer`	`data()` Returns a `ByteBuffer` view of the data pointed to by the `data` field.
`BGFXInstanceDataBuffer`	`data(java.nio.ByteBuffer value)` Sets the address of the specified `ByteBuffer` to the `data` field.
`short`	`handle()` Returns the value of the `handle` field.
`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`	`mallocStack()` Returns a new `BGFXInstanceDataBuffer` instance allocated on the thread-local `MemoryStack`.
`static BGFXInstanceDataBuffer.Buffer`	`mallocStack(int capacity)` Returns a new `BGFXInstanceDataBuffer.Buffer` instance allocated on the thread-local `MemoryStack`.
`static BGFXInstanceDataBuffer.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXInstanceDataBuffer.Buffer` instance allocated on the specified `MemoryStack`.
`static BGFXInstanceDataBuffer`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXInstanceDataBuffer` instance allocated on the specified `MemoryStack`.
`static java.nio.ByteBuffer`	`ndata(long struct)` Unsafe version of `data`.
`static void`	`ndata(long struct, java.nio.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()` Returns the value of the `num` field.
`BGFXInstanceDataBuffer`	`num(int value)` Sets the specified value to the `num` field.
`int`	`offset()` Returns the value of the `offset` field.
`BGFXInstanceDataBuffer`	`offset(int value)` Sets the specified value to the `offset` field.
`BGFXInstanceDataBuffer`	`set(BGFXInstanceDataBuffer src)` Copies the specified struct data to this struct.
`BGFXInstanceDataBuffer`	`set(java.nio.ByteBuffer data, int offset, int num, short stride, short handle)` Initializes this struct with the specified values.
`int`	`size()` Returns the value of the `size` field.
`int`	`sizeof()`
`short`	`stride()` Returns the value of the `stride` field.
`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`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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 Detail
  - BGFXInstanceDataBuffer
```
public BGFXInstanceDataBuffer(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - data
```
public java.nio.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.
  - offset
```
public int offset()
```
    Returns the value of the offset field.
  - num
```
public int num()
```
    Returns the value of the num field.
  - stride
```
public short stride()
```
    Returns the value of the stride field.
  - handle
```
public short handle()
```
    Returns the value of the handle field.
  - data
```
public BGFXInstanceDataBuffer data(java.nio.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(java.nio.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
```
public static BGFXInstanceDataBuffer mallocStack()
```
    Returns a new BGFXInstanceDataBuffer instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static BGFXInstanceDataBuffer callocStack()
```
    Returns a new BGFXInstanceDataBuffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static BGFXInstanceDataBuffer mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXInstanceDataBuffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static BGFXInstanceDataBuffer callocStack(org.lwjgl.system.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
  - mallocStack
```
public static BGFXInstanceDataBuffer.Buffer mallocStack(int capacity)
```
    Returns a new BGFXInstanceDataBuffer.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static BGFXInstanceDataBuffer.Buffer callocStack(int capacity)
```
    Returns a new BGFXInstanceDataBuffer.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static BGFXInstanceDataBuffer.Buffer mallocStack(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXInstanceDataBuffer.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static BGFXInstanceDataBuffer.Buffer callocStack(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXInstanceDataBuffer.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - ndata
```
public static java.nio.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,
                         java.nio.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
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class BGFXInstanceDataBuffer

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

DATA

SIZE

OFFSET

NUM

STRIDE

HANDLE

Constructor Detail

BGFXInstanceDataBuffer

Method Detail

sizeof

data

size

offset

num

stride

handle

data

offset

num

stride

handle

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ndata

nsize

noffset

nnum

nstride

nhandle

ndata

nsize

noffset

nnum

nstride

nhandle

validate

validate