Top Description Inners Fields Constructors Methods
org.lwjgl.nuklear

public Class NkUserFont

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

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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
NkUserFont.Buffer

An array of NkUserFont structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HEIGHT

The struct member offsets.

public static final int
QUERY

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TEXTURE

The struct member offsets.

public static final int
USERDATA

The struct member offsets.

public static final int
WIDTH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
NkUserFont(long address, ByteBuffer container)

public
NkUserFont(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static NkUserFont
calloc()

Returns a new NkUserFont instance allocated with memCalloc.

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

Returns a new NkUserFont.Buffer instance allocated with memCalloc.

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

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

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

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

public static NkUserFont
callocStack()

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

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

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

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

Returns a new NkUserFont instance allocated with BufferUtils.

public static NkUserFont
create(long address)

Returns a new NkUserFont instance for the specified memory address.

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

Returns a new NkUserFont.Buffer instance allocated with BufferUtils.

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

Create a NkUserFont.Buffer instance at the specified memory.

public static NkUserFont
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public float
height()

max height of the font

public NkUserFont
height(float value)

Sets the specified value to the height field.

public static NkUserFont
malloc()

Returns a new NkUserFont instance allocated with memAlloc.

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

Returns a new NkUserFont.Buffer instance allocated with memAlloc.

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

Returns a new NkUserFont instance allocated on the specified MemoryStack.

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

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

public static NkUserFont
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static float
nheight(long struct)

Unsafe version of height.

public static void
nheight(long struct, float value)

Unsafe version of height.

public static NkQueryFontGlyphCallback
nquery(long struct)

Unsafe version of query.

public static void
nquery(long struct, NkQueryFontGlyphCallbackI value)

Unsafe version of query.

public static NkHandle
ntexture(long struct)

Unsafe version of texture.

public static void
ntexture(long struct, NkHandle value)

Unsafe version of texture.

public static NkHandle
nuserdata(long struct)

Unsafe version of userdata.

public static void
nuserdata(long struct, NkHandle value)

Unsafe version of userdata.

public static NkTextWidthCallback
nwidth(long struct)

Unsafe version of width.

public static void
nwidth(long struct, NkTextWidthCallbackI value)

Unsafe version of width.

public NkQueryFontGlyphCallback
query()

font glyph callback to query drawing info

public NkUserFont
query(NkQueryFontGlyphCallbackI value)

Sets the specified value to the query field.

public NkUserFont
set(NkHandle userdata, float height, NkTextWidthCallbackI width, NkQueryFontGlyphCallbackI query, NkHandle texture)

Initializes this struct with the specified values.

public NkUserFont

Returns:

this struct
set(NkUserFont
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
texture()

texture handle to the used font atlas or texture

public NkUserFont
texture(NkHandle value)

Copies the specified NkHandle to the texture field.

public NkUserFont
texture(Consumer<NkHandle> consumer)

Passes the texture field to the specified Consumer.

public NkHandle
userdata()

user provided font handle

public NkUserFont
userdata(NkHandle value)

Copies the specified NkHandle to the userdata field.

public NkUserFont
userdata(Consumer<NkHandle> consumer)

Passes the userdata field to the specified Consumer.

public NkTextWidthCallback
width()

font string width in pixel callback

public NkUserFont
width(NkTextWidthCallbackI value)

Sets the specified value to the width field.

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.

HEIGHTback to summary
public static final int HEIGHT

The struct member offsets.

QUERYback to summary
public static final int QUERY

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TEXTUREback to summary
public static final int TEXTURE

The struct member offsets.

USERDATAback to summary
public static final int USERDATA

The struct member offsets.

WIDTHback to summary
public static final int WIDTH

The struct member offsets.

Constructor Detail

NkUserFontback to summary
protected NkUserFont(long address, ByteBuffer container)
NkUserFontback to summary
public NkUserFont(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

callocback to summary
public static NkUserFont calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static NkUserFont calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new NkUserFont instance allocated with BufferUtils.

createback to summary
public static NkUserFont create(long address)

Returns a new NkUserFont instance for the specified memory address.

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

Returns a new NkUserFont.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a NkUserFont.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NkUserFont createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
heightback to summary
public float height()

max height of the font

heightback to summary
public NkUserFont height(float value)

Sets the specified value to the height field.

mallocback to summary
public static NkUserFont malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static NkUserFont malloc(MemoryStack stack)

Returns a new NkUserFont instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nheightback to summary
public static float nheight(long struct)

Unsafe version of height.

nheightback to summary
public static void nheight(long struct, float value)

Unsafe version of height.

nqueryback to summary
public static NkQueryFontGlyphCallback nquery(long struct)

Unsafe version of query.

Annotations
@Nullable
nqueryback to summary
public static void nquery(long struct, NkQueryFontGlyphCallbackI value)

Unsafe version of query.

ntextureback to summary
public static NkHandle ntexture(long struct)

Unsafe version of texture.

ntextureback to summary
public static void ntexture(long struct, NkHandle value)

Unsafe version of texture.

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.

nwidthback to summary
public static NkTextWidthCallback nwidth(long struct)

Unsafe version of width.

Annotations
@Nullable
nwidthback to summary
public static void nwidth(long struct, NkTextWidthCallbackI value)

Unsafe version of width.

queryback to summary
public NkQueryFontGlyphCallback query()

font glyph callback to query drawing info

Annotations
@Nullable
@NativeType:nk_query_font_glyph_f
queryback to summary
public NkUserFont query(NkQueryFontGlyphCallbackI value)

Sets the specified value to the query field.

setback to summary
public NkUserFont set(NkHandle userdata, float height, NkTextWidthCallbackI width, NkQueryFontGlyphCallbackI query, NkHandle texture)

Initializes this struct with the specified values.

setback to summary
public NkUserFont set(NkUserFont src)

Copies the specified struct data to this struct.

Parameters
src:NkUserFont

the source struct

Returns:NkUserFont

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
textureback to summary
public NkHandle texture()

texture handle to the used font atlas or texture

Annotations
@NativeType:nk_handle
textureback to summary
public NkUserFont texture(NkHandle value)

Copies the specified NkHandle to the texture field.

textureback to summary
public NkUserFont texture(Consumer<NkHandle> consumer)

Passes the texture field to the specified Consumer.

userdataback to summary
public NkHandle userdata()

user provided font handle

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

Copies the specified NkHandle to the userdata field.

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

Passes the userdata field to the specified Consumer.

widthback to summary
public NkTextWidthCallback width()

font string width in pixel callback

Annotations
@Nullable
@NativeType:nk_text_width_f
widthback to summary
public NkUserFont width(NkTextWidthCallbackI value)

Sets the specified value to the width field.

org.lwjgl.nuklear back to summary

public Class NkUserFont.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final NkUserFont
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NkUserFont.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
protected NkUserFont
getElementFactory()

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

public float

Returns:

the value of the NkUserFont#height field.
height()

public NkUserFont.Buffer
height(float value)

Sets the specified value to the NkUserFont#height field.

public NkQueryFontGlyphCallback

Returns:

the value of the NkUserFont#query field.
query()

public NkUserFont.Buffer
query(NkQueryFontGlyphCallbackI value)

Sets the specified value to the NkUserFont#query field.

protected NkUserFont.Buffer
self()

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

public NkHandle

Returns:

a NkHandle view of the NkUserFont#texture field.
texture()

public NkUserFont.Buffer
texture(NkHandle value)

Copies the specified NkHandle to the NkUserFont#texture field.

public NkUserFont.Buffer
texture(Consumer<NkHandle> consumer)

Passes the NkUserFont#texture field to the specified Consumer.

public NkHandle

Returns:

a NkHandle view of the NkUserFont#userdata field.
userdata()

public NkUserFont.Buffer
userdata(NkHandle value)

Copies the specified NkHandle to the NkUserFont#userdata field.

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

Passes the NkUserFont#userdata field to the specified Consumer.

public NkTextWidthCallback

Returns:

the value of the NkUserFont#width field.
width()

public NkUserFont.Buffer
width(NkTextWidthCallbackI value)

Sets the specified value to the NkUserFont#width field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final NkUserFont ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected NkUserFont getElementFactory()

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

Annotations
@Override
heightback to summary
public float height()
Returns:float

the value of the NkUserFont#height field.

heightback to summary
public NkUserFont.Buffer height(float value)

Sets the specified value to the NkUserFont#height field.

queryback to summary
public NkQueryFontGlyphCallback query()
Returns:NkQueryFontGlyphCallback

the value of the NkUserFont#query field.

Annotations
@Nullable
@NativeType:nk_query_font_glyph_f
queryback to summary
public NkUserFont.Buffer query(NkQueryFontGlyphCallbackI value)

Sets the specified value to the NkUserFont#query field.

selfback to summary
protected NkUserFont.Buffer self()

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

Annotations
@Override
textureback to summary
public NkHandle texture()
Returns:NkHandle

a NkHandle view of the NkUserFont#texture field.

Annotations
@NativeType:nk_handle
textureback to summary
public NkUserFont.Buffer texture(NkHandle value)

Copies the specified NkHandle to the NkUserFont#texture field.

textureback to summary
public NkUserFont.Buffer texture(Consumer<NkHandle> consumer)

Passes the NkUserFont#texture field to the specified Consumer.

userdataback to summary
public NkHandle userdata()
Returns:NkHandle

a NkHandle view of the NkUserFont#userdata field.

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

Copies the specified NkHandle to the NkUserFont#userdata field.

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

Passes the NkUserFont#userdata field to the specified Consumer.

widthback to summary
public NkTextWidthCallback width()
Returns:NkTextWidthCallback

the value of the NkUserFont#width field.

Annotations
@Nullable
@NativeType:nk_text_width_f
widthback to summary
public NkUserFont.Buffer width(NkTextWidthCallbackI value)

Sets the specified value to the NkUserFont#width field.