Package org.lwjgl.nuklear

Class NkImage

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<NkImage>
org.lwjgl.nuklear.NkImage
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class NkImage extends org.lwjgl.system.Struct<NkImage> implements org.lwjgl.system.NativeResource

Layout


 struct nk_image {
     nk_handle handle;
     nk_ushort w;
     nk_ushort h;
     nk_ushort region[4];
 }

  • Nested Class Summary

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

    Nested classes/interfaces inherited from class org.lwjgl.system.Struct

    org.lwjgl.system.Struct.StructValidation

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

    org.lwjgl.system.Pointer.Default

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALIGNOF
    The struct alignment in bytes.
    static final int
    H
    The struct member offsets.
    static final int
    HANDLE
    The struct member offsets.
    static final int
    REGION
    The struct member offsets.
    static final int
    SIZEOF
    The struct size in bytes.
    static final int
    W
    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
    Description
    NkImage(ByteBuffer container)
    Creates a NkImage instance at the current position of the specified ByteBuffer container.

  • Method Summary

    Modifier and Type
    Method
    Description
    static NkImage
    calloc()
    Returns a new NkImage instance allocated with memCalloc.
    static NkImage.Buffer
    calloc(int capacity)
    Returns a new NkImage.Buffer instance allocated with memCalloc.
    static NkImage.Buffer
    calloc(int capacity, org.lwjgl.system.MemoryStack stack)
    Returns a new NkImage.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    static NkImage
    calloc(org.lwjgl.system.MemoryStack stack)
    Returns a new NkImage instance allocated on the specified MemoryStack and initializes all its bits to zero.
    static NkImage
    callocStack()
    Deprecated.
    static NkImage.Buffer
    callocStack(int capacity)
    Deprecated.
    static NkImage.Buffer
    callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static NkImage
    callocStack(org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static NkImage
    create()
    Returns a new NkImage instance allocated with BufferUtils.
    static NkImage.Buffer
    create(int capacity)
    Returns a new NkImage.Buffer instance allocated with BufferUtils.
    static NkImage
    create(long address)
    Returns a new NkImage instance for the specified memory address.
    static NkImage.Buffer
    create(long address, int capacity)
    Create a NkImage.Buffer instance at the specified memory.
    static @Nullable NkImage
    createSafe(long address)
    Like create, but returns null if address is NULL.
    static @Nullable NkImage.Buffer
    createSafe(long address, int capacity)
    Like create, but returns null if address is NULL.
    short
    h()
     
    NkImage
    h(short value)
    Sets the specified value to the h field.
    NkHandle
    handle()
     
    NkImage
    handle(Consumer<NkHandle> consumer)
    Passes the handle field to the specified Consumer.
    NkImage
    handle(NkHandle value)
    Copies the specified NkHandle to the handle field.
    static NkImage
    malloc()
    Returns a new NkImage instance allocated with memAlloc.
    static NkImage.Buffer
    malloc(int capacity)
    Returns a new NkImage.Buffer instance allocated with memAlloc.
    static NkImage.Buffer
    malloc(int capacity, org.lwjgl.system.MemoryStack stack)
    Returns a new NkImage.Buffer instance allocated on the specified MemoryStack.
    static NkImage
    malloc(org.lwjgl.system.MemoryStack stack)
    Returns a new NkImage instance allocated on the specified MemoryStack.
    static NkImage
    mallocStack()
    Deprecated.
    static NkImage.Buffer
    mallocStack(int capacity)
    Deprecated.
    static NkImage.Buffer
    mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static NkImage
    mallocStack(org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static short
    nh(long struct)
    Unsafe version of h().
    static void
    nh(long struct, short value)
    Unsafe version of h.
    static NkHandle
    nhandle(long struct)
    Unsafe version of handle().
    static void
    nhandle(long struct, NkHandle value)
    Unsafe version of handle.
    static ShortBuffer
    nregion(long struct)
    Unsafe version of region().
    static short
    nregion(long struct, int index)
    Unsafe version of region.
    static void
    nregion(long struct, int index, short value)
    Unsafe version of region.
    static void
    nregion(long struct, ShortBuffer value)
    Unsafe version of region.
    static short
    nw(long struct)
    Unsafe version of w().
    static void
    nw(long struct, short value)
    Unsafe version of w.
    ShortBuffer
    region()
     
    short
    region(int index)
     
    NkImage
    region(int index, short value)
    Sets the specified value at the specified index of the region field.
    NkImage
    region(ShortBuffer value)
    Copies the specified ShortBuffer to the region field.
    NkImage
    set(NkHandle handle, short w, short h, ShortBuffer region)
    Initializes this struct with the specified values.
    NkImage
    set(NkImage src)
    Copies the specified struct data to this struct.
    int
    sizeof()
     
    short
    w()
     
    NkImage
    w(short value)
    Sets the specified value to the w field.

    Methods inherited from class org.lwjgl.system.Struct

    clear, free, isNull, validate, validate

    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 Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • HANDLE

      public static final int HANDLE
      The struct member offsets.

    • W

      public static final int W
      The struct member offsets.

    • H

      public static final int H
      The struct member offsets.

    • REGION

      public static final int REGION
      The struct member offsets.

  • Constructor Details

    • NkImage

      public NkImage(ByteBuffer container)
      Creates a NkImage 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 Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<NkImage>

    • handle

      public NkHandle handle()
      Returns:
      a NkHandle view of the handle field.

    • w

      public short w()
      Returns:
      the value of the w field.

    • h

      public short h()
      Returns:
      the value of the h field.

    • region

      public ShortBuffer region()
      Returns:
      a ShortBuffer view of the region field.

    • region

      public short region(int index)
      Returns:
      the value at the specified index of the region field.

    • handle

      public NkImage handle(NkHandle value)
      Copies the specified NkHandle to the handle field.

    • handle

      public NkImage handle(Consumer<NkHandle> consumer)
      Passes the handle field to the specified Consumer.

    • w

      public NkImage w(short value)
      Sets the specified value to the w field.

    • h

      public NkImage h(short value)
      Sets the specified value to the h field.

    • region

      public NkImage region(ShortBuffer value)
      Copies the specified ShortBuffer to the region field.

    • region

      public NkImage region(int index, short value)
      Sets the specified value at the specified index of the region field.

    • set

      public NkImage set(NkHandle handle, short w, short h, ShortBuffer region)
      Initializes this struct with the specified values.

    • set

      public NkImage set(NkImage src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static NkImage malloc()
      Returns a new NkImage instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static NkImage calloc()
      Returns a new NkImage instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static NkImage create()
      Returns a new NkImage instance allocated with BufferUtils.

    • create

      public static NkImage create(long address)
      Returns a new NkImage instance for the specified memory address.

    • createSafe

      public static @Nullable NkImage createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static NkImage.Buffer malloc(int capacity)
      Returns a new NkImage.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static NkImage.Buffer calloc(int capacity)
      Returns a new NkImage.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static NkImage.Buffer create(int capacity)
      Returns a new NkImage.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static NkImage.Buffer create(long address, int capacity)
      Create a NkImage.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable NkImage.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • mallocStack

      @Deprecated public static NkImage mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static NkImage callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static NkImage mallocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static NkImage callocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static NkImage.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static NkImage.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static NkImage.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static NkImage.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

      public static NkImage malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new NkImage instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static NkImage calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new NkImage instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static NkImage.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new NkImage.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static NkImage.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new NkImage.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • nhandle

      public static NkHandle nhandle(long struct)
      Unsafe version of handle().

    • nw

      public static short nw(long struct)
      Unsafe version of w().

    • nh

      public static short nh(long struct)
      Unsafe version of h().

    • nregion

      public static ShortBuffer nregion(long struct)
      Unsafe version of region().

    • nregion

      public static short nregion(long struct, int index)
      Unsafe version of region.

    • nhandle

      public static void nhandle(long struct, NkHandle value)
      Unsafe version of handle.

    • nw

      public static void nw(long struct, short value)
      Unsafe version of w.

    • nh

      public static void nh(long struct, short value)
      Unsafe version of h.

    • nregion

      public static void nregion(long struct, ShortBuffer value)
      Unsafe version of region.

    • nregion

      public static void nregion(long struct, int index, short value)
      Unsafe version of region.