Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkCommandBuffer

extends Struct<NkCommandBuffer>
Class Inheritance
Annotations
@NativeType:struct nk_command_buffer
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Layout


struct nk_command_buffer {
    struct nk_buffer * base;
    struct nk_rect clip;
    int use_clipping;
    nk_handle userdata;
    nk_size begin;
    nk_size end;
    nk_size last;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NkCommandBuffer.Buffer

An array of NkCommandBuffer structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BASE

The struct member offsets.

public static final int
BEGIN

The struct member offsets.

public static final int
CLIP

The struct member offsets.

public static final int
END

The struct member offsets.

public static final int
LAST

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
USE_CLIPPING

The struct member offsets.

public static final int
USERDATA

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
NkCommandBuffer(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public NkBuffer

Returns:

a NkBuffer view of the struct pointed to by the base field.
base()

public long

Returns:

the value of the begin field.
begin()

public NkRect

Returns:

a NkRect view of the clip field.
clip()

protected NkCommandBuffer
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 NkCommandBuffer
create(long address)

Returns a new NkCommandBuffer instance for the specified memory address.

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

Create a NkCommandBuffer.Buffer instance at the specified memory.

public static NkCommandBuffer
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long

Returns:

the value of the end field.
end()

public long

Returns:

the value of the last field.
last()

public static NkBuffer
nbase(long struct)

Unsafe version of base.

public static long
nbegin(long struct)

Unsafe version of begin.

public static NkRect
nclip(long struct)

Unsafe version of clip.

public static long
nend(long struct)

Unsafe version of end.

public static long
nlast(long struct)

Unsafe version of last.

public static int
nuse_clipping(long struct)

Unsafe version of use_clipping.

public static NkHandle
nuserdata(long struct)

Unsafe version of userdata.

public int
sizeof()

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

Returns sizeof(struct).
public int

Returns:

the value of the use_clipping field.
use_clipping()

public NkHandle

Returns:

a NkHandle view of the userdata field.
userdata()

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.

BASEback to summary
public static final int BASE

The struct member offsets.

BEGINback to summary
public static final int BEGIN

The struct member offsets.

CLIPback to summary
public static final int CLIP

The struct member offsets.

ENDback to summary
public static final int END

The struct member offsets.

LASTback to summary
public static final int LAST

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

USE_CLIPPINGback to summary
public static final int USE_CLIPPING

The struct member offsets.

USERDATAback to summary
public static final int USERDATA

The struct member offsets.

Constructor Detail

NkCommandBufferback to summary
protected NkCommandBuffer(long address, ByteBuffer container)
NkCommandBufferback to summary
public NkCommandBuffer(ByteBuffer container)

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

baseback to summary
public NkBuffer base()
Returns:NkBuffer

a NkBuffer view of the struct pointed to by the base field.

Annotations
@Nullable
@NativeType:struct nk_buffer *
beginback to summary
public long begin()
Returns:long

the value of the begin field.

Annotations
@NativeType:nk_size
clipback to summary
public NkRect clip()
Returns:NkRect

a NkRect view of the clip field.

Annotations
@NativeType:struct nk_rect
createback to summary
protected NkCommandBuffer 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 NkCommandBuffer create(long address)

Returns a new NkCommandBuffer instance for the specified memory address.

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

Create a NkCommandBuffer.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkCommandBuffer createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
endback to summary
public long end()
Returns:long

the value of the end field.

Annotations
@NativeType:nk_size
lastback to summary
public long last()
Returns:long

the value of the last field.

Annotations
@NativeType:nk_size
nbaseback to summary
public static NkBuffer nbase(long struct)

Unsafe version of base.

Annotations
@Nullable
nbeginback to summary
public static long nbegin(long struct)

Unsafe version of begin.

nclipback to summary
public static NkRect nclip(long struct)

Unsafe version of clip.

nendback to summary
public static long nend(long struct)

Unsafe version of end.

nlastback to summary
public static long nlast(long struct)

Unsafe version of last.

nuse_clippingback to summary
public static int nuse_clipping(long struct)

Unsafe version of use_clipping.

nuserdataback to summary
public static NkHandle nuserdata(long struct)

Unsafe version of userdata.

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
use_clippingback to summary
public int use_clipping()
Returns:int

the value of the use_clipping field.

userdataback to summary
public NkHandle userdata()
Returns:NkHandle

a NkHandle view of the userdata field.

Annotations
@NativeType:nk_handle
org.lwjgl.nuklear back to summary

public Class NkCommandBuffer.Buffer

extends StructBuffer<NkCommandBuffer, NkCommandBuffer.Buffer>
Class Inheritance
An array of NkCommandBuffer structs.

Field Summary

Modifier and TypeField and Description
private static final NkCommandBuffer
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkCommandBuffer.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 NkBuffer

Returns:

a NkBuffer view of the struct pointed to by the base field.
base()

public long

Returns:

the value of the begin field.
begin()

public NkRect

Returns:

a NkRect view of the clip field.
clip()

public long

Returns:

the value of the end field.
end()

protected NkCommandBuffer
getElementFactory()

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

public long

Returns:

the value of the last field.
last()

protected NkCommandBuffer.Buffer
self()

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

public int

Returns:

the value of the use_clipping field.
use_clipping()

public NkHandle

Returns:

a NkHandle view of the userdata field.
userdata()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final NkCommandBuffer ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new NkCommandBuffer.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 NkCommandBuffer#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

baseback to summary
public NkBuffer base()
Returns:NkBuffer

a NkBuffer view of the struct pointed to by the base field.

Annotations
@Nullable
@NativeType:struct nk_buffer *
beginback to summary
public long begin()
Returns:long

the value of the begin field.

Annotations
@NativeType:nk_size
clipback to summary
public NkRect clip()
Returns:NkRect

a NkRect view of the clip field.

Annotations
@NativeType:struct nk_rect
endback to summary
public long end()
Returns:long

the value of the end field.

Annotations
@NativeType:nk_size
getElementFactoryback to summary
protected NkCommandBuffer getElementFactory()

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

Annotations
@Override
lastback to summary
public long last()
Returns:long

the value of the last field.

Annotations
@NativeType:nk_size
selfback to summary
protected NkCommandBuffer.Buffer self()

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

Annotations
@Override
use_clippingback to summary
public int use_clipping()
Returns:int

the value of the use_clipping field.

userdataback to summary
public NkHandle userdata()
Returns:NkHandle

a NkHandle view of the userdata field.

Annotations
@NativeType:nk_handle