org.lwjgl.openxr.XrDebugUtilsLabelEXT Maven / Gradle / Ivy
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.openxr;
import org.jspecify.annotations.*;
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.*;
/**
* Debug Utils Label.
*
* Valid Usage (Implicit)
*
*
* - The {@link EXTDebugUtils XR_EXT_debug_utils} extension must be enabled prior to using {@link XrDebugUtilsLabelEXT}
* - {@code type} must be {@link EXTDebugUtils#XR_TYPE_DEBUG_UTILS_LABEL_EXT TYPE_DEBUG_UTILS_LABEL_EXT}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
* - {@code labelName} must be a null-terminated UTF-8 string
*
*
* See Also
*
* {@link XrDebugUtilsMessengerCallbackDataEXT}, {@link EXTDebugUtils#xrSessionBeginDebugUtilsLabelRegionEXT SessionBeginDebugUtilsLabelRegionEXT}, {@link EXTDebugUtils#xrSessionInsertDebugUtilsLabelEXT SessionInsertDebugUtilsLabelEXT}
*
* Layout
*
*
* struct XrDebugUtilsLabelEXT {
* XrStructureType {@link #type};
* void const * {@link #next};
* char const * {@link #labelName};
* }
*/
public class XrDebugUtilsLabelEXT 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
TYPE,
NEXT,
LABELNAME;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
LABELNAME = layout.offsetof(2);
}
protected XrDebugUtilsLabelEXT(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrDebugUtilsLabelEXT create(long address, @Nullable ByteBuffer container) {
return new XrDebugUtilsLabelEXT(address, container);
}
/**
* Creates a {@code XrDebugUtilsLabelEXT} 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 XrDebugUtilsLabelEXT(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** the {@code XrStructureType} of this structure. */
@NativeType("XrStructureType")
public int type() { return ntype(address()); }
/** {@code NULL} or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension. */
@NativeType("void const *")
public long next() { return nnext(address()); }
/** a {@code NULL} terminated UTF-8 string specifying the label name. */
@NativeType("char const *")
public ByteBuffer labelName() { return nlabelName(address()); }
/** a {@code NULL} terminated UTF-8 string specifying the label name. */
@NativeType("char const *")
public String labelNameString() { return nlabelNameString(address()); }
/** Sets the specified value to the {@link #type} field. */
public XrDebugUtilsLabelEXT type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link EXTDebugUtils#XR_TYPE_DEBUG_UTILS_LABEL_EXT TYPE_DEBUG_UTILS_LABEL_EXT} value to the {@link #type} field. */
public XrDebugUtilsLabelEXT type$Default() { return type(EXTDebugUtils.XR_TYPE_DEBUG_UTILS_LABEL_EXT); }
/** Sets the specified value to the {@link #next} field. */
public XrDebugUtilsLabelEXT next(@NativeType("void const *") long value) { nnext(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@link #labelName} field. */
public XrDebugUtilsLabelEXT labelName(@NativeType("char const *") ByteBuffer value) { nlabelName(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrDebugUtilsLabelEXT set(
int type,
long next,
ByteBuffer labelName
) {
type(type);
next(next);
labelName(labelName);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrDebugUtilsLabelEXT set(XrDebugUtilsLabelEXT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrDebugUtilsLabelEXT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrDebugUtilsLabelEXT malloc() {
return new XrDebugUtilsLabelEXT(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrDebugUtilsLabelEXT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrDebugUtilsLabelEXT calloc() {
return new XrDebugUtilsLabelEXT(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrDebugUtilsLabelEXT} instance allocated with {@link BufferUtils}. */
public static XrDebugUtilsLabelEXT create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrDebugUtilsLabelEXT(memAddress(container), container);
}
/** Returns a new {@code XrDebugUtilsLabelEXT} instance for the specified memory address. */
public static XrDebugUtilsLabelEXT create(long address) {
return new XrDebugUtilsLabelEXT(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrDebugUtilsLabelEXT createSafe(long address) {
return address == NULL ? null : new XrDebugUtilsLabelEXT(address, null);
}
/**
* Returns a new {@link XrDebugUtilsLabelEXT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrDebugUtilsLabelEXT.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrDebugUtilsLabelEXT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrDebugUtilsLabelEXT.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrDebugUtilsLabelEXT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrDebugUtilsLabelEXT.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrDebugUtilsLabelEXT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrDebugUtilsLabelEXT.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}. */
public static XrDebugUtilsLabelEXT.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrDebugUtilsLabelEXT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrDebugUtilsLabelEXT malloc(MemoryStack stack) {
return new XrDebugUtilsLabelEXT(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrDebugUtilsLabelEXT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrDebugUtilsLabelEXT calloc(MemoryStack stack) {
return new XrDebugUtilsLabelEXT(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrDebugUtilsLabelEXT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrDebugUtilsLabelEXT.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrDebugUtilsLabelEXT.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 XrDebugUtilsLabelEXT.Buffer calloc(int capacity, MemoryStack stack) {
return new Buffer(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #type}. */
public static int ntype(long struct) { return memGetInt(struct + XrDebugUtilsLabelEXT.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrDebugUtilsLabelEXT.NEXT); }
/** Unsafe version of {@link #labelName}. */
public static ByteBuffer nlabelName(long struct) { return memByteBufferNT1(memGetAddress(struct + XrDebugUtilsLabelEXT.LABELNAME)); }
/** Unsafe version of {@link #labelNameString}. */
public static String nlabelNameString(long struct) { return memUTF8(memGetAddress(struct + XrDebugUtilsLabelEXT.LABELNAME)); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrDebugUtilsLabelEXT.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrDebugUtilsLabelEXT.NEXT, value); }
/** Unsafe version of {@link #labelName(ByteBuffer) labelName}. */
public static void nlabelName(long struct, ByteBuffer value) {
if (CHECKS) { checkNT1(value); }
memPutAddress(struct + XrDebugUtilsLabelEXT.LABELNAME, memAddress(value));
}
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + XrDebugUtilsLabelEXT.LABELNAME));
}
// -----------------------------------
/** An array of {@link XrDebugUtilsLabelEXT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrDebugUtilsLabelEXT ELEMENT_FACTORY = XrDebugUtilsLabelEXT.create(-1L);
/**
* Creates a new {@code XrDebugUtilsLabelEXT.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 XrDebugUtilsLabelEXT#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 create(long address, @Nullable ByteBuffer container, int mark, int position, int limit, int capacity) {
return new Buffer(address, container, mark, position, limit, capacity);
}
@Override
protected XrDebugUtilsLabelEXT getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrDebugUtilsLabelEXT#type} field. */
@NativeType("XrStructureType")
public int type() { return XrDebugUtilsLabelEXT.ntype(address()); }
/** @return the value of the {@link XrDebugUtilsLabelEXT#next} field. */
@NativeType("void const *")
public long next() { return XrDebugUtilsLabelEXT.nnext(address()); }
/** @return a {@link ByteBuffer} view of the null-terminated string pointed to by the {@link XrDebugUtilsLabelEXT#labelName} field. */
@NativeType("char const *")
public ByteBuffer labelName() { return XrDebugUtilsLabelEXT.nlabelName(address()); }
/** @return the null-terminated string pointed to by the {@link XrDebugUtilsLabelEXT#labelName} field. */
@NativeType("char const *")
public String labelNameString() { return XrDebugUtilsLabelEXT.nlabelNameString(address()); }
/** Sets the specified value to the {@link XrDebugUtilsLabelEXT#type} field. */
public XrDebugUtilsLabelEXT.Buffer type(@NativeType("XrStructureType") int value) { XrDebugUtilsLabelEXT.ntype(address(), value); return this; }
/** Sets the {@link EXTDebugUtils#XR_TYPE_DEBUG_UTILS_LABEL_EXT TYPE_DEBUG_UTILS_LABEL_EXT} value to the {@link XrDebugUtilsLabelEXT#type} field. */
public XrDebugUtilsLabelEXT.Buffer type$Default() { return type(EXTDebugUtils.XR_TYPE_DEBUG_UTILS_LABEL_EXT); }
/** Sets the specified value to the {@link XrDebugUtilsLabelEXT#next} field. */
public XrDebugUtilsLabelEXT.Buffer next(@NativeType("void const *") long value) { XrDebugUtilsLabelEXT.nnext(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@link XrDebugUtilsLabelEXT#labelName} field. */
public XrDebugUtilsLabelEXT.Buffer labelName(@NativeType("char const *") ByteBuffer value) { XrDebugUtilsLabelEXT.nlabelName(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy