NkClipboard (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.nuklear.NkClipboard

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class NkClipboard
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Layout


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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NkClipboard.Buffer
An array of NkClipboard structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`NkClipboard.Buffer` An array of `NkClipboard` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`COPY` The struct member offsets.
`static int`	`PASTE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`USERDATA` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`NkClipboard(java.nio.ByteBuffer container)` Creates a `NkClipboard` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static NkClipboard`	`calloc()` Returns a new `NkClipboard` instance allocated with `memCalloc`.
`static NkClipboard.Buffer`	`calloc(int capacity)` Returns a new `NkClipboard.Buffer` instance allocated with `memCalloc`.
`static NkClipboard`	`callocStack()` Returns a new `NkClipboard` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkClipboard.Buffer`	`callocStack(int capacity)` Returns a new `NkClipboard.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkClipboard.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkClipboard.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static NkClipboard`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkClipboard` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`NkPluginCopy`	`copy()` Returns the value of the `copy` field.
`NkClipboard`	`copy(NkPluginCopyI value)` Sets the specified value to the `copy` field.
`static NkClipboard`	`create()` Returns a new `NkClipboard` instance allocated with `BufferUtils`.
`static NkClipboard.Buffer`	`create(int capacity)` Returns a new `NkClipboard.Buffer` instance allocated with `BufferUtils`.
`static NkClipboard`	`create(long address)` Returns a new `NkClipboard` instance for the specified memory address.
`static NkClipboard.Buffer`	`create(long address, int capacity)` Create a `NkClipboard.Buffer` instance at the specified memory.
`static NkClipboard`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static NkClipboard.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static NkClipboard`	`malloc()` Returns a new `NkClipboard` instance allocated with `memAlloc`.
`static NkClipboard.Buffer`	`malloc(int capacity)` Returns a new `NkClipboard.Buffer` instance allocated with `memAlloc`.
`static NkClipboard`	`mallocStack()` Returns a new `NkClipboard` instance allocated on the thread-local `MemoryStack`.
`static NkClipboard.Buffer`	`mallocStack(int capacity)` Returns a new `NkClipboard.Buffer` instance allocated on the thread-local `MemoryStack`.
`static NkClipboard.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkClipboard.Buffer` instance allocated on the specified `MemoryStack`.
`static NkClipboard`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkClipboard` instance allocated on the specified `MemoryStack`.
`static NkPluginCopy`	`ncopy(long struct)` Unsafe version of `copy()`.
`static void`	`ncopy(long struct, NkPluginCopyI value)` Unsafe version of `copy`.
`static NkPluginPaste`	`npaste(long struct)` Unsafe version of `paste()`.
`static void`	`npaste(long struct, NkPluginPasteI value)` Unsafe version of `paste`.
`static NkHandle`	`nuserdata(long struct)` Unsafe version of `userdata()`.
`static void`	`nuserdata(long struct, NkHandle value)` Unsafe version of `userdata`.
`NkPluginPaste`	`paste()` Returns the value of the `paste` field.
`NkClipboard`	`paste(NkPluginPasteI value)` Sets the specified value to the `paste` field.
`NkClipboard`	`set(NkClipboard src)` Copies the specified struct data to this struct.
`NkClipboard`	`set(NkHandle userdata, NkPluginPasteI paste, NkPluginCopyI copy)` Initializes this struct with the specified values.
`int`	`sizeof()`
`NkHandle`	`userdata()` Returns a `NkHandle` view of the `userdata` field.
`NkClipboard`	`userdata(java.util.function.Consumer<NkHandle> consumer)` Passes the `userdata` field to the specified `Consumer`.
`NkClipboard`	`userdata(NkHandle value)` Copies the specified `NkHandle` to the `userdata` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - USERDATA
```
public static final int USERDATA
```
    The struct member offsets.
  - PASTE
```
public static final int PASTE
```
    The struct member offsets.
  - COPY
```
public static final int COPY
```
    The struct member offsets.
- Constructor Detail
  - NkClipboard
```
public NkClipboard(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - userdata
```
public NkHandle userdata()
```
    Returns a NkHandle view of the userdata field.
  - paste
```
@Nullable
public NkPluginPaste paste()
```
    Returns the value of the paste field.
  - copy
```
@Nullable
public NkPluginCopy copy()
```
    Returns the value of the copy field.
  - userdata
```
public NkClipboard userdata(NkHandle value)
```
    Copies the specified NkHandle to the userdata field.
  - userdata
```
public NkClipboard userdata(java.util.function.Consumer<NkHandle> consumer)
```
    Passes the userdata field to the specified Consumer.
  - paste
```
public NkClipboard paste(@Nullable
                         NkPluginPasteI value)
```
    Sets the specified value to the paste field.
  - copy
```
public NkClipboard copy(@Nullable
                        NkPluginCopyI value)
```
    Sets the specified value to the copy field.
  - set
```
public NkClipboard set(NkHandle userdata,
                       NkPluginPasteI paste,
                       NkPluginCopyI copy)
```
    Initializes this struct with the specified values.
  - set
```
public NkClipboard set(NkClipboard src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static NkClipboard malloc()
```
    Returns a new NkClipboard instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static NkClipboard calloc()
```
    Returns a new NkClipboard instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static NkClipboard create()
```
    Returns a new NkClipboard instance allocated with BufferUtils.
  - create
```
public static NkClipboard create(long address)
```
    Returns a new NkClipboard instance for the specified memory address.
  - createSafe
```
@Nullable
public static NkClipboard createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static NkClipboard.Buffer malloc(int capacity)
```
    Returns a new NkClipboard.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static NkClipboard.Buffer calloc(int capacity)
```
    Returns a new NkClipboard.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkClipboard.Buffer create(int capacity)
```
    Returns a new NkClipboard.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkClipboard.Buffer create(long address,
                                        int capacity)
```
    Create a NkClipboard.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static NkClipboard.Buffer createSafe(long address,
                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static NkClipboard mallocStack()
```
    Returns a new NkClipboard instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static NkClipboard callocStack()
```
    Returns a new NkClipboard instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static NkClipboard mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkClipboard instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static NkClipboard callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkClipboard instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static NkClipboard.Buffer mallocStack(int capacity)
```
    Returns a new NkClipboard.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static NkClipboard.Buffer callocStack(int capacity)
```
    Returns a new NkClipboard.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static NkClipboard.Buffer mallocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkClipboard.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static NkClipboard.Buffer callocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkClipboard.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nuserdata
```
public static NkHandle nuserdata(long struct)
```
    Unsafe version of userdata().
  - npaste
```
@Nullable
public static NkPluginPaste npaste(long struct)
```
    Unsafe version of paste().
  - ncopy
```
@Nullable
public static NkPluginCopy ncopy(long struct)
```
    Unsafe version of copy().
  - nuserdata
```
public static void nuserdata(long struct,
                             NkHandle value)
```
    Unsafe version of userdata.
  - npaste
```
public static void npaste(long struct,
                          @Nullable
                          NkPluginPasteI value)
```
    Unsafe version of paste.
  - ncopy
```
public static void ncopy(long struct,
                         @Nullable
                         NkPluginCopyI value)
```
    Unsafe version of copy.

Class NkClipboard

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

USERDATA

PASTE

COPY

Constructor Detail

NkClipboard

Method Detail

sizeof

userdata

paste

copy

userdata

userdata

paste

copy

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nuserdata

npaste

ncopy

nuserdata

npaste

ncopy