BGFXTransientVertexBuffer (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class BGFXTransientVertexBuffer
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Transient vertex buffer.

Member documentation

data – pointer to data
size – data size
startVertex – first vertex
stride – vertex stride
handle – vertex buffer handle
layoutHandle – vertex layout handle

Layout


 struct bgfx_transient_vertex_buffer_t {
     uint8_t * data;
     uint32_t size;
     uint32_t startVertex;
     uint16_t stride;
     bgfx_vertex_buffer_handle_t handle;
     bgfx_vertex_layout_handle_t layoutHandle;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BGFXTransientVertexBuffer.Buffer
An array of BGFXTransientVertexBuffer 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`	`BGFXTransientVertexBuffer.Buffer` An array of `BGFXTransientVertexBuffer` 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`	`LAYOUTHANDLE` The struct member offsets.
`static int`	`SIZE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STARTVERTEX` The struct member offsets.
`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
`BGFXTransientVertexBuffer(java.nio.ByteBuffer container)` Creates a `BGFXTransientVertexBuffer` 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 BGFXTransientVertexBuffer`	`calloc()` Returns a new `BGFXTransientVertexBuffer` instance allocated with `memCalloc`.
`static BGFXTransientVertexBuffer.Buffer`	`calloc(int capacity)` Returns a new `BGFXTransientVertexBuffer.Buffer` instance allocated with `memCalloc`.
`static BGFXTransientVertexBuffer`	`callocStack()` Returns a new `BGFXTransientVertexBuffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXTransientVertexBuffer.Buffer`	`callocStack(int capacity)` Returns a new `BGFXTransientVertexBuffer.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXTransientVertexBuffer.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXTransientVertexBuffer.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static BGFXTransientVertexBuffer`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXTransientVertexBuffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static BGFXTransientVertexBuffer`	`create()` Returns a new `BGFXTransientVertexBuffer` instance allocated with `BufferUtils`.
`static BGFXTransientVertexBuffer.Buffer`	`create(int capacity)` Returns a new `BGFXTransientVertexBuffer.Buffer` instance allocated with `BufferUtils`.
`static BGFXTransientVertexBuffer`	`create(long address)` Returns a new `BGFXTransientVertexBuffer` instance for the specified memory address.
`static BGFXTransientVertexBuffer.Buffer`	`create(long address, int capacity)` Create a `BGFXTransientVertexBuffer.Buffer` instance at the specified memory.
`static BGFXTransientVertexBuffer`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static BGFXTransientVertexBuffer.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.
`BGFXTransientVertexBuffer`	`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.
`BGFXTransientVertexBuffer`	`handle(short value)` Sets the specified value to the `handle` field.
`short`	`layoutHandle()` Returns the value of the `layoutHandle` field.
`BGFXTransientVertexBuffer`	`layoutHandle(short value)` Sets the specified value to the `layoutHandle` field.
`static BGFXTransientVertexBuffer`	`malloc()` Returns a new `BGFXTransientVertexBuffer` instance allocated with `memAlloc`.
`static BGFXTransientVertexBuffer.Buffer`	`malloc(int capacity)` Returns a new `BGFXTransientVertexBuffer.Buffer` instance allocated with `memAlloc`.
`static BGFXTransientVertexBuffer`	`mallocStack()` Returns a new `BGFXTransientVertexBuffer` instance allocated on the thread-local `MemoryStack`.
`static BGFXTransientVertexBuffer.Buffer`	`mallocStack(int capacity)` Returns a new `BGFXTransientVertexBuffer.Buffer` instance allocated on the thread-local `MemoryStack`.
`static BGFXTransientVertexBuffer.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXTransientVertexBuffer.Buffer` instance allocated on the specified `MemoryStack`.
`static BGFXTransientVertexBuffer`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXTransientVertexBuffer` 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 short`	`nlayoutHandle(long struct)` Unsafe version of `layoutHandle()`.
`static void`	`nlayoutHandle(long struct, short value)` Unsafe version of `layoutHandle`.
`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`	`nstartVertex(long struct)` Unsafe version of `startVertex()`.
`static void`	`nstartVertex(long struct, int value)` Unsafe version of `startVertex`.
`static short`	`nstride(long struct)` Unsafe version of `stride()`.
`static void`	`nstride(long struct, short value)` Unsafe version of `stride`.
`BGFXTransientVertexBuffer`	`set(BGFXTransientVertexBuffer src)` Copies the specified struct data to this struct.
`BGFXTransientVertexBuffer`	`set(java.nio.ByteBuffer data, int startVertex, short stride, short handle, short layoutHandle)` Initializes this struct with the specified values.
`int`	`size()` Returns the value of the `size` field.
`int`	`sizeof()`
`int`	`startVertex()` Returns the value of the `startVertex` field.
`BGFXTransientVertexBuffer`	`startVertex(int value)` Sets the specified value to the `startVertex` field.
`short`	`stride()` Returns the value of the `stride` field.
`BGFXTransientVertexBuffer`	`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.
  - STARTVERTEX
```
public static final int STARTVERTEX
```
    The struct member offsets.
  - STRIDE
```
public static final int STRIDE
```
    The struct member offsets.
  - HANDLE
```
public static final int HANDLE
```
    The struct member offsets.
  - LAYOUTHANDLE
```
public static final int LAYOUTHANDLE
```
    The struct member offsets.
- Constructor Detail
  - BGFXTransientVertexBuffer
```
public BGFXTransientVertexBuffer(java.nio.ByteBuffer container)
```
    Creates a BGFXTransientVertexBuffer 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.
  - startVertex
```
public int startVertex()
```
    Returns the value of the startVertex field.
  - stride
```
public short stride()
```
    Returns the value of the stride field.
  - handle
```
public short handle()
```
    Returns the value of the handle field.
  - layoutHandle
```
public short layoutHandle()
```
    Returns the value of the layoutHandle field.
  - data
```
public BGFXTransientVertexBuffer data(java.nio.ByteBuffer value)
```
    Sets the address of the specified ByteBuffer to the data field.
  - startVertex
```
public BGFXTransientVertexBuffer startVertex(int value)
```
    Sets the specified value to the startVertex field.
  - stride
```
public BGFXTransientVertexBuffer stride(short value)
```
    Sets the specified value to the stride field.
  - handle
```
public BGFXTransientVertexBuffer handle(short value)
```
    Sets the specified value to the handle field.
  - layoutHandle
```
public BGFXTransientVertexBuffer layoutHandle(short value)
```
    Sets the specified value to the layoutHandle field.
  - set
```
public BGFXTransientVertexBuffer set(java.nio.ByteBuffer data,
                                     int startVertex,
                                     short stride,
                                     short handle,
                                     short layoutHandle)
```
    Initializes this struct with the specified values.
  - set
```
public BGFXTransientVertexBuffer set(BGFXTransientVertexBuffer src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static BGFXTransientVertexBuffer malloc()
```
    Returns a new BGFXTransientVertexBuffer instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static BGFXTransientVertexBuffer calloc()
```
    Returns a new BGFXTransientVertexBuffer instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static BGFXTransientVertexBuffer create()
```
    Returns a new BGFXTransientVertexBuffer instance allocated with BufferUtils.
  - create
```
public static BGFXTransientVertexBuffer create(long address)
```
    Returns a new BGFXTransientVertexBuffer instance for the specified memory address.
  - createSafe
```
@Nullable
public static BGFXTransientVertexBuffer createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static BGFXTransientVertexBuffer.Buffer malloc(int capacity)
```
    Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static BGFXTransientVertexBuffer.Buffer calloc(int capacity)
```
    Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static BGFXTransientVertexBuffer.Buffer create(int capacity)
```
    Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static BGFXTransientVertexBuffer.Buffer create(long address,
                                                      int capacity)
```
    Create a BGFXTransientVertexBuffer.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static BGFXTransientVertexBuffer.Buffer createSafe(long address,
                                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static BGFXTransientVertexBuffer mallocStack()
```
    Returns a new BGFXTransientVertexBuffer instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static BGFXTransientVertexBuffer callocStack()
```
    Returns a new BGFXTransientVertexBuffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static BGFXTransientVertexBuffer mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXTransientVertexBuffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static BGFXTransientVertexBuffer callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXTransientVertexBuffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static BGFXTransientVertexBuffer.Buffer mallocStack(int capacity)
```
    Returns a new BGFXTransientVertexBuffer.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static BGFXTransientVertexBuffer.Buffer callocStack(int capacity)
```
    Returns a new BGFXTransientVertexBuffer.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static BGFXTransientVertexBuffer.Buffer mallocStack(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXTransientVertexBuffer.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static BGFXTransientVertexBuffer.Buffer callocStack(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXTransientVertexBuffer.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().
  - nstartVertex
```
public static int nstartVertex(long struct)
```
    Unsafe version of startVertex().
  - nstride
```
public static short nstride(long struct)
```
    Unsafe version of stride().
  - nhandle
```
public static short nhandle(long struct)
```
    Unsafe version of handle().
  - nlayoutHandle
```
public static short nlayoutHandle(long struct)
```
    Unsafe version of layoutHandle().
  - 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.
  - nstartVertex
```
public static void nstartVertex(long struct,
                                int value)
```
    Unsafe version of startVertex.
  - 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.
  - nlayoutHandle
```
public static void nlayoutHandle(long struct,
                                 short value)
```
    Unsafe version of layoutHandle.
  - 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 BGFXTransientVertexBuffer

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

STARTVERTEX

STRIDE

HANDLE

LAYOUTHANDLE

Constructor Detail

BGFXTransientVertexBuffer

Method Detail

sizeof

data

size

startVertex

stride

handle

layoutHandle

data

startVertex

stride

handle

layoutHandle

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ndata

nsize

nstartVertex

nstride

nhandle

nlayoutHandle

ndata

nsize

nstartVertex

nstride

nhandle

nlayoutHandle

validate

validate