org.lwjgl.nuklear.NkUserFontGlyph Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-nuklear Show documentation
Show all versions of lwjgl-nuklear Show documentation
A minimal state immediate mode graphical user interface toolkit.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.nuklear;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Member documentation
*
*
* - {@code uv[2]} – texture coordinates
* - {@code offset} – offset between top left and glyph
* - {@code width} – width of the glyph
* - {@code height} – height of the glyph
* - {@code xadvance} – offset to the next glyph
*
*
* Layout
*
*
* struct nk_user_font_glyph {
* {@link NkVec2 struct nk_vec2} uv[2];
* {@link NkVec2 struct nk_vec2} offset;
* float width;
* float height;
* float xadvance;
* }
*/
@NativeType("struct nk_user_font_glyph")
public class NkUserFontGlyph extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
UV,
OFFSET,
WIDTH,
HEIGHT,
XADVANCE;
static {
Layout layout = __struct(
__array(NkVec2.SIZEOF, NkVec2.ALIGNOF, 2),
__member(NkVec2.SIZEOF, NkVec2.ALIGNOF),
__member(4),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
UV = layout.offsetof(0);
OFFSET = layout.offsetof(1);
WIDTH = layout.offsetof(2);
HEIGHT = layout.offsetof(3);
XADVANCE = layout.offsetof(4);
}
/**
* Creates a {@code NkUserFontGlyph} instance at the current position of the specified {@link 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.
*/
public NkUserFontGlyph(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns a {@link NkVec2}.Buffer view of the {@code uv} field. */
@NativeType("struct nk_vec2[2]")
public NkVec2.Buffer uv() { return nuv(address()); }
/** Returns a {@link NkVec2} view of the struct at the specified index of the {@code uv} field. */
@NativeType("struct nk_vec2")
public NkVec2 uv(int index) { return nuv(address(), index); }
/** Returns a {@link NkVec2} view of the {@code offset} field. */
@NativeType("struct nk_vec2")
public NkVec2 offset() { return noffset(address()); }
/** Returns the value of the {@code width} field. */
public float width() { return nwidth(address()); }
/** Returns the value of the {@code height} field. */
public float height() { return nheight(address()); }
/** Returns the value of the {@code xadvance} field. */
public float xadvance() { return nxadvance(address()); }
/** Copies the specified {@link NkVec2.Buffer} to the {@code uv} field. */
public NkUserFontGlyph uv(@NativeType("struct nk_vec2[2]") NkVec2.Buffer value) { nuv(address(), value); return this; }
/** Copies the specified {@link NkVec2} at the specified index of the {@code uv} field. */
public NkUserFontGlyph uv(int index, @NativeType("struct nk_vec2") NkVec2 value) { nuv(address(), index, value); return this; }
/** Passes the {@code uv} field to the specified {@link java.util.function.Consumer Consumer}. */
public NkUserFontGlyph uv(java.util.function.Consumer consumer) { consumer.accept(uv()); return this; }
/** Passes the element at {@code index} of the {@code uv} field to the specified {@link java.util.function.Consumer Consumer}. */
public NkUserFontGlyph uv(int index, java.util.function.Consumer consumer) { consumer.accept(uv(index)); return this; }
/** Copies the specified {@link NkVec2} to the {@code offset} field. */
public NkUserFontGlyph offset(@NativeType("struct nk_vec2") NkVec2 value) { noffset(address(), value); return this; }
/** Passes the {@code offset} field to the specified {@link java.util.function.Consumer Consumer}. */
public NkUserFontGlyph offset(java.util.function.Consumer consumer) { consumer.accept(offset()); return this; }
/** Sets the specified value to the {@code width} field. */
public NkUserFontGlyph width(float value) { nwidth(address(), value); return this; }
/** Sets the specified value to the {@code height} field. */
public NkUserFontGlyph height(float value) { nheight(address(), value); return this; }
/** Sets the specified value to the {@code xadvance} field. */
public NkUserFontGlyph xadvance(float value) { nxadvance(address(), value); return this; }
/** Initializes this struct with the specified values. */
public NkUserFontGlyph set(
NkVec2.Buffer uv,
NkVec2 offset,
float width,
float height,
float xadvance
) {
uv(uv);
offset(offset);
width(width);
height(height);
xadvance(xadvance);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public NkUserFontGlyph set(NkUserFontGlyph src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code NkUserFontGlyph} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static NkUserFontGlyph malloc() {
return wrap(NkUserFontGlyph.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code NkUserFontGlyph} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static NkUserFontGlyph calloc() {
return wrap(NkUserFontGlyph.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code NkUserFontGlyph} instance allocated with {@link BufferUtils}. */
public static NkUserFontGlyph create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(NkUserFontGlyph.class, memAddress(container), container);
}
/** Returns a new {@code NkUserFontGlyph} instance for the specified memory address. */
public static NkUserFontGlyph create(long address) {
return wrap(NkUserFontGlyph.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static NkUserFontGlyph createSafe(long address) {
return address == NULL ? null : wrap(NkUserFontGlyph.class, address);
}
/**
* Returns a new {@link NkUserFontGlyph.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static NkUserFontGlyph.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link NkUserFontGlyph.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static NkUserFontGlyph.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link NkUserFontGlyph.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static NkUserFontGlyph.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link NkUserFontGlyph.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static NkUserFontGlyph.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static NkUserFontGlyph.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Returns a new {@code NkUserFontGlyph} instance allocated on the thread-local {@link MemoryStack}. */
public static NkUserFontGlyph mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@code NkUserFontGlyph} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static NkUserFontGlyph callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@code NkUserFontGlyph} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static NkUserFontGlyph mallocStack(MemoryStack stack) {
return wrap(NkUserFontGlyph.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code NkUserFontGlyph} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static NkUserFontGlyph callocStack(MemoryStack stack) {
return wrap(NkUserFontGlyph.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link NkUserFontGlyph.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static NkUserFontGlyph.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link NkUserFontGlyph.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static NkUserFontGlyph.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link NkUserFontGlyph.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static NkUserFontGlyph.Buffer mallocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link NkUserFontGlyph.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static NkUserFontGlyph.Buffer callocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #uv}. */
public static NkVec2.Buffer nuv(long struct) { return NkVec2.create(struct + NkUserFontGlyph.UV, 2); }
/** Unsafe version of {@link #uv(int) uv}. */
public static NkVec2 nuv(long struct, int index) {
return NkVec2.create(struct + NkUserFontGlyph.UV + check(index, 2) * NkVec2.SIZEOF);
}
/** Unsafe version of {@link #offset}. */
public static NkVec2 noffset(long struct) { return NkVec2.create(struct + NkUserFontGlyph.OFFSET); }
/** Unsafe version of {@link #width}. */
public static float nwidth(long struct) { return UNSAFE.getFloat(null, struct + NkUserFontGlyph.WIDTH); }
/** Unsafe version of {@link #height}. */
public static float nheight(long struct) { return UNSAFE.getFloat(null, struct + NkUserFontGlyph.HEIGHT); }
/** Unsafe version of {@link #xadvance}. */
public static float nxadvance(long struct) { return UNSAFE.getFloat(null, struct + NkUserFontGlyph.XADVANCE); }
/** Unsafe version of {@link #uv(NkVec2.Buffer) uv}. */
public static void nuv(long struct, NkVec2.Buffer value) {
if (CHECKS) { checkGT(value, 2); }
memCopy(value.address(), struct + NkUserFontGlyph.UV, value.remaining() * NkVec2.SIZEOF);
}
/** Unsafe version of {@link #uv(int, NkVec2) uv}. */
public static void nuv(long struct, int index, NkVec2 value) {
memCopy(value.address(), struct + NkUserFontGlyph.UV + check(index, 2) * NkVec2.SIZEOF, NkVec2.SIZEOF);
}
/** Unsafe version of {@link #offset(NkVec2) offset}. */
public static void noffset(long struct, NkVec2 value) { memCopy(value.address(), struct + NkUserFontGlyph.OFFSET, NkVec2.SIZEOF); }
/** Unsafe version of {@link #width(float) width}. */
public static void nwidth(long struct, float value) { UNSAFE.putFloat(null, struct + NkUserFontGlyph.WIDTH, value); }
/** Unsafe version of {@link #height(float) height}. */
public static void nheight(long struct, float value) { UNSAFE.putFloat(null, struct + NkUserFontGlyph.HEIGHT, value); }
/** Unsafe version of {@link #xadvance(float) xadvance}. */
public static void nxadvance(long struct, float value) { UNSAFE.putFloat(null, struct + NkUserFontGlyph.XADVANCE, value); }
// -----------------------------------
/** An array of {@link NkUserFontGlyph} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final NkUserFontGlyph ELEMENT_FACTORY = NkUserFontGlyph.create(-1L);
/**
* Creates a new {@code NkUserFontGlyph.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 {@link NkUserFontGlyph#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected NkUserFontGlyph getElementFactory() {
return ELEMENT_FACTORY;
}
/** Returns a {@link NkVec2}.Buffer view of the {@code uv} field. */
@NativeType("struct nk_vec2[2]")
public NkVec2.Buffer uv() { return NkUserFontGlyph.nuv(address()); }
/** Returns a {@link NkVec2} view of the struct at the specified index of the {@code uv} field. */
@NativeType("struct nk_vec2")
public NkVec2 uv(int index) { return NkUserFontGlyph.nuv(address(), index); }
/** Returns a {@link NkVec2} view of the {@code offset} field. */
@NativeType("struct nk_vec2")
public NkVec2 offset() { return NkUserFontGlyph.noffset(address()); }
/** Returns the value of the {@code width} field. */
public float width() { return NkUserFontGlyph.nwidth(address()); }
/** Returns the value of the {@code height} field. */
public float height() { return NkUserFontGlyph.nheight(address()); }
/** Returns the value of the {@code xadvance} field. */
public float xadvance() { return NkUserFontGlyph.nxadvance(address()); }
/** Copies the specified {@link NkVec2.Buffer} to the {@code uv} field. */
public NkUserFontGlyph.Buffer uv(@NativeType("struct nk_vec2[2]") NkVec2.Buffer value) { NkUserFontGlyph.nuv(address(), value); return this; }
/** Copies the specified {@link NkVec2} at the specified index of the {@code uv} field. */
public NkUserFontGlyph.Buffer uv(int index, @NativeType("struct nk_vec2") NkVec2 value) { NkUserFontGlyph.nuv(address(), index, value); return this; }
/** Passes the {@code uv} field to the specified {@link java.util.function.Consumer Consumer}. */
public NkUserFontGlyph.Buffer uv(java.util.function.Consumer consumer) { consumer.accept(uv()); return this; }
/** Passes the element at {@code index} of the {@code uv} field to the specified {@link java.util.function.Consumer Consumer}. */
public NkUserFontGlyph.Buffer uv(int index, java.util.function.Consumer consumer) { consumer.accept(uv(index)); return this; }
/** Copies the specified {@link NkVec2} to the {@code offset} field. */
public NkUserFontGlyph.Buffer offset(@NativeType("struct nk_vec2") NkVec2 value) { NkUserFontGlyph.noffset(address(), value); return this; }
/** Passes the {@code offset} field to the specified {@link java.util.function.Consumer Consumer}. */
public NkUserFontGlyph.Buffer offset(java.util.function.Consumer consumer) { consumer.accept(offset()); return this; }
/** Sets the specified value to the {@code width} field. */
public NkUserFontGlyph.Buffer width(float value) { NkUserFontGlyph.nwidth(address(), value); return this; }
/** Sets the specified value to the {@code height} field. */
public NkUserFontGlyph.Buffer height(float value) { NkUserFontGlyph.nheight(address(), value); return this; }
/** Sets the specified value to the {@code xadvance} field. */
public NkUserFontGlyph.Buffer xadvance(float value) { NkUserFontGlyph.nxadvance(address(), value); return this; }
}
}