org.lwjgl.openxr.XrHandMeshIndexBufferMSFT 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.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* The index buffer of a hand mesh.
*
* Description
*
* An application should preallocate the indices array using the {@link XrSystemHandTrackingMeshPropertiesMSFT}{@code ::maxHandMeshIndexCount} returned from {@link XR10#xrGetSystemProperties GetSystemProperties}. In this way, the application can avoid possible insufficient buffer sizees for each query, and therefore avoid reallocating memory each frame.
*
* The input {@code indexCapacityInput} must not be 0, and {@code indices} must not be {@code NULL}, or else the runtime must return {@link XR10#XR_ERROR_VALIDATION_FAILURE ERROR_VALIDATION_FAILURE} on calls to the {@link MSFTHandTrackingMesh#xrUpdateHandMeshMSFT UpdateHandMeshMSFT} function.
*
* If the input {@code indexCapacityInput} is not sufficient to contain all output indices, the runtime must return {@link XR10#XR_ERROR_SIZE_INSUFFICIENT ERROR_SIZE_INSUFFICIENT} on calls to {@link MSFTHandTrackingMesh#xrUpdateHandMeshMSFT UpdateHandMeshMSFT}, not change the content in {@code indexBufferKey} and {@code indices}, and return 0 for {@code indexCountOutput}.
*
* If the input {@code indexCapacityInput} is equal to or larger than the {@link XrSystemHandTrackingMeshPropertiesMSFT}{@code ::maxHandMeshIndexCount} returned from {@link XR10#xrGetSystemProperties GetSystemProperties}, the runtime must not return {@link XR10#XR_ERROR_SIZE_INSUFFICIENT ERROR_SIZE_INSUFFICIENT} error on {@link MSFTHandTrackingMesh#xrUpdateHandMeshMSFT UpdateHandMeshMSFT} because of insufficient index buffer size.
*
* If the input {@code indexBufferKey} is 0, the capacity of indices array is sufficient, and hand mesh tracking is active, the runtime must return the latest non-zero {@code indexBufferKey}, and fill in {@code indexCountOutput} and {@code indices}.
*
* If the input {@code indexBufferKey} is not 0, the runtime can either return without changing {@code indexCountOutput} or content in {@code indices}, and return {@link XR10#XR_FALSE FALSE} for {@link XrHandMeshMSFT}{@code ::indexBufferChanged} indicating the indices are not changed; or return a new non-zero {@code indexBufferKey} and fill in latest data in {@code indexCountOutput} and {@code indices}, and return {@link XR10#XR_TRUE TRUE} for {@link XrHandMeshMSFT}{@code ::indexBufferChanged} indicating the indices are updated to a newer version.
*
* An application can keep the {@link XrHandMeshIndexBufferMSFT} structure for each frame in a frame loop and use the returned {@code indexBufferKey} to identify different triangle list topology described in {@code indices}. The application can therefore avoid unnecessary processing of indices, such as coping them to GPU memory.
*
* The runtime must return the same {@code indexBufferKey} for the same {@code XrHandTrackerEXT} at a given time, regardless of the input {@code XrHandPoseTypeMSFT} in {@link XrHandMeshUpdateInfoMSFT}. This ensures the index buffer has the same mesh topology and allows the application to reason about vertices across different hand pose types. For example, the application can build a procedure to perform UV mapping on vertices of a hand mesh using {@link MSFTHandTrackingMesh#XR_HAND_POSE_TYPE_REFERENCE_OPEN_PALM_MSFT HAND_POSE_TYPE_REFERENCE_OPEN_PALM_MSFT}, and apply the resultant UV data on vertices to the mesh returned from the same hand tracker using {@link MSFTHandTrackingMesh#XR_HAND_POSE_TYPE_TRACKED_MSFT HAND_POSE_TYPE_TRACKED_MSFT}.
*
* Valid Usage (Implicit)
*
*
* - The {@link MSFTHandTrackingMesh XR_MSFT_hand_tracking_mesh} extension must be enabled prior to using {@link XrHandMeshIndexBufferMSFT}
* - If {@code indexCapacityInput} is not 0, {@code indices} must be a pointer to an array of {@code indexCapacityInput} {@code uint32_t} values
*
*
* See Also
*
* {@link XrHandMeshMSFT}, {@link XrSystemHandTrackingMeshPropertiesMSFT}, {@link MSFTHandTrackingMesh#xrUpdateHandMeshMSFT UpdateHandMeshMSFT}
*
* Layout
*
*
* struct XrHandMeshIndexBufferMSFT {
* uint32_t {@link #indexBufferKey};
* uint32_t {@link #indexCapacityInput};
* uint32_t {@link #indexCountOutput};
* uint32_t * {@link #indices};
* }
*/
public class XrHandMeshIndexBufferMSFT 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
INDEXBUFFERKEY,
INDEXCAPACITYINPUT,
INDEXCOUNTOUTPUT,
INDICES;
static {
Layout layout = __struct(
__member(4),
__member(4),
__member(4),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
INDEXBUFFERKEY = layout.offsetof(0);
INDEXCAPACITYINPUT = layout.offsetof(1);
INDEXCOUNTOUTPUT = layout.offsetof(2);
INDICES = layout.offsetof(3);
}
protected XrHandMeshIndexBufferMSFT(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrHandMeshIndexBufferMSFT create(long address, @Nullable ByteBuffer container) {
return new XrHandMeshIndexBufferMSFT(address, container);
}
/**
* Creates a {@code XrHandMeshIndexBufferMSFT} 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 XrHandMeshIndexBufferMSFT(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** a {@code uint32_t} serving as the key of the returned index buffer content or 0 to indicate a request to retrieve the latest indices regardless of existing content in {@code indices}. */
@NativeType("uint32_t")
public int indexBufferKey() { return nindexBufferKey(address()); }
/** a positive {@code uint32_t} describes the capacity of the {@code indices} array. */
@NativeType("uint32_t")
public int indexCapacityInput() { return nindexCapacityInput(address()); }
/** a {@code uint32_t} returned by the runtime with the count of indices written in {@code indices}. */
@NativeType("uint32_t")
public int indexCountOutput() { return nindexCountOutput(address()); }
/** an array of indices filled in by the runtime, specifying the indices of the triangles list in the vertex buffer. */
@NativeType("uint32_t *")
public @Nullable IntBuffer indices() { return nindices(address()); }
/** Sets the specified value to the {@link #indexBufferKey} field. */
public XrHandMeshIndexBufferMSFT indexBufferKey(@NativeType("uint32_t") int value) { nindexBufferKey(address(), value); return this; }
/** Sets the specified value to the {@link #indexCapacityInput} field. */
public XrHandMeshIndexBufferMSFT indexCapacityInput(@NativeType("uint32_t") int value) { nindexCapacityInput(address(), value); return this; }
/** Sets the specified value to the {@link #indexCountOutput} field. */
public XrHandMeshIndexBufferMSFT indexCountOutput(@NativeType("uint32_t") int value) { nindexCountOutput(address(), value); return this; }
/** Sets the address of the specified {@link IntBuffer} to the {@link #indices} field. */
public XrHandMeshIndexBufferMSFT indices(@Nullable @NativeType("uint32_t *") IntBuffer value) { nindices(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrHandMeshIndexBufferMSFT set(
int indexBufferKey,
int indexCapacityInput,
int indexCountOutput,
@Nullable IntBuffer indices
) {
indexBufferKey(indexBufferKey);
indexCapacityInput(indexCapacityInput);
indexCountOutput(indexCountOutput);
indices(indices);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrHandMeshIndexBufferMSFT set(XrHandMeshIndexBufferMSFT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrHandMeshIndexBufferMSFT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrHandMeshIndexBufferMSFT malloc() {
return new XrHandMeshIndexBufferMSFT(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrHandMeshIndexBufferMSFT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrHandMeshIndexBufferMSFT calloc() {
return new XrHandMeshIndexBufferMSFT(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrHandMeshIndexBufferMSFT} instance allocated with {@link BufferUtils}. */
public static XrHandMeshIndexBufferMSFT create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrHandMeshIndexBufferMSFT(memAddress(container), container);
}
/** Returns a new {@code XrHandMeshIndexBufferMSFT} instance for the specified memory address. */
public static XrHandMeshIndexBufferMSFT create(long address) {
return new XrHandMeshIndexBufferMSFT(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrHandMeshIndexBufferMSFT createSafe(long address) {
return address == NULL ? null : new XrHandMeshIndexBufferMSFT(address, null);
}
/**
* Returns a new {@link XrHandMeshIndexBufferMSFT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrHandMeshIndexBufferMSFT.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrHandMeshIndexBufferMSFT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrHandMeshIndexBufferMSFT.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrHandMeshIndexBufferMSFT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrHandMeshIndexBufferMSFT.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrHandMeshIndexBufferMSFT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrHandMeshIndexBufferMSFT.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 XrHandMeshIndexBufferMSFT.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrHandMeshIndexBufferMSFT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrHandMeshIndexBufferMSFT malloc(MemoryStack stack) {
return new XrHandMeshIndexBufferMSFT(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrHandMeshIndexBufferMSFT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrHandMeshIndexBufferMSFT calloc(MemoryStack stack) {
return new XrHandMeshIndexBufferMSFT(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrHandMeshIndexBufferMSFT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrHandMeshIndexBufferMSFT.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrHandMeshIndexBufferMSFT.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 XrHandMeshIndexBufferMSFT.Buffer calloc(int capacity, MemoryStack stack) {
return new Buffer(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #indexBufferKey}. */
public static int nindexBufferKey(long struct) { return memGetInt(struct + XrHandMeshIndexBufferMSFT.INDEXBUFFERKEY); }
/** Unsafe version of {@link #indexCapacityInput}. */
public static int nindexCapacityInput(long struct) { return memGetInt(struct + XrHandMeshIndexBufferMSFT.INDEXCAPACITYINPUT); }
/** Unsafe version of {@link #indexCountOutput}. */
public static int nindexCountOutput(long struct) { return memGetInt(struct + XrHandMeshIndexBufferMSFT.INDEXCOUNTOUTPUT); }
/** Unsafe version of {@link #indices() indices}. */
public static @Nullable IntBuffer nindices(long struct) { return memIntBufferSafe(memGetAddress(struct + XrHandMeshIndexBufferMSFT.INDICES), nindexCapacityInput(struct)); }
/** Unsafe version of {@link #indexBufferKey(int) indexBufferKey}. */
public static void nindexBufferKey(long struct, int value) { memPutInt(struct + XrHandMeshIndexBufferMSFT.INDEXBUFFERKEY, value); }
/** Sets the specified value to the {@code indexCapacityInput} field of the specified {@code struct}. */
public static void nindexCapacityInput(long struct, int value) { memPutInt(struct + XrHandMeshIndexBufferMSFT.INDEXCAPACITYINPUT, value); }
/** Unsafe version of {@link #indexCountOutput(int) indexCountOutput}. */
public static void nindexCountOutput(long struct, int value) { memPutInt(struct + XrHandMeshIndexBufferMSFT.INDEXCOUNTOUTPUT, value); }
/** Unsafe version of {@link #indices(IntBuffer) indices}. */
public static void nindices(long struct, @Nullable IntBuffer value) { memPutAddress(struct + XrHandMeshIndexBufferMSFT.INDICES, memAddressSafe(value)); if (value != null) { nindexCapacityInput(struct, value.remaining()); } }
// -----------------------------------
/** An array of {@link XrHandMeshIndexBufferMSFT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrHandMeshIndexBufferMSFT ELEMENT_FACTORY = XrHandMeshIndexBufferMSFT.create(-1L);
/**
* Creates a new {@code XrHandMeshIndexBufferMSFT.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 XrHandMeshIndexBufferMSFT#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 XrHandMeshIndexBufferMSFT getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrHandMeshIndexBufferMSFT#indexBufferKey} field. */
@NativeType("uint32_t")
public int indexBufferKey() { return XrHandMeshIndexBufferMSFT.nindexBufferKey(address()); }
/** @return the value of the {@link XrHandMeshIndexBufferMSFT#indexCapacityInput} field. */
@NativeType("uint32_t")
public int indexCapacityInput() { return XrHandMeshIndexBufferMSFT.nindexCapacityInput(address()); }
/** @return the value of the {@link XrHandMeshIndexBufferMSFT#indexCountOutput} field. */
@NativeType("uint32_t")
public int indexCountOutput() { return XrHandMeshIndexBufferMSFT.nindexCountOutput(address()); }
/** @return a {@link IntBuffer} view of the data pointed to by the {@link XrHandMeshIndexBufferMSFT#indices} field. */
@NativeType("uint32_t *")
public @Nullable IntBuffer indices() { return XrHandMeshIndexBufferMSFT.nindices(address()); }
/** Sets the specified value to the {@link XrHandMeshIndexBufferMSFT#indexBufferKey} field. */
public XrHandMeshIndexBufferMSFT.Buffer indexBufferKey(@NativeType("uint32_t") int value) { XrHandMeshIndexBufferMSFT.nindexBufferKey(address(), value); return this; }
/** Sets the specified value to the {@link XrHandMeshIndexBufferMSFT#indexCapacityInput} field. */
public XrHandMeshIndexBufferMSFT.Buffer indexCapacityInput(@NativeType("uint32_t") int value) { XrHandMeshIndexBufferMSFT.nindexCapacityInput(address(), value); return this; }
/** Sets the specified value to the {@link XrHandMeshIndexBufferMSFT#indexCountOutput} field. */
public XrHandMeshIndexBufferMSFT.Buffer indexCountOutput(@NativeType("uint32_t") int value) { XrHandMeshIndexBufferMSFT.nindexCountOutput(address(), value); return this; }
/** Sets the address of the specified {@link IntBuffer} to the {@link XrHandMeshIndexBufferMSFT#indices} field. */
public XrHandMeshIndexBufferMSFT.Buffer indices(@Nullable @NativeType("uint32_t *") IntBuffer value) { XrHandMeshIndexBufferMSFT.nindices(address(), value); return this; }
}
}