Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkDrawVertexLayoutElement

extends Struct<NkDrawVertexLayoutElement>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct nk_draw_vertex_layout_element
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct nk_draw_vertex_layout_element {
    enum nk_draw_vertex_layout_attribute attribute;
    enum nk_draw_vertex_layout_format format;
    nk_size offset;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ATTRIBUTE

The struct member offsets.

public static final int
FORMAT

The struct member offsets.

public static final int
OFFSET

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
NkDrawVertexLayoutElement(long address, ByteBuffer container)

public
NkDrawVertexLayoutElement(ByteBuffer container)

Creates a NkDrawVertexLayoutElement instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
attribute()

the vertex attribute.

public NkDrawVertexLayoutElement
attribute(int value)

Sets the specified value to the attribute field.

public static NkDrawVertexLayoutElement
calloc()

Returns a new NkDrawVertexLayoutElement instance allocated with memCalloc.

public static NkDrawVertexLayoutElement.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new NkDrawVertexLayoutElement.Buffer instance allocated with memCalloc.

public static NkDrawVertexLayoutElement
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new NkDrawVertexLayoutElement instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static NkDrawVertexLayoutElement.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new NkDrawVertexLayoutElement.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static NkDrawVertexLayoutElement
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static NkDrawVertexLayoutElement
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static NkDrawVertexLayoutElement.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static NkDrawVertexLayoutElement.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected NkDrawVertexLayoutElement
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static NkDrawVertexLayoutElement
create()

Returns a new NkDrawVertexLayoutElement instance allocated with BufferUtils.

public static NkDrawVertexLayoutElement
create(long address)

Returns a new NkDrawVertexLayoutElement instance for the specified memory address.

public static NkDrawVertexLayoutElement.Buffer
create(int
the buffer capacity
capacity
)

Returns a new NkDrawVertexLayoutElement.Buffer instance allocated with BufferUtils.

public static NkDrawVertexLayoutElement.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a NkDrawVertexLayoutElement.Buffer instance at the specified memory.

public static NkDrawVertexLayoutElement
createSafe(long address)

Like create, but returns null if address is NULL.

public static NkDrawVertexLayoutElement.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
format()

the vertex attribute format.

public NkDrawVertexLayoutElement
format(int value)

Sets the specified value to the format field.

public static NkDrawVertexLayoutElement
malloc()

Returns a new NkDrawVertexLayoutElement instance allocated with memAlloc.

public static NkDrawVertexLayoutElement.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new NkDrawVertexLayoutElement.Buffer instance allocated with memAlloc.

public static NkDrawVertexLayoutElement
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new NkDrawVertexLayoutElement instance allocated on the specified MemoryStack.

public static NkDrawVertexLayoutElement.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static NkDrawVertexLayoutElement
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static NkDrawVertexLayoutElement
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static NkDrawVertexLayoutElement.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static NkDrawVertexLayoutElement.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nattribute(long struct)

Unsafe version of attribute.

public static void
nattribute(long struct, int value)

Unsafe version of attribute.

public static int
nformat(long struct)

Unsafe version of format.

public static void
nformat(long struct, int value)

Unsafe version of format.

public static long
noffset(long struct)

Unsafe version of offset.

public static void
noffset(long struct, long value)

Unsafe version of offset.

public long
offset()

the vertex attribute offset

public NkDrawVertexLayoutElement
offset(long value)

Sets the specified value to the offset field.

public NkDrawVertexLayoutElement
set(int attribute, int format, long offset)

Initializes this struct with the specified values.

public NkDrawVertexLayoutElement

Returns:

this struct
set
(NkDrawVertexLayoutElement
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

ATTRIBUTEback to summary
public static final int ATTRIBUTE

The struct member offsets.

FORMATback to summary
public static final int FORMAT

The struct member offsets.

OFFSETback to summary
public static final int OFFSET

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

NkDrawVertexLayoutElementback to summary
protected NkDrawVertexLayoutElement(long address, ByteBuffer container)
NkDrawVertexLayoutElementback to summary
public NkDrawVertexLayoutElement(ByteBuffer container)

Creates a NkDrawVertexLayoutElement 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

attributeback to summary
public int attribute()

the vertex attribute. One of:

VERTEX_POSITIONVERTEX_COLORVERTEX_TEXCOORDVERTEX_ATTRIBUTE_COUNT
Annotations
@NativeType:enum nk_draw_vertex_layout_attribute
attributeback to summary
public NkDrawVertexLayoutElement attribute(int value)

Sets the specified value to the attribute field.

callocback to summary
public static NkDrawVertexLayoutElement calloc()

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

callocback to summary
public static NkDrawVertexLayoutElement.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static NkDrawVertexLayoutElement calloc(MemoryStack stack)

Returns a new NkDrawVertexLayoutElement instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static NkDrawVertexLayoutElement.Buffer calloc(int capacity, MemoryStack stack)

Returns a new NkDrawVertexLayoutElement.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static NkDrawVertexLayoutElement callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static NkDrawVertexLayoutElement callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static NkDrawVertexLayoutElement.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static NkDrawVertexLayoutElement.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected NkDrawVertexLayoutElement create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static NkDrawVertexLayoutElement create()

Returns a new NkDrawVertexLayoutElement instance allocated with BufferUtils.

createback to summary
public static NkDrawVertexLayoutElement create(long address)

Returns a new NkDrawVertexLayoutElement instance for the specified memory address.

createback to summary
public static NkDrawVertexLayoutElement.Buffer create(int capacity)

Returns a new NkDrawVertexLayoutElement.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static NkDrawVertexLayoutElement.Buffer create(long address, int capacity)

Create a NkDrawVertexLayoutElement.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkDrawVertexLayoutElement createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static NkDrawVertexLayoutElement.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
formatback to summary
public int format()

the vertex attribute format. One of:

FORMAT_SCHARFORMAT_SSHORTFORMAT_SINTFORMAT_UCHARFORMAT_USHORT
FORMAT_UINTFORMAT_FLOATFORMAT_DOUBLEFORMAT_COLOR_BEGINFORMAT_R8G8B8
FORMAT_R16G15B16FORMAT_R32G32B32FORMAT_R8G8B8A8FORMAT_B8G8R8A8FORMAT_R16G15B16A16
FORMAT_R32G32B32A32FORMAT_R32G32B32A32_FLOATFORMAT_R32G32B32A32_DOUBLEFORMAT_RGB32FORMAT_RGBA32
FORMAT_COLOR_END
Annotations
@NativeType:enum nk_draw_vertex_layout_format
formatback to summary
public NkDrawVertexLayoutElement format(int value)

Sets the specified value to the format field.

mallocback to summary
public static NkDrawVertexLayoutElement malloc()

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

mallocback to summary
public static NkDrawVertexLayoutElement.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static NkDrawVertexLayoutElement malloc(MemoryStack stack)

Returns a new NkDrawVertexLayoutElement instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static NkDrawVertexLayoutElement.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static NkDrawVertexLayoutElement mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static NkDrawVertexLayoutElement mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static NkDrawVertexLayoutElement.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static NkDrawVertexLayoutElement.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nattributeback to summary
public static int nattribute(long struct)

Unsafe version of attribute.

nattributeback to summary
public static void nattribute(long struct, int value)

Unsafe version of attribute.

nformatback to summary
public static int nformat(long struct)

Unsafe version of format.

nformatback to summary
public static void nformat(long struct, int value)

Unsafe version of format.

noffsetback to summary
public static long noffset(long struct)

Unsafe version of offset.

noffsetback to summary
public static void noffset(long struct, long value)

Unsafe version of offset.

offsetback to summary
public long offset()

the vertex attribute offset

Annotations
@NativeType:nk_size
offsetback to summary
public NkDrawVertexLayoutElement offset(long value)

Sets the specified value to the offset field.

setback to summary
public NkDrawVertexLayoutElement set(int attribute, int format, long offset)

Initializes this struct with the specified values.

setback to summary
public NkDrawVertexLayoutElement set(NkDrawVertexLayoutElement src)

Copies the specified struct data to this struct.

Parameters
src:NkDrawVertexLayoutElement

the source struct

Returns:NkDrawVertexLayoutElement

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.nuklear back to summary

public Class NkDrawVertexLayoutElement.Buffer

extends StructBuffer<NkDrawVertexLayoutElement, NkDrawVertexLayoutElement.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of NkDrawVertexLayoutElement structs.

Field Summary

Modifier and TypeField and Description
private static final NkDrawVertexLayoutElement

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkDrawVertexLayoutElement.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the NkDrawVertexLayoutElement#attribute field.
attribute
()

public NkDrawVertexLayoutElement.Buffer
attribute(int value)

Sets the specified value to the NkDrawVertexLayoutElement#attribute field.

public int

Returns:

the value of the NkDrawVertexLayoutElement#format field.
format
()

public NkDrawVertexLayoutElement.Buffer
format(int value)

Sets the specified value to the NkDrawVertexLayoutElement#format field.

protected NkDrawVertexLayoutElement
public long

Returns:

the value of the NkDrawVertexLayoutElement#offset field.
offset
()

public NkDrawVertexLayoutElement.Buffer
offset(long value)

Sets the specified value to the NkDrawVertexLayoutElement#offset field.

protected NkDrawVertexLayoutElement.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final NkDrawVertexLayoutElement ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new NkDrawVertexLayoutElement.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by NkDrawVertexLayoutElement#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

attributeback to summary
public int attribute()
Returns:int

the value of the NkDrawVertexLayoutElement#attribute field.

Annotations
@NativeType:enum nk_draw_vertex_layout_attribute
attributeback to summary
public NkDrawVertexLayoutElement.Buffer attribute(int value)

Sets the specified value to the NkDrawVertexLayoutElement#attribute field.

formatback to summary
public int format()
Returns:int

the value of the NkDrawVertexLayoutElement#format field.

Annotations
@NativeType:enum nk_draw_vertex_layout_format
formatback to summary
public NkDrawVertexLayoutElement.Buffer format(int value)

Sets the specified value to the NkDrawVertexLayoutElement#format field.

getElementFactoryback to summary
protected NkDrawVertexLayoutElement getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
offsetback to summary
public long offset()
Returns:long

the value of the NkDrawVertexLayoutElement#offset field.

Annotations
@NativeType:nk_size
offsetback to summary
public NkDrawVertexLayoutElement.Buffer offset(long value)

Sets the specified value to the NkDrawVertexLayoutElement#offset field.

selfback to summary
protected NkDrawVertexLayoutElement.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override