Package org.lwjgl.nuklear

Class NkCommandBuffer

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.nuklear.NkCommandBuffer

All Implemented Interfaces:

org.lwjgl.system.Pointer

public class NkCommandBuffer
extends org.lwjgl.system.Struct

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 Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NkCommandBuffer.Buffer	An array of NkCommandBuffer structs.

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALIGNOF	The struct alignment in bytes.
static int	BASE BEGIN CLIP END LAST	The struct member offsets.
static int	SIZEOF	The struct size in bytes.
static int	USE_CLIPPING USERDATA	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
NkBuffer	base()	Returns a NkBuffer view of the struct pointed to by the base field.
long	begin()	Returns the value of the begin field.
NkRect	clip()	Returns a NkRect view of the clip field.
NkCommandBuffer	clip(java.util.function.Consumer<NkRect> consumer)	Passes the clip field to the specified Consumer.
static NkCommandBuffer	create(long address)	Returns a new NkCommandBuffer instance for the specified memory address.
static NkCommandBuffer.Buffer	create(long address, int capacity)	Create a NkCommandBuffer.Buffer instance at the specified memory.
static NkCommandBuffer	createSafe(long address)	Like create, but returns null if address is NULL.
static NkCommandBuffer.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	end()	Returns the value of the end field.
long	last()	Returns the value of the last field.
static NkBuffer	nbase(long struct)	Unsafe version of base().
static long	nbegin(long struct)	Unsafe version of begin().
static NkRect	nclip(long struct)	Unsafe version of clip().
static long	nend(long struct)	Unsafe version of end().
static long	nlast(long struct)	Unsafe version of last().
static int	nuse_clipping(long struct)	Unsafe version of use_clipping().
static NkHandle	nuserdata(long struct)	Unsafe version of userdata().
int	sizeof()
int	use_clipping()	Returns the value of the use_clipping field.
NkHandle	userdata()	Returns a NkHandle view of the userdata field.
NkCommandBuffer	userdata(java.util.function.Consumer<NkHandle> consumer)	Passes the userdata field to the specified Consumer.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull

Field Detail

SIZEOF

The struct size in bytes.

ALIGNOF

The struct alignment in bytes.

BASE, CLIP, USE_CLIPPING, USERDATA, BEGIN, END, LAST

The struct member offsets.

Constructor Detail

NkCommandBuffer

public NkCommandBuffer(java.nio.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

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct

base

@Nullable
public NkBuffer base()

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

clip

public NkRect clip()

Returns a NkRect view of the clip field.

clip

public NkCommandBuffer clip(java.util.function.Consumer<NkRect> consumer)

Passes the clip field to the specified Consumer.

use_clipping

public int use_clipping()

Returns the value of the use_clipping field.

userdata

public NkHandle userdata()

Returns a NkHandle view of the userdata field.

userdata

public NkCommandBuffer userdata(java.util.function.Consumer<NkHandle> consumer)

Passes the userdata field to the specified Consumer.

begin

public long begin()

Returns the value of the begin field.

end

public long end()

Returns the value of the end field.

last

public long last()

Returns the value of the last field.

create

public static NkCommandBuffer create(long address)

Returns a new NkCommandBuffer instance for the specified memory address.

createSafe

@Nullable
public static NkCommandBuffer createSafe(long address)

Like create, but returns null if address is NULL.

create

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

Create a NkCommandBuffer.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

nbase

@Nullable
public static NkBuffer nbase(long struct)

Unsafe version of base().

nclip

public static NkRect nclip(long struct)

Unsafe version of clip().

nuse_clipping

public static int nuse_clipping(long struct)

Unsafe version of use_clipping().

nuserdata

public static NkHandle nuserdata(long struct)

Unsafe version of userdata().

nbegin

public static long nbegin(long struct)

Unsafe version of begin().

nend

public static long nend(long struct)

Unsafe version of end().

nlast

public static long nlast(long struct)

Unsafe version of last().