Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkColor

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

Layout


struct nk_color {
    nk_byte r;
    nk_byte g;
    nk_byte b;
    nk_byte a;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NkColor.Buffer

An array of NkColor structs.

Field Summary

Modifier and TypeField and Description
public static final int
A

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
B

The struct member offsets.

public static final int
G

The struct member offsets.

public static final int
R

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
NkColor(long address, ByteBuffer container)

public
NkColor(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public byte

Returns:

the value of the a field.
a
()

public NkColor
a(byte value)

Sets the specified value to the a field.

public byte

Returns:

the value of the b field.
b
()

public NkColor
b(byte value)

Sets the specified value to the b field.

public static NkColor
calloc()

Returns a new NkColor instance allocated with memCalloc.

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

Returns a new NkColor.Buffer instance allocated with memCalloc.

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

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

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

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

public static NkColor
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected NkColor
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 NkColor
create()

Returns a new NkColor instance allocated with BufferUtils.

public static NkColor
create(long address)

Returns a new NkColor instance for the specified memory address.

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

Returns a new NkColor.Buffer instance allocated with BufferUtils.

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

Create a NkColor.Buffer instance at the specified memory.

public static NkColor
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public byte

Returns:

the value of the g field.
g
()

public NkColor
g(byte value)

Sets the specified value to the g field.

public static NkColor
malloc()

Returns a new NkColor instance allocated with memAlloc.

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

Returns a new NkColor.Buffer instance allocated with memAlloc.

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

Returns a new NkColor instance allocated on the specified MemoryStack.

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

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

public static NkColor
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static byte
na(long struct)

Unsafe version of a.

public static void
na(long struct, byte value)

Unsafe version of a.

public static byte
nb(long struct)

Unsafe version of b.

public static void
nb(long struct, byte value)

Unsafe version of b.

public static byte
ng(long struct)

Unsafe version of g.

public static void
ng(long struct, byte value)

Unsafe version of g.

public static byte
nr(long struct)

Unsafe version of r.

public static void
nr(long struct, byte value)

Unsafe version of r.

public byte

Returns:

the value of the r field.
r
()

public NkColor
r(byte value)

Sets the specified value to the r field.

public NkColor
set(byte r, byte g, byte b, byte a)

Initializes this struct with the specified values.

public NkColor

Returns:

this struct
set
(NkColor
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

Aback to summary
public static final int A

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

Bback to summary
public static final int B

The struct member offsets.

Gback to summary
public static final int G

The struct member offsets.

Rback to summary
public static final int R

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

NkColorback to summary
protected NkColor(long address, ByteBuffer container)
NkColorback to summary
public NkColor(ByteBuffer container)

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

aback to summary
public byte a()
Returns:byte

the value of the a field.

Annotations
@NativeType:nk_byte
aback to summary
public NkColor a(byte value)

Sets the specified value to the a field.

bback to summary
public byte b()
Returns:byte

the value of the b field.

Annotations
@NativeType:nk_byte
bback to summary
public NkColor b(byte value)

Sets the specified value to the b field.

callocback to summary
public static NkColor calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static NkColor calloc(MemoryStack stack)

Returns a new NkColor 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 NkColor.Buffer calloc(int capacity, MemoryStack stack)

Returns a new NkColor.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 NkColor callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static NkColor.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 NkColor 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 NkColor create()

Returns a new NkColor instance allocated with BufferUtils.

createback to summary
public static NkColor create(long address)

Returns a new NkColor instance for the specified memory address.

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

Returns a new NkColor.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a NkColor.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkColor createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
gback to summary
public byte g()
Returns:byte

the value of the g field.

Annotations
@NativeType:nk_byte
gback to summary
public NkColor g(byte value)

Sets the specified value to the g field.

mallocback to summary
public static NkColor malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static NkColor malloc(MemoryStack stack)

Returns a new NkColor instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new NkColor.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 NkColor mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
naback to summary
public static byte na(long struct)

Unsafe version of a.

naback to summary
public static void na(long struct, byte value)

Unsafe version of a.

nbback to summary
public static byte nb(long struct)

Unsafe version of b.

nbback to summary
public static void nb(long struct, byte value)

Unsafe version of b.

ngback to summary
public static byte ng(long struct)

Unsafe version of g.

ngback to summary
public static void ng(long struct, byte value)

Unsafe version of g.

nrback to summary
public static byte nr(long struct)

Unsafe version of r.

nrback to summary
public static void nr(long struct, byte value)

Unsafe version of r.

rback to summary
public byte r()
Returns:byte

the value of the r field.

Annotations
@NativeType:nk_byte
rback to summary
public NkColor r(byte value)

Sets the specified value to the r field.

setback to summary
public NkColor set(byte r, byte g, byte b, byte a)

Initializes this struct with the specified values.

setback to summary
public NkColor set(NkColor src)

Copies the specified struct data to this struct.

Parameters
src:NkColor

the source struct

Returns:NkColor

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 NkColor.Buffer

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

An array of NkColor structs.

Field Summary

Modifier and TypeField and Description
private static final NkColor

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkColor.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 byte

Returns:

the value of the a field.
a
()

public NkColor.Buffer
a(byte value)

Sets the specified value to the a field.

public byte

Returns:

the value of the b field.
b
()

public NkColor.Buffer
b(byte value)

Sets the specified value to the b field.

public byte

Returns:

the value of the g field.
g
()

public NkColor.Buffer
g(byte value)

Sets the specified value to the g field.

protected NkColor
public byte

Returns:

the value of the r field.
r
()

public NkColor.Buffer
r(byte value)

Sets the specified value to the r field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final NkColor ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

aback to summary
public byte a()
Returns:byte

the value of the a field.

Annotations
@NativeType:nk_byte
aback to summary
public NkColor.Buffer a(byte value)

Sets the specified value to the a field.

bback to summary
public byte b()
Returns:byte

the value of the b field.

Annotations
@NativeType:nk_byte
bback to summary
public NkColor.Buffer b(byte value)

Sets the specified value to the b field.

gback to summary
public byte g()
Returns:byte

the value of the g field.

Annotations
@NativeType:nk_byte
gback to summary
public NkColor.Buffer g(byte value)

Sets the specified value to the g field.

getElementFactoryback to summary
protected NkColor getElementFactory()

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

Annotations
@Override
rback to summary
public byte r()
Returns:byte

the value of the r field.

Annotations
@NativeType:nk_byte
rback to summary
public NkColor.Buffer r(byte value)

Sets the specified value to the r field.

selfback to summary
protected NkColor.Buffer self()

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

Annotations
@Override