org.lwjgl.nuklear.NkCommandBuffer 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.system.*;
import static org.lwjgl.system.MemoryUtil.*;
/**
* Layout
*
*
* struct nk_command_buffer {
* {@link NkBuffer struct nk_buffer} * base;
* {@link NkRect struct nk_rect} clip;
* int use_clipping;
* {@link NkHandle nk_handle} userdata;
* nk_size begin;
* nk_size end;
* nk_size last;
* }
*/
@NativeType("struct nk_command_buffer")
public class NkCommandBuffer extends Struct {
/** 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
BASE,
CLIP,
USE_CLIPPING,
USERDATA,
BEGIN,
END,
LAST;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(NkRect.SIZEOF, NkRect.ALIGNOF),
__member(4),
__member(NkHandle.SIZEOF, NkHandle.ALIGNOF),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
BASE = layout.offsetof(0);
CLIP = layout.offsetof(1);
USE_CLIPPING = layout.offsetof(2);
USERDATA = layout.offsetof(3);
BEGIN = layout.offsetof(4);
END = layout.offsetof(5);
LAST = layout.offsetof(6);
}
NkCommandBuffer(long address, @Nullable ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link NkCommandBuffer} 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 NkCommandBuffer(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns a {@link NkBuffer} view of the struct pointed to by the {@code base} field. */
@Nullable
@NativeType("struct nk_buffer *")
public NkBuffer base() { return nbase(address()); }
/** Returns a {@link NkRect} view of the {@code clip} field. */
@NativeType("struct nk_rect")
public NkRect clip() { return nclip(address()); }
/** Passes the {@code clip} field to the specified {@link java.util.function.Consumer Consumer}. */
public NkCommandBuffer clip(java.util.function.Consumer consumer) { consumer.accept(clip()); return this; }
/** Returns the value of the {@code use_clipping} field. */
public int use_clipping() { return nuse_clipping(address()); }
/** Returns a {@link NkHandle} view of the {@code userdata} field. */
@NativeType("nk_handle")
public NkHandle userdata() { return nuserdata(address()); }
/** Passes the {@code userdata} field to the specified {@link java.util.function.Consumer Consumer}. */
public NkCommandBuffer userdata(java.util.function.Consumer consumer) { consumer.accept(userdata()); return this; }
/** Returns the value of the {@code begin} field. */
@NativeType("nk_size")
public long begin() { return nbegin(address()); }
/** Returns the value of the {@code end} field. */
@NativeType("nk_size")
public long end() { return nend(address()); }
/** Returns the value of the {@code last} field. */
@NativeType("nk_size")
public long last() { return nlast(address()); }
// -----------------------------------
/** Returns a new {@link NkCommandBuffer} instance for the specified memory address. */
public static NkCommandBuffer create(long address) {
return new NkCommandBuffer(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static NkCommandBuffer createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Create a {@link NkCommandBuffer.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static NkCommandBuffer.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 NkCommandBuffer.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Unsafe version of {@link #base}. */
@Nullable public static NkBuffer nbase(long struct) { return NkBuffer.createSafe(memGetAddress(struct + NkCommandBuffer.BASE)); }
/** Unsafe version of {@link #clip}. */
public static NkRect nclip(long struct) { return NkRect.create(struct + NkCommandBuffer.CLIP); }
/** Unsafe version of {@link #use_clipping}. */
public static int nuse_clipping(long struct) { return memGetInt(struct + NkCommandBuffer.USE_CLIPPING); }
/** Unsafe version of {@link #userdata}. */
public static NkHandle nuserdata(long struct) { return NkHandle.create(struct + NkCommandBuffer.USERDATA); }
/** Unsafe version of {@link #begin}. */
public static long nbegin(long struct) { return memGetAddress(struct + NkCommandBuffer.BEGIN); }
/** Unsafe version of {@link #end}. */
public static long nend(long struct) { return memGetAddress(struct + NkCommandBuffer.END); }
/** Unsafe version of {@link #last}. */
public static long nlast(long struct) { return memGetAddress(struct + NkCommandBuffer.LAST); }
// -----------------------------------
/** An array of {@link NkCommandBuffer} structs. */
public static class Buffer extends StructBuffer {
/**
* Creates a new {@link NkCommandBuffer.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 NkCommandBuffer#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 NkCommandBuffer newInstance(long address) {
return new NkCommandBuffer(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns a {@link NkBuffer} view of the struct pointed to by the {@code base} field. */
@Nullable
@NativeType("struct nk_buffer *")
public NkBuffer base() { return NkCommandBuffer.nbase(address()); }
/** Returns a {@link NkRect} view of the {@code clip} field. */
@NativeType("struct nk_rect")
public NkRect clip() { return NkCommandBuffer.nclip(address()); }
/** Passes the {@code clip} field to the specified {@link java.util.function.Consumer Consumer}. */
public NkCommandBuffer.Buffer clip(java.util.function.Consumer consumer) { consumer.accept(clip()); return this; }
/** Returns the value of the {@code use_clipping} field. */
public int use_clipping() { return NkCommandBuffer.nuse_clipping(address()); }
/** Returns a {@link NkHandle} view of the {@code userdata} field. */
@NativeType("nk_handle")
public NkHandle userdata() { return NkCommandBuffer.nuserdata(address()); }
/** Passes the {@code userdata} field to the specified {@link java.util.function.Consumer Consumer}. */
public NkCommandBuffer.Buffer userdata(java.util.function.Consumer consumer) { consumer.accept(userdata()); return this; }
/** Returns the value of the {@code begin} field. */
@NativeType("nk_size")
public long begin() { return NkCommandBuffer.nbegin(address()); }
/** Returns the value of the {@code end} field. */
@NativeType("nk_size")
public long end() { return NkCommandBuffer.nend(address()); }
/** Returns the value of the {@code last} field. */
@NativeType("nk_size")
public long last() { return NkCommandBuffer.nlast(address()); }
}
}