BGFXVertexLayout (LWJGL 3.2.4 SNAPSHOT

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

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

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

Vertex layout.

Member documentation

stride – vertex stride
offset[BGFX_ATTRIB_COUNT] – relative attribute offset from the vertex

Layout


 struct bgfx_vertex_layout_t {
     uint32_t hash;
     uint16_t stride;
     uint16_t offset[BGFX_ATTRIB_COUNT];
     uint16_t attributes[BGFX_ATTRIB_COUNT];
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BGFXVertexLayout.Buffer
An array of BGFXVertexLayout 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`	`BGFXVertexLayout.Buffer` An array of `BGFXVertexLayout` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ATTRIBUTES` The struct member offsets.
`static int`	`HASH` The struct member offsets.
`static int`	`OFFSET` 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

BGFXVertexLayout(java.nio.ByteBuffer container)
Creates a BGFXVertexLayout instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`BGFXVertexLayout(java.nio.ByteBuffer container)` Creates a `BGFXVertexLayout` 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
`java.nio.ShortBuffer`	`attributes()` Returns a `ShortBuffer` view of the `attributes` field.
`short`	`attributes(int index)` Returns the value at the specified index of the `attributes` field.
`BGFXVertexLayout`	`attributes(int index, short value)` Sets the specified value at the specified index of the `attributes` field.
`BGFXVertexLayout`	`attributes(java.nio.ShortBuffer value)` Copies the specified `ShortBuffer` to the `attributes` field.
`static BGFXVertexLayout`	`calloc()` Returns a new `BGFXVertexLayout` instance allocated with `memCalloc`.
`static BGFXVertexLayout.Buffer`	`calloc(int capacity)` Returns a new `BGFXVertexLayout.Buffer` instance allocated with `memCalloc`.
`static BGFXVertexLayout`	`callocStack()` Returns a new `BGFXVertexLayout` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXVertexLayout.Buffer`	`callocStack(int capacity)` Returns a new `BGFXVertexLayout.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXVertexLayout.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXVertexLayout.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static BGFXVertexLayout`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXVertexLayout` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static BGFXVertexLayout`	`create()` Returns a new `BGFXVertexLayout` instance allocated with `BufferUtils`.
`static BGFXVertexLayout.Buffer`	`create(int capacity)` Returns a new `BGFXVertexLayout.Buffer` instance allocated with `BufferUtils`.
`static BGFXVertexLayout`	`create(long address)` Returns a new `BGFXVertexLayout` instance for the specified memory address.
`static BGFXVertexLayout.Buffer`	`create(long address, int capacity)` Create a `BGFXVertexLayout.Buffer` instance at the specified memory.
`static BGFXVertexLayout`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static BGFXVertexLayout.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`hash()` Returns the value of the `hash` field.
`BGFXVertexLayout`	`hash(int value)` Sets the specified value to the `hash` field.
`static BGFXVertexLayout`	`malloc()` Returns a new `BGFXVertexLayout` instance allocated with `memAlloc`.
`static BGFXVertexLayout.Buffer`	`malloc(int capacity)` Returns a new `BGFXVertexLayout.Buffer` instance allocated with `memAlloc`.
`static BGFXVertexLayout`	`mallocStack()` Returns a new `BGFXVertexLayout` instance allocated on the thread-local `MemoryStack`.
`static BGFXVertexLayout.Buffer`	`mallocStack(int capacity)` Returns a new `BGFXVertexLayout.Buffer` instance allocated on the thread-local `MemoryStack`.
`static BGFXVertexLayout.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXVertexLayout.Buffer` instance allocated on the specified `MemoryStack`.
`static BGFXVertexLayout`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXVertexLayout` instance allocated on the specified `MemoryStack`.
`static java.nio.ShortBuffer`	`nattributes(long struct)` Unsafe version of `attributes()`.
`static short`	`nattributes(long struct, int index)` Unsafe version of `attributes`.
`static void`	`nattributes(long struct, int index, short value)` Unsafe version of `attributes`.
`static void`	`nattributes(long struct, java.nio.ShortBuffer value)` Unsafe version of `attributes`.
`static int`	`nhash(long struct)` Unsafe version of `hash()`.
`static void`	`nhash(long struct, int value)` Unsafe version of `hash`.
`static java.nio.ShortBuffer`	`noffset(long struct)` Unsafe version of `offset()`.
`static short`	`noffset(long struct, int index)` Unsafe version of `offset`.
`static void`	`noffset(long struct, int index, short value)` Unsafe version of `offset`.
`static void`	`noffset(long struct, java.nio.ShortBuffer value)` Unsafe version of `offset`.
`static short`	`nstride(long struct)` Unsafe version of `stride()`.
`static void`	`nstride(long struct, short value)` Unsafe version of `stride`.
`java.nio.ShortBuffer`	`offset()` Returns a `ShortBuffer` view of the `offset` field.
`short`	`offset(int index)` Returns the value at the specified index of the `offset` field.
`BGFXVertexLayout`	`offset(int index, short value)` Sets the specified value at the specified index of the `offset` field.
`BGFXVertexLayout`	`offset(java.nio.ShortBuffer value)` Copies the specified `ShortBuffer` to the `offset` field.
`BGFXVertexLayout`	`set(BGFXVertexLayout src)` Copies the specified struct data to this struct.
`BGFXVertexLayout`	`set(int hash, short stride, java.nio.ShortBuffer offset, java.nio.ShortBuffer attributes)` Initializes this struct with the specified values.
`int`	`sizeof()`
`short`	`stride()` Returns the value of the `stride` field.
`BGFXVertexLayout`	`stride(short value)` Sets the specified value to the `stride` field.

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.
  - HASH
```
public static final int HASH
```
    The struct member offsets.
  - STRIDE
```
public static final int STRIDE
```
    The struct member offsets.
  - OFFSET
```
public static final int OFFSET
```
    The struct member offsets.
  - ATTRIBUTES
```
public static final int ATTRIBUTES
```
    The struct member offsets.
- Constructor Detail
  - BGFXVertexLayout
```
public BGFXVertexLayout(java.nio.ByteBuffer container)
```
    Creates a BGFXVertexLayout 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
  - hash
```
public int hash()
```
    Returns the value of the hash field.
  - stride
```
public short stride()
```
    Returns the value of the stride field.
  - offset
```
public java.nio.ShortBuffer offset()
```
    Returns a ShortBuffer view of the offset field.
  - offset
```
public short offset(int index)
```
    Returns the value at the specified index of the offset field.
  - attributes
```
public java.nio.ShortBuffer attributes()
```
    Returns a ShortBuffer view of the attributes field.
  - attributes
```
public short attributes(int index)
```
    Returns the value at the specified index of the attributes field.
  - hash
```
public BGFXVertexLayout hash(int value)
```
    Sets the specified value to the hash field.
  - stride
```
public BGFXVertexLayout stride(short value)
```
    Sets the specified value to the stride field.
  - offset
```
public BGFXVertexLayout offset(java.nio.ShortBuffer value)
```
    Copies the specified ShortBuffer to the offset field.
  - offset
```
public BGFXVertexLayout offset(int index,
                               short value)
```
    Sets the specified value at the specified index of the offset field.
  - attributes
```
public BGFXVertexLayout attributes(java.nio.ShortBuffer value)
```
    Copies the specified ShortBuffer to the attributes field.
  - attributes
```
public BGFXVertexLayout attributes(int index,
                                   short value)
```
    Sets the specified value at the specified index of the attributes field.
  - set
```
public BGFXVertexLayout set(int hash,
                            short stride,
                            java.nio.ShortBuffer offset,
                            java.nio.ShortBuffer attributes)
```
    Initializes this struct with the specified values.
  - set
```
public BGFXVertexLayout set(BGFXVertexLayout src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static BGFXVertexLayout malloc()
```
    Returns a new BGFXVertexLayout instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static BGFXVertexLayout calloc()
```
    Returns a new BGFXVertexLayout instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static BGFXVertexLayout create()
```
    Returns a new BGFXVertexLayout instance allocated with BufferUtils.
  - create
```
public static BGFXVertexLayout create(long address)
```
    Returns a new BGFXVertexLayout instance for the specified memory address.
  - createSafe
```
@Nullable
public static BGFXVertexLayout createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static BGFXVertexLayout.Buffer malloc(int capacity)
```
    Returns a new BGFXVertexLayout.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static BGFXVertexLayout.Buffer calloc(int capacity)
```
    Returns a new BGFXVertexLayout.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static BGFXVertexLayout.Buffer create(int capacity)
```
    Returns a new BGFXVertexLayout.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static BGFXVertexLayout.Buffer create(long address,
                                             int capacity)
```
    Create a BGFXVertexLayout.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static BGFXVertexLayout.Buffer createSafe(long address,
                                                           int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static BGFXVertexLayout mallocStack()
```
    Returns a new BGFXVertexLayout instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static BGFXVertexLayout callocStack()
```
    Returns a new BGFXVertexLayout instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static BGFXVertexLayout mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXVertexLayout instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static BGFXVertexLayout callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXVertexLayout instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static BGFXVertexLayout.Buffer mallocStack(int capacity)
```
    Returns a new BGFXVertexLayout.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static BGFXVertexLayout.Buffer callocStack(int capacity)
```
    Returns a new BGFXVertexLayout.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static BGFXVertexLayout.Buffer mallocStack(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXVertexLayout.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static BGFXVertexLayout.Buffer callocStack(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXVertexLayout.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
  - nhash
```
public static int nhash(long struct)
```
    Unsafe version of hash().
  - nstride
```
public static short nstride(long struct)
```
    Unsafe version of stride().
  - noffset
```
public static java.nio.ShortBuffer noffset(long struct)
```
    Unsafe version of offset().
  - noffset
```
public static short noffset(long struct,
                            int index)
```
    Unsafe version of offset.
  - nattributes
```
public static java.nio.ShortBuffer nattributes(long struct)
```
    Unsafe version of attributes().
  - nattributes
```
public static short nattributes(long struct,
                                int index)
```
    Unsafe version of attributes.
  - nhash
```
public static void nhash(long struct,
                         int value)
```
    Unsafe version of hash.
  - nstride
```
public static void nstride(long struct,
                           short value)
```
    Unsafe version of stride.
  - noffset
```
public static void noffset(long struct,
                           java.nio.ShortBuffer value)
```
    Unsafe version of offset.
  - noffset
```
public static void noffset(long struct,
                           int index,
                           short value)
```
    Unsafe version of offset.
  - nattributes
```
public static void nattributes(long struct,
                               java.nio.ShortBuffer value)
```
    Unsafe version of attributes.
  - nattributes
```
public static void nattributes(long struct,
                               int index,
                               short value)
```
    Unsafe version of attributes.

Class BGFXVertexLayout

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

HASH

STRIDE

OFFSET

ATTRIBUTES

Constructor Detail

BGFXVertexLayout

Method Detail

sizeof

hash

stride

offset

offset

attributes

attributes

hash

stride

offset

offset

attributes

attributes

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nhash

nstride

noffset

noffset

nattributes

nattributes

nhash

nstride

noffset

noffset

nattributes

nattributes