NkUserFont (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class NkUserFont
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Member documentation
- userdata – user provided font handle
- height – max height of the font
- width – font string width in pixel callback
- query – font glyph callback to query drawing info
- texture – texture handle to the used font atlas or texture
Layout
```
 struct nk_user_font {
     nk_handle userdata;
     float height;
     nk_text_width_f width;
     nk_query_font_glyph_f query;
     nk_handle texture;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NkUserFont.Buffer
An array of NkUserFont 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`	`NkUserFont.Buffer` An array of `NkUserFont` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`HEIGHT` The struct member offsets.
`static int`	`QUERY` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`TEXTURE` The struct member offsets.
`static int`	`USERDATA` The struct member offsets.
`static int`	`WIDTH` 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

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

Constructors
Constructor and Description
`NkUserFont(java.nio.ByteBuffer container)` Creates a `NkUserFont` 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 NkUserFont`	`calloc()` Returns a new `NkUserFont` instance allocated with `memCalloc`.
`static NkUserFont.Buffer`	`calloc(int capacity)` Returns a new `NkUserFont.Buffer` instance allocated with `memCalloc`.
`static NkUserFont`	`callocStack()` Returns a new `NkUserFont` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkUserFont.Buffer`	`callocStack(int capacity)` Returns a new `NkUserFont.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkUserFont.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkUserFont.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static NkUserFont`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkUserFont` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static NkUserFont`	`create()` Returns a new `NkUserFont` instance allocated with `BufferUtils`.
`static NkUserFont.Buffer`	`create(int capacity)` Returns a new `NkUserFont.Buffer` instance allocated with `BufferUtils`.
`static NkUserFont`	`create(long address)` Returns a new `NkUserFont` instance for the specified memory address.
`static NkUserFont.Buffer`	`create(long address, int capacity)` Create a `NkUserFont.Buffer` instance at the specified memory.
`static NkUserFont`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static NkUserFont.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`float`	`height()` Returns the value of the `height` field.
`NkUserFont`	`height(float value)` Sets the specified value to the `height` field.
`static NkUserFont`	`malloc()` Returns a new `NkUserFont` instance allocated with `memAlloc`.
`static NkUserFont.Buffer`	`malloc(int capacity)` Returns a new `NkUserFont.Buffer` instance allocated with `memAlloc`.
`static NkUserFont`	`mallocStack()` Returns a new `NkUserFont` instance allocated on the thread-local `MemoryStack`.
`static NkUserFont.Buffer`	`mallocStack(int capacity)` Returns a new `NkUserFont.Buffer` instance allocated on the thread-local `MemoryStack`.
`static NkUserFont.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkUserFont.Buffer` instance allocated on the specified `MemoryStack`.
`static NkUserFont`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkUserFont` instance allocated on the specified `MemoryStack`.
`static float`	`nheight(long struct)` Unsafe version of `height()`.
`static void`	`nheight(long struct, float value)` Unsafe version of `height`.
`static NkQueryFontGlyphCallback`	`nquery(long struct)` Unsafe version of `query()`.
`static void`	`nquery(long struct, NkQueryFontGlyphCallbackI value)` Unsafe version of `query`.
`static NkHandle`	`ntexture(long struct)` Unsafe version of `texture()`.
`static void`	`ntexture(long struct, NkHandle value)` Unsafe version of `texture`.
`static NkHandle`	`nuserdata(long struct)` Unsafe version of `userdata()`.
`static void`	`nuserdata(long struct, NkHandle value)` Unsafe version of `userdata`.
`static NkTextWidthCallback`	`nwidth(long struct)` Unsafe version of `width()`.
`static void`	`nwidth(long struct, NkTextWidthCallbackI value)` Unsafe version of `width`.
`NkQueryFontGlyphCallback`	`query()` Returns the value of the `query` field.
`NkUserFont`	`query(NkQueryFontGlyphCallbackI value)` Sets the specified value to the `query` field.
`NkUserFont`	`set(NkHandle userdata, float height, NkTextWidthCallbackI width, NkQueryFontGlyphCallbackI query, NkHandle texture)` Initializes this struct with the specified values.
`NkUserFont`	`set(NkUserFont src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`NkHandle`	`texture()` Returns a `NkHandle` view of the `texture` field.
`NkUserFont`	`texture(java.util.function.Consumer<NkHandle> consumer)` Passes the `texture` field to the specified `Consumer`.
`NkUserFont`	`texture(NkHandle value)` Copies the specified `NkHandle` to the `texture` field.
`NkHandle`	`userdata()` Returns a `NkHandle` view of the `userdata` field.
`NkUserFont`	`userdata(java.util.function.Consumer<NkHandle> consumer)` Passes the `userdata` field to the specified `Consumer`.
`NkUserFont`	`userdata(NkHandle value)` Copies the specified `NkHandle` to the `userdata` field.
`NkTextWidthCallback`	`width()` Returns the value of the `width` field.
`NkUserFont`	`width(NkTextWidthCallbackI value)` Sets the specified value to the `width` 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.
  - HEIGHT
```
public static final int HEIGHT
```
    The struct member offsets.
  - WIDTH
```
public static final int WIDTH
```
    The struct member offsets.
  - QUERY
```
public static final int QUERY
```
    The struct member offsets.
  - TEXTURE
```
public static final int TEXTURE
```
    The struct member offsets.
- Constructor Detail
  - NkUserFont
```
public NkUserFont(java.nio.ByteBuffer container)
```
    Creates a NkUserFont 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.
  - height
```
public float height()
```
    Returns the value of the height field.
  - width
```
@Nullable
public NkTextWidthCallback width()
```
    Returns the value of the width field.
  - query
```
@Nullable
public NkQueryFontGlyphCallback query()
```
    Returns the value of the query field.
  - texture
```
public NkHandle texture()
```
    Returns a NkHandle view of the texture field.
  - userdata
```
public NkUserFont userdata(NkHandle value)
```
    Copies the specified NkHandle to the userdata field.
  - userdata
```
public NkUserFont userdata(java.util.function.Consumer<NkHandle> consumer)
```
    Passes the userdata field to the specified Consumer.
  - height
```
public NkUserFont height(float value)
```
    Sets the specified value to the height field.
  - width
```
public NkUserFont width(@Nullable
                        NkTextWidthCallbackI value)
```
    Sets the specified value to the width field.
  - query
```
public NkUserFont query(@Nullable
                        NkQueryFontGlyphCallbackI value)
```
    Sets the specified value to the query field.
  - texture
```
public NkUserFont texture(NkHandle value)
```
    Copies the specified NkHandle to the texture field.
  - texture
```
public NkUserFont texture(java.util.function.Consumer<NkHandle> consumer)
```
    Passes the texture field to the specified Consumer.
  - set
```
public NkUserFont set(NkHandle userdata,
                      float height,
                      NkTextWidthCallbackI width,
                      NkQueryFontGlyphCallbackI query,
                      NkHandle texture)
```
    Initializes this struct with the specified values.
  - set
```
public NkUserFont set(NkUserFont src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static NkUserFont malloc()
```
    Returns a new NkUserFont instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static NkUserFont calloc()
```
    Returns a new NkUserFont instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static NkUserFont create()
```
    Returns a new NkUserFont instance allocated with BufferUtils.
  - create
```
public static NkUserFont create(long address)
```
    Returns a new NkUserFont instance for the specified memory address.
  - createSafe
```
@Nullable
public static NkUserFont createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static NkUserFont.Buffer malloc(int capacity)
```
    Returns a new NkUserFont.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static NkUserFont.Buffer calloc(int capacity)
```
    Returns a new NkUserFont.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkUserFont.Buffer create(int capacity)
```
    Returns a new NkUserFont.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkUserFont.Buffer create(long address,
                                       int capacity)
```
    Create a NkUserFont.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static NkUserFont.Buffer createSafe(long address,
                                                     int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static NkUserFont mallocStack()
```
    Returns a new NkUserFont instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static NkUserFont callocStack()
```
    Returns a new NkUserFont instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static NkUserFont mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkUserFont instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static NkUserFont callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkUserFont instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static NkUserFont.Buffer mallocStack(int capacity)
```
    Returns a new NkUserFont.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static NkUserFont.Buffer callocStack(int capacity)
```
    Returns a new NkUserFont.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static NkUserFont.Buffer mallocStack(int capacity,
                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkUserFont.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static NkUserFont.Buffer callocStack(int capacity,
                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkUserFont.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().
  - nheight
```
public static float nheight(long struct)
```
    Unsafe version of height().
  - nwidth
```
@Nullable
public static NkTextWidthCallback nwidth(long struct)
```
    Unsafe version of width().
  - nquery
```
@Nullable
public static NkQueryFontGlyphCallback nquery(long struct)
```
    Unsafe version of query().
  - ntexture
```
public static NkHandle ntexture(long struct)
```
    Unsafe version of texture().
  - nuserdata
```
public static void nuserdata(long struct,
                             NkHandle value)
```
    Unsafe version of userdata.
  - nheight
```
public static void nheight(long struct,
                           float value)
```
    Unsafe version of height.
  - nwidth
```
public static void nwidth(long struct,
                          @Nullable
                          NkTextWidthCallbackI value)
```
    Unsafe version of width.
  - nquery
```
public static void nquery(long struct,
                          @Nullable
                          NkQueryFontGlyphCallbackI value)
```
    Unsafe version of query.
  - ntexture
```
public static void ntexture(long struct,
                            NkHandle value)
```
    Unsafe version of texture.

Class NkUserFont

Member documentation

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

HEIGHT

WIDTH

QUERY

TEXTURE

Constructor Detail

NkUserFont

Method Detail

sizeof

userdata

height

width

query

texture

userdata

userdata

height

width

query

texture

texture

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nuserdata

nheight

nwidth

nquery

ntexture

nuserdata

nheight

nwidth

nquery

ntexture