org.lwjgl.nuklear.NkDrawVertexLayoutElement 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.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Member documentation
*
*
* - {@code attribute} – the vertex attribute. One of:
{@link Nuklear#NK_VERTEX_POSITION VERTEX_POSITION} {@link Nuklear#NK_VERTEX_COLOR VERTEX_COLOR} {@link Nuklear#NK_VERTEX_TEXCOORD VERTEX_TEXCOORD} {@link Nuklear#NK_VERTEX_ATTRIBUTE_COUNT VERTEX_ATTRIBUTE_COUNT}
* - {@code format} – the vertex attribute format. One of:
{@link Nuklear#NK_FORMAT_SCHAR FORMAT_SCHAR} {@link Nuklear#NK_FORMAT_SSHORT FORMAT_SSHORT} {@link Nuklear#NK_FORMAT_SINT FORMAT_SINT} {@link Nuklear#NK_FORMAT_UCHAR FORMAT_UCHAR} {@link Nuklear#NK_FORMAT_USHORT FORMAT_USHORT} {@link Nuklear#NK_FORMAT_UINT FORMAT_UINT} {@link Nuklear#NK_FORMAT_FLOAT FORMAT_FLOAT} {@link Nuklear#NK_FORMAT_DOUBLE FORMAT_DOUBLE} {@link Nuklear#NK_FORMAT_R8G8B8 FORMAT_R8G8B8} {@link Nuklear#NK_FORMAT_R16G15B16 FORMAT_R16G15B16} {@link Nuklear#NK_FORMAT_R32G32B32 FORMAT_R32G32B32} {@link Nuklear#NK_FORMAT_R8G8B8A8 FORMAT_R8G8B8A8} {@link Nuklear#NK_FORMAT_B8G8R8A8 FORMAT_B8G8R8A8} {@link Nuklear#NK_FORMAT_R16G15B16A16 FORMAT_R16G15B16A16} {@link Nuklear#NK_FORMAT_R32G32B32A32 FORMAT_R32G32B32A32} {@link Nuklear#NK_FORMAT_R32G32B32A32_FLOAT FORMAT_R32G32B32A32_FLOAT} {@link Nuklear#NK_FORMAT_R32G32B32A32_DOUBLE FORMAT_R32G32B32A32_DOUBLE} {@link Nuklear#NK_FORMAT_RGB32 FORMAT_RGB32} {@link Nuklear#NK_FORMAT_RGBA32 FORMAT_RGBA32}
* - {@code offset} – the vertex attribute offset
*
*
* Layout
*
*
* struct nk_draw_vertex_layout_element {
* enum nk_draw_vertex_layout_attribute attribute;
* enum nk_draw_vertex_layout_format format;
* nk_size offset;
* }
*/
@NativeType("struct nk_draw_vertex_layout_element")
public class NkDrawVertexLayoutElement 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
ATTRIBUTE,
FORMAT,
OFFSET;
static {
Layout layout = __struct(
__member(4),
__member(4),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
ATTRIBUTE = layout.offsetof(0);
FORMAT = layout.offsetof(1);
OFFSET = layout.offsetof(2);
}
NkDrawVertexLayoutElement(long address, @Nullable ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link NkDrawVertexLayoutElement} 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 NkDrawVertexLayoutElement(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code attribute} field. */
@NativeType("enum nk_draw_vertex_layout_attribute")
public int attribute() { return nattribute(address()); }
/** Returns the value of the {@code format} field. */
@NativeType("enum nk_draw_vertex_layout_format")
public int format() { return nformat(address()); }
/** Returns the value of the {@code offset} field. */
@NativeType("nk_size")
public long offset() { return noffset(address()); }
/** Sets the specified value to the {@code attribute} field. */
public NkDrawVertexLayoutElement attribute(@NativeType("enum nk_draw_vertex_layout_attribute") int value) { nattribute(address(), value); return this; }
/** Sets the specified value to the {@code format} field. */
public NkDrawVertexLayoutElement format(@NativeType("enum nk_draw_vertex_layout_format") int value) { nformat(address(), value); return this; }
/** Sets the specified value to the {@code offset} field. */
public NkDrawVertexLayoutElement offset(@NativeType("nk_size") long value) { noffset(address(), value); return this; }
/** Initializes this struct with the specified values. */
public NkDrawVertexLayoutElement set(
int attribute,
int format,
long offset
) {
attribute(attribute);
format(format);
offset(offset);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public NkDrawVertexLayoutElement set(NkDrawVertexLayoutElement src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link NkDrawVertexLayoutElement} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static NkDrawVertexLayoutElement malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link NkDrawVertexLayoutElement} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static NkDrawVertexLayoutElement calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link NkDrawVertexLayoutElement} instance allocated with {@link BufferUtils}. */
public static NkDrawVertexLayoutElement create() {
return new NkDrawVertexLayoutElement(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link NkDrawVertexLayoutElement} instance for the specified memory address. */
public static NkDrawVertexLayoutElement create(long address) {
return new NkDrawVertexLayoutElement(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static NkDrawVertexLayoutElement createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link NkDrawVertexLayoutElement.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static NkDrawVertexLayoutElement.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link NkDrawVertexLayoutElement.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static NkDrawVertexLayoutElement.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link NkDrawVertexLayoutElement.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static NkDrawVertexLayoutElement.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link NkDrawVertexLayoutElement.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static NkDrawVertexLayoutElement.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static NkDrawVertexLayoutElement.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link NkDrawVertexLayoutElement} instance allocated on the thread-local {@link MemoryStack}. */
public static NkDrawVertexLayoutElement mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link NkDrawVertexLayoutElement} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static NkDrawVertexLayoutElement callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link NkDrawVertexLayoutElement} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static NkDrawVertexLayoutElement mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link NkDrawVertexLayoutElement} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static NkDrawVertexLayoutElement callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link NkDrawVertexLayoutElement.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static NkDrawVertexLayoutElement.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link NkDrawVertexLayoutElement.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static NkDrawVertexLayoutElement.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link NkDrawVertexLayoutElement.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static NkDrawVertexLayoutElement.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link NkDrawVertexLayoutElement.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 NkDrawVertexLayoutElement.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #attribute}. */
public static int nattribute(long struct) { return memGetInt(struct + NkDrawVertexLayoutElement.ATTRIBUTE); }
/** Unsafe version of {@link #format}. */
public static int nformat(long struct) { return memGetInt(struct + NkDrawVertexLayoutElement.FORMAT); }
/** Unsafe version of {@link #offset}. */
public static long noffset(long struct) { return memGetAddress(struct + NkDrawVertexLayoutElement.OFFSET); }
/** Unsafe version of {@link #attribute(int) attribute}. */
public static void nattribute(long struct, int value) { memPutInt(struct + NkDrawVertexLayoutElement.ATTRIBUTE, value); }
/** Unsafe version of {@link #format(int) format}. */
public static void nformat(long struct, int value) { memPutInt(struct + NkDrawVertexLayoutElement.FORMAT, value); }
/** Unsafe version of {@link #offset(long) offset}. */
public static void noffset(long struct, long value) { memPutAddress(struct + NkDrawVertexLayoutElement.OFFSET, value); }
// -----------------------------------
/** An array of {@link NkDrawVertexLayoutElement} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link NkDrawVertexLayoutElement.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 NkDrawVertexLayoutElement#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 Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected NkDrawVertexLayoutElement newInstance(long address) {
return new NkDrawVertexLayoutElement(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code attribute} field. */
@NativeType("enum nk_draw_vertex_layout_attribute")
public int attribute() { return NkDrawVertexLayoutElement.nattribute(address()); }
/** Returns the value of the {@code format} field. */
@NativeType("enum nk_draw_vertex_layout_format")
public int format() { return NkDrawVertexLayoutElement.nformat(address()); }
/** Returns the value of the {@code offset} field. */
@NativeType("nk_size")
public long offset() { return NkDrawVertexLayoutElement.noffset(address()); }
/** Sets the specified value to the {@code attribute} field. */
public NkDrawVertexLayoutElement.Buffer attribute(@NativeType("enum nk_draw_vertex_layout_attribute") int value) { NkDrawVertexLayoutElement.nattribute(address(), value); return this; }
/** Sets the specified value to the {@code format} field. */
public NkDrawVertexLayoutElement.Buffer format(@NativeType("enum nk_draw_vertex_layout_format") int value) { NkDrawVertexLayoutElement.nformat(address(), value); return this; }
/** Sets the specified value to the {@code offset} field. */
public NkDrawVertexLayoutElement.Buffer offset(@NativeType("nk_size") long value) { NkDrawVertexLayoutElement.noffset(address(), value); return this; }
}
}