Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkPanel

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

Layout


struct nk_panel {
    enum nk_panel_type type;
    nk_flags flags;
    struct nk_rect bounds;
    nk_uint * offset_x;
    nk_uint * offset_y;
    float at_x;
    float at_y;
    float max_x;
    float footer_height;
    float header_height;
    float border;
    unsigned int has_scrolling;
    struct nk_rect clip;
    struct nk_menu_state menu;
    struct nk_row_layout row;
    struct nk_chart chart;
    struct nk_command_buffer * buffer;
    struct nk_panel * parent;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NkPanel.Buffer

An array of NkPanel structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
AT_X

The struct member offsets.

public static final int
AT_Y

The struct member offsets.

public static final int
BORDER

The struct member offsets.

public static final int
BOUNDS

The struct member offsets.

public static final int
BUFFER

The struct member offsets.

public static final int
CHART

The struct member offsets.

public static final int
CLIP

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
HAS_SCROLLING

The struct member offsets.

public static final int
HEADER_HEIGHT

The struct member offsets.

public static final int
MAX_X

The struct member offsets.

public static final int
OFFSET_X

The struct member offsets.

public static final int
OFFSET_Y

The struct member offsets.

public static final int
PARENT

The struct member offsets.

public static final int
ROW

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
NkPanel(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public float

Returns:

the value of the at_x field.
at_x()

public float

Returns:

the value of the at_y field.
at_y()

public float

Returns:

the value of the border field.
border()

public NkRect

Returns:

a NkRect view of the bounds field.
bounds()

public NkCommandBuffer

Returns:

a NkCommandBuffer view of the struct pointed to by the buffer field.
buffer()

public NkChart

Returns:

a NkChart view of the chart field.
chart()

public NkRect

Returns:

a NkRect view of the clip field.
clip()

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

Returns a new NkPanel instance for the specified memory address.

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

Create a NkPanel.Buffer instance at the specified memory.

public static NkPanel
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the flags field.
flags()

public int

Returns:

the value of the has_scrolling field.
has_scrolling()

public float

Returns:

the value of the header_height field.
header_height()

public float

Returns:

the value of the max_x field.
max_x()

public static float
nat_x(long struct)

Unsafe version of at_x.

public static float
nat_y(long struct)

Unsafe version of at_y.

public static float
nborder(long struct)

Unsafe version of border.

public static NkRect
nbounds(long struct)

Unsafe version of bounds.

public static NkCommandBuffer
nbuffer(long struct)

Unsafe version of buffer.

public static NkChart
nchart(long struct)

Unsafe version of chart.

public static NkRect
nclip(long struct)

Unsafe version of clip.

public static int
nflags(long struct)

Unsafe version of flags.

public static float
nfooter_height(long struct)

Unsafe version of footer_height.

public static int
nhas_scrolling(long struct)

Unsafe version of has_scrolling.

public static float
nheader_height(long struct)

Unsafe version of header_height.

public static float
nmax_x(long struct)

Unsafe version of max_x.

public static NkMenuState
nmenu(long struct)

Unsafe version of menu.

public static IntBuffer
noffset_x(long struct, int capacity)

Unsafe version of offset_x.

public static IntBuffer
noffset_y(long struct, int capacity)

Unsafe version of offset_y.

public static NkPanel
nparent(long struct)

Unsafe version of parent.

public static NkRowLayout
nrow(long struct)

Unsafe version of row.

public static int
ntype(long struct)

Unsafe version of type.

public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the offset_x field.
offset_x(int
the number of elements in the returned buffer
capacity)

public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the offset_y field.
offset_y(int
the number of elements in the returned buffer
capacity)

public NkPanel

Returns:

a NkPanel view of the struct pointed to by the parent field.
parent()

public NkRowLayout

Returns:

a NkRowLayout view of the row field.
row()

public int
sizeof()

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

Returns sizeof(struct).
public int
type()

one of:

PANEL_NONEPANEL_WINDOWPANEL_GROUPPANEL_POPUPPANEL_CONTEXTUALPANEL_COMBOPANEL_MENUPANEL_TOOLTIPPANEL_SET_NONBLOCKPANEL_SET_POPUPPANEL_SET_SUB
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.

AT_Xback to summary
public static final int AT_X

The struct member offsets.

AT_Yback to summary
public static final int AT_Y

The struct member offsets.

BORDERback to summary
public static final int BORDER

The struct member offsets.

BOUNDSback to summary
public static final int BOUNDS

The struct member offsets.

BUFFERback to summary
public static final int BUFFER

The struct member offsets.

CHARTback to summary
public static final int CHART

The struct member offsets.

CLIPback to summary
public static final int CLIP

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

HAS_SCROLLINGback to summary
public static final int HAS_SCROLLING

The struct member offsets.

HEADER_HEIGHTback to summary
public static final int HEADER_HEIGHT

The struct member offsets.

MAX_Xback to summary
public static final int MAX_X

The struct member offsets.

OFFSET_Xback to summary
public static final int OFFSET_X

The struct member offsets.

OFFSET_Yback to summary
public static final int OFFSET_Y

The struct member offsets.

PARENTback to summary
public static final int PARENT

The struct member offsets.

ROWback to summary
public static final int ROW

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

NkPanelback to summary
protected NkPanel(long address, ByteBuffer container)
NkPanelback to summary
public NkPanel(ByteBuffer container)

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

at_xback to summary
public float at_x()
Returns:float

the value of the at_x field.

at_yback to summary
public float at_y()
Returns:float

the value of the at_y field.

borderback to summary
public float border()
Returns:float

the value of the border field.

boundsback to summary
public NkRect bounds()
Returns:NkRect

a NkRect view of the bounds field.

Annotations
@NativeType:struct nk_rect
bufferback to summary
public NkCommandBuffer buffer()
Returns:NkCommandBuffer

a NkCommandBuffer view of the struct pointed to by the buffer field.

Annotations
@NativeType:struct nk_command_buffer *
chartback to summary
public NkChart chart()
Returns:NkChart

a NkChart view of the chart field.

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

a NkRect view of the clip field.

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

Returns a new NkPanel instance for the specified memory address.

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

Create a NkPanel.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkPanel createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()
Returns:int

the value of the flags field.

Annotations
@NativeType:nk_flags
footer_heightback to summary
public float footer_height()
Returns:float

the value of the footer_height field.

has_scrollingback to summary
public int has_scrolling()
Returns:int

the value of the has_scrolling field.

Annotations
@NativeType:unsigned int
header_heightback to summary
public float header_height()
Returns:float

the value of the header_height field.

max_xback to summary
public float max_x()
Returns:float

the value of the max_x field.

menuback to summary
public NkMenuState menu()
Returns:NkMenuState

a NkMenuState view of the menu field.

Annotations
@NativeType:struct nk_menu_state
nat_xback to summary
public static float nat_x(long struct)

Unsafe version of at_x.

nat_yback to summary
public static float nat_y(long struct)

Unsafe version of at_y.

nborderback to summary
public static float nborder(long struct)

Unsafe version of border.

nboundsback to summary
public static NkRect nbounds(long struct)

Unsafe version of bounds.

nbufferback to summary
public static NkCommandBuffer nbuffer(long struct)

Unsafe version of buffer.

nchartback to summary
public static NkChart nchart(long struct)

Unsafe version of chart.

nclipback to summary
public static NkRect nclip(long struct)

Unsafe version of clip.

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nfooter_heightback to summary
public static float nfooter_height(long struct)

Unsafe version of footer_height.

nhas_scrollingback to summary
public static int nhas_scrolling(long struct)

Unsafe version of has_scrolling.

nheader_heightback to summary
public static float nheader_height(long struct)

Unsafe version of header_height.

nmax_xback to summary
public static float nmax_x(long struct)

Unsafe version of max_x.

nmenuback to summary
public static NkMenuState nmenu(long struct)

Unsafe version of menu.

noffset_xback to summary
public static IntBuffer noffset_x(long struct, int capacity)

Unsafe version of offset_x.

noffset_yback to summary
public static IntBuffer noffset_y(long struct, int capacity)

Unsafe version of offset_y.

nparentback to summary
public static NkPanel nparent(long struct)

Unsafe version of parent.

nrowback to summary
public static NkRowLayout nrow(long struct)

Unsafe version of row.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

offset_xback to summary
public IntBuffer offset_x(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:IntBuffer

a IntBuffer view of the data pointed to by the offset_x field.

Annotations
@NativeType:nk_uint *
offset_yback to summary
public IntBuffer offset_y(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:IntBuffer

a IntBuffer view of the data pointed to by the offset_y field.

Annotations
@NativeType:nk_uint *
parentback to summary
public NkPanel parent()
Returns:NkPanel

a NkPanel view of the struct pointed to by the parent field.

Annotations
@NativeType:struct nk_panel *
rowback to summary
public NkRowLayout row()
Returns:NkRowLayout

a NkRowLayout view of the row field.

Annotations
@NativeType:struct nk_row_layout
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
typeback to summary
public int type()

one of:

PANEL_NONEPANEL_WINDOWPANEL_GROUPPANEL_POPUPPANEL_CONTEXTUALPANEL_COMBO
PANEL_MENUPANEL_TOOLTIPPANEL_SET_NONBLOCKPANEL_SET_POPUPPANEL_SET_SUB
Annotations
@NativeType:enum nk_panel_type
org.lwjgl.nuklear back to summary

public Class NkPanel.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final NkPanel
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkPanel.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 float

Returns:

the value of the at_x field.
at_x()

public float

Returns:

the value of the at_y field.
at_y()

public float

Returns:

the value of the border field.
border()

public NkRect

Returns:

a NkRect view of the bounds field.
bounds()

public NkCommandBuffer

Returns:

a NkCommandBuffer view of the struct pointed to by the buffer field.
buffer()

public NkChart

Returns:

a NkChart view of the chart field.
chart()

public NkRect

Returns:

a NkRect view of the clip field.
clip()

public int

Returns:

the value of the flags field.
flags()

public float

Returns:

the value of the footer_height field.
footer_height()

protected NkPanel
getElementFactory()

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

public int

Returns:

the value of the has_scrolling field.
has_scrolling()

public float

Returns:

the value of the header_height field.
header_height()

public float

Returns:

the value of the max_x field.
max_x()

public NkMenuState

Returns:

a NkMenuState view of the menu field.
menu()

public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the offset_x field.
offset_x(int
the number of elements in the returned buffer
capacity)

public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the offset_y field.
offset_y(int
the number of elements in the returned buffer
capacity)

public NkPanel

Returns:

a NkPanel view of the struct pointed to by the parent field.
parent()

public NkRowLayout

Returns:

a NkRowLayout view of the row field.
row()

protected NkPanel.Buffer
self()

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

public int

Returns:

the value of the NkPanel#type field.
type()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final NkPanel ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

at_xback to summary
public float at_x()
Returns:float

the value of the at_x field.

at_yback to summary
public float at_y()
Returns:float

the value of the at_y field.

borderback to summary
public float border()
Returns:float

the value of the border field.

boundsback to summary
public NkRect bounds()
Returns:NkRect

a NkRect view of the bounds field.

Annotations
@NativeType:struct nk_rect
bufferback to summary
public NkCommandBuffer buffer()
Returns:NkCommandBuffer

a NkCommandBuffer view of the struct pointed to by the buffer field.

Annotations
@NativeType:struct nk_command_buffer *
chartback to summary
public NkChart chart()
Returns:NkChart

a NkChart view of the chart field.

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

a NkRect view of the clip field.

Annotations
@NativeType:struct nk_rect
flagsback to summary
public int flags()
Returns:int

the value of the flags field.

Annotations
@NativeType:nk_flags
footer_heightback to summary
public float footer_height()
Returns:float

the value of the footer_height field.

getElementFactoryback to summary
protected NkPanel getElementFactory()

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

Annotations
@Override
has_scrollingback to summary
public int has_scrolling()
Returns:int

the value of the has_scrolling field.

Annotations
@NativeType:unsigned int
header_heightback to summary
public float header_height()
Returns:float

the value of the header_height field.

max_xback to summary
public float max_x()
Returns:float

the value of the max_x field.

menuback to summary
public NkMenuState menu()
Returns:NkMenuState

a NkMenuState view of the menu field.

Annotations
@NativeType:struct nk_menu_state
offset_xback to summary
public IntBuffer offset_x(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:IntBuffer

a IntBuffer view of the data pointed to by the offset_x field.

Annotations
@NativeType:nk_uint *
offset_yback to summary
public IntBuffer offset_y(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:IntBuffer

a IntBuffer view of the data pointed to by the offset_y field.

Annotations
@NativeType:nk_uint *
parentback to summary
public NkPanel parent()
Returns:NkPanel

a NkPanel view of the struct pointed to by the parent field.

Annotations
@NativeType:struct nk_panel *
rowback to summary
public NkRowLayout row()
Returns:NkRowLayout

a NkRowLayout view of the row field.

Annotations
@NativeType:struct nk_row_layout
selfback to summary
protected NkPanel.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the NkPanel#type field.

Annotations
@NativeType:enum nk_panel_type