Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkClipboard

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

Layout


struct nk_clipboard {
    nk_handle userdata;
    nk_plugin_paste paste;
    nk_plugin_copy copy;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NkClipboard.Buffer

An array of NkClipboard structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
COPY

The struct member offsets.

public static final int
PASTE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

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

public
NkClipboard(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static NkClipboard
calloc()

Returns a new NkClipboard instance allocated with memCalloc.

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

Returns a new NkClipboard.Buffer instance allocated with memCalloc.

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

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

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

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

public static NkClipboard
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public NkPluginCopy

Returns:

the value of the copy field.
copy()

public NkClipboard
copy(NkPluginCopyI value)

Sets the specified value to the copy field.

protected NkClipboard
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 NkClipboard
create()

Returns a new NkClipboard instance allocated with BufferUtils.

public static NkClipboard
create(long address)

Returns a new NkClipboard instance for the specified memory address.

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

Returns a new NkClipboard.Buffer instance allocated with BufferUtils.

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

Create a NkClipboard.Buffer instance at the specified memory.

public static NkClipboard
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static NkClipboard
malloc()

Returns a new NkClipboard instance allocated with memAlloc.

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

Returns a new NkClipboard.Buffer instance allocated with memAlloc.

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

Returns a new NkClipboard instance allocated on the specified MemoryStack.

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

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

public static NkClipboard
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static NkPluginCopy
ncopy(long struct)

Unsafe version of copy.

public static void
ncopy(long struct, NkPluginCopyI value)

Unsafe version of copy.

public static NkPluginPaste
npaste(long struct)

Unsafe version of paste.

public static void
npaste(long struct, NkPluginPasteI value)

Unsafe version of paste.

public static NkHandle
nuserdata(long struct)

Unsafe version of userdata.

public static void
nuserdata(long struct, NkHandle value)

Unsafe version of userdata.

public NkPluginPaste

Returns:

the value of the paste field.
paste()

public NkClipboard
paste(NkPluginPasteI value)

Sets the specified value to the paste field.

public NkClipboard
set(NkHandle userdata, NkPluginPasteI paste, NkPluginCopyI copy)

Initializes this struct with the specified values.

public NkClipboard

Returns:

this struct
set(NkClipboard
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).
public NkHandle

Returns:

a NkHandle view of the userdata field.
userdata()

public NkClipboard
userdata(NkHandle value)

Copies the specified NkHandle to the userdata field.

public NkClipboard
userdata(Consumer<NkHandle> consumer)

Passes the userdata field to the specified Consumer.

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.

COPYback to summary
public static final int COPY

The struct member offsets.

PASTEback to summary
public static final int PASTE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

USERDATAback to summary
public static final int USERDATA

The struct member offsets.

Constructor Detail

NkClipboardback to summary
protected NkClipboard(long address, ByteBuffer container)
NkClipboardback to summary
public NkClipboard(ByteBuffer container)

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

callocback to summary
public static NkClipboard calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static NkClipboard calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
copyback to summary
public NkPluginCopy copy()
Returns:NkPluginCopy

the value of the copy field.

Annotations
@Nullable
@NativeType:nk_plugin_copy
copyback to summary
public NkClipboard copy(NkPluginCopyI value)

Sets the specified value to the copy field.

createback to summary
protected NkClipboard 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 NkClipboard create()

Returns a new NkClipboard instance allocated with BufferUtils.

createback to summary
public static NkClipboard create(long address)

Returns a new NkClipboard instance for the specified memory address.

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

Returns a new NkClipboard.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a NkClipboard.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkClipboard createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static NkClipboard malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static NkClipboard malloc(MemoryStack stack)

Returns a new NkClipboard instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ncopyback to summary
public static NkPluginCopy ncopy(long struct)

Unsafe version of copy.

Annotations
@Nullable
ncopyback to summary
public static void ncopy(long struct, NkPluginCopyI value)

Unsafe version of copy.

npasteback to summary
public static NkPluginPaste npaste(long struct)

Unsafe version of paste.

Annotations
@Nullable
npasteback to summary
public static void npaste(long struct, NkPluginPasteI value)

Unsafe version of paste.

nuserdataback to summary
public static NkHandle nuserdata(long struct)

Unsafe version of userdata.

nuserdataback to summary
public static void nuserdata(long struct, NkHandle value)

Unsafe version of userdata.

pasteback to summary
public NkPluginPaste paste()
Returns:NkPluginPaste

the value of the paste field.

Annotations
@Nullable
@NativeType:nk_plugin_paste
pasteback to summary
public NkClipboard paste(NkPluginPasteI value)

Sets the specified value to the paste field.

setback to summary
public NkClipboard set(NkHandle userdata, NkPluginPasteI paste, NkPluginCopyI copy)

Initializes this struct with the specified values.

setback to summary
public NkClipboard set(NkClipboard src)

Copies the specified struct data to this struct.

Parameters
src:NkClipboard

the source struct

Returns:NkClipboard

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
userdataback to summary
public NkHandle userdata()
Returns:NkHandle

a NkHandle view of the userdata field.

Annotations
@NativeType:nk_handle
userdataback to summary
public NkClipboard userdata(NkHandle value)

Copies the specified NkHandle to the userdata field.

userdataback to summary
public NkClipboard userdata(Consumer<NkHandle> consumer)

Passes the userdata field to the specified Consumer.

org.lwjgl.nuklear back to summary

public Class NkClipboard.Buffer

extends StructBuffer<NkClipboard, NkClipboard.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of NkClipboard structs.

Field Summary

Modifier and TypeField and Description
private static final NkClipboard
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkClipboard.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 NkPluginCopy

Returns:

the value of the copy field.
copy()

public NkClipboard.Buffer
copy(NkPluginCopyI value)

Sets the specified value to the copy field.

protected NkClipboard
getElementFactory()

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

public NkPluginPaste

Returns:

the value of the paste field.
paste()

public NkClipboard.Buffer
paste(NkPluginPasteI value)

Sets the specified value to the paste field.

protected NkClipboard.Buffer
self()

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

public NkHandle

Returns:

a NkHandle view of the userdata field.
userdata()

public NkClipboard.Buffer
userdata(NkHandle value)

Copies the specified NkHandle to the userdata field.

public NkClipboard.Buffer
userdata(Consumer<NkHandle> consumer)

Passes the userdata field to the specified Consumer.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final NkClipboard ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

copyback to summary
public NkPluginCopy copy()
Returns:NkPluginCopy

the value of the copy field.

Annotations
@Nullable
@NativeType:nk_plugin_copy
copyback to summary
public NkClipboard.Buffer copy(NkPluginCopyI value)

Sets the specified value to the copy field.

getElementFactoryback to summary
protected NkClipboard getElementFactory()

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

Annotations
@Override
pasteback to summary
public NkPluginPaste paste()
Returns:NkPluginPaste

the value of the paste field.

Annotations
@Nullable
@NativeType:nk_plugin_paste
pasteback to summary
public NkClipboard.Buffer paste(NkPluginPasteI value)

Sets the specified value to the paste field.

selfback to summary
protected NkClipboard.Buffer self()

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

Annotations
@Override
userdataback to summary
public NkHandle userdata()
Returns:NkHandle

a NkHandle view of the userdata field.

Annotations
@NativeType:nk_handle
userdataback to summary
public NkClipboard.Buffer userdata(NkHandle value)

Copies the specified NkHandle to the userdata field.

userdataback to summary
public NkClipboard.Buffer userdata(Consumer<NkHandle> consumer)

Passes the userdata field to the specified Consumer.