org.lwjgl.openxr.XrHandMeshVertexBufferMSFT Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-openxr Show documentation
Show all versions of lwjgl-openxr Show documentation
A royalty-free, open standard that provides high-performance access to Augmented Reality (AR) and Virtual Reality (VR)—collectively known as XR—platforms and devices.
The newest version!
/*
* 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 vertex buffer of a hand mesh.
*
* Description
*
* An application should preallocate the vertices array using the {@link XrSystemHandTrackingMeshPropertiesMSFT}{@code ::maxHandMeshVertexCount} returned from {@link XR10#xrGetSystemProperties GetSystemProperties}. In this way, the application can avoid possible insufficient buffer sizes for each query, and therefore avoid reallocating memory each frame.
*
* The input {@code vertexCapacityInput} must not be 0, and {@code vertices} 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 vertexCapacityInput} is not sufficient to contain all output vertices, the runtime must return {@link XR10#XR_ERROR_SIZE_INSUFFICIENT ERROR_SIZE_INSUFFICIENT} on calls to the {@link MSFTHandTrackingMesh#xrUpdateHandMeshMSFT UpdateHandMeshMSFT}, do not change content in {@code vertexUpdateTime} and {@code vertices}, and return 0 for {@code vertexCountOutput}.
*
* If the input {@code vertexCapacityInput} is equal to or larger than the {@link XrSystemHandTrackingMeshPropertiesMSFT}{@code ::maxHandMeshVertexCount} returned from {@link XR10#xrGetSystemProperties GetSystemProperties}, the runtime must not return {@link XR10#XR_ERROR_SIZE_INSUFFICIENT ERROR_SIZE_INSUFFICIENT} on calls to the {@link MSFTHandTrackingMesh#xrUpdateHandMeshMSFT UpdateHandMeshMSFT} because of insufficient vertex buffer size.
*
* If the input {@code vertexUpdateTime} is 0, and the capacity of the vertices array is sufficient, and hand mesh tracking is active, the runtime must return the latest non-zero {@code vertexUpdateTime}, and fill in the {@code vertexCountOutput} and {@code vertices} fields.
*
* If the input {@code vertexUpdateTime} is not 0, the runtime can either return without changing {@code vertexCountOutput} or the content in {@code vertices}, and return {@link XR10#XR_FALSE FALSE} for {@link XrHandMeshMSFT}{@code ::vertexBufferChanged} indicating the vertices are not changed; or return a new non-zero {@code vertexUpdateTime} and fill in latest data in {@code vertexCountOutput} and {@code vertices} and return {@link XR10#XR_TRUE TRUE} for {@link XrHandMeshMSFT}{@code ::vertexBufferChanged} indicating the vertices are updated to a newer version.
*
* An application can keep the {@link XrHandMeshVertexBufferMSFT} structure for each frame in frame loop and use the returned {@code vertexUpdateTime} to detect the changes of the content in {@code vertices}. The application can therefore avoid unnecessary processing of vertices, such as coping them to GPU memory.
*
* Valid Usage (Implicit)
*
*
* - The {@link MSFTHandTrackingMesh XR_MSFT_hand_tracking_mesh} extension must be enabled prior to using {@link XrHandMeshVertexBufferMSFT}
* - If {@code vertexCapacityInput} is not 0, {@code vertices} must be a pointer to an array of {@code vertexCapacityInput} {@link XrHandMeshVertexMSFT} structures
*
*
* See Also
*
* {@link XrHandMeshMSFT}, {@link XrHandMeshVertexMSFT}, {@link XrSystemHandTrackingMeshPropertiesMSFT}, {@link MSFTHandTrackingMesh#xrUpdateHandMeshMSFT UpdateHandMeshMSFT}
*
* Layout
*
*
* struct XrHandMeshVertexBufferMSFT {
* XrTime {@link #vertexUpdateTime};
* uint32_t {@link #vertexCapacityInput};
* uint32_t {@link #vertexCountOutput};
* {@link XrHandMeshVertexMSFT XrHandMeshVertexMSFT} * {@link #vertices};
* }
*/
public class XrHandMeshVertexBufferMSFT 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
VERTEXUPDATETIME,
VERTEXCAPACITYINPUT,
VERTEXCOUNTOUTPUT,
VERTICES;
static {
Layout layout = __struct(
__member(8),
__member(4),
__member(4),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
VERTEXUPDATETIME = layout.offsetof(0);
VERTEXCAPACITYINPUT = layout.offsetof(1);
VERTEXCOUNTOUTPUT = layout.offsetof(2);
VERTICES = layout.offsetof(3);
}
protected XrHandMeshVertexBufferMSFT(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrHandMeshVertexBufferMSFT create(long address, @Nullable ByteBuffer container) {
return new XrHandMeshVertexBufferMSFT(address, container);
}
/**
* Creates a {@code XrHandMeshVertexBufferMSFT} 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 XrHandMeshVertexBufferMSFT(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** an {@code XrTime} representing the time when the runtime receives the vertex buffer content or 0 to indicate a request to retrieve latest vertices regardless of existing content in {@code vertices}. */
@NativeType("XrTime")
public long vertexUpdateTime() { return nvertexUpdateTime(address()); }
/** a positive {@code uint32_t} describes the capacity of the {@code vertices} array. */
@NativeType("uint32_t")
public int vertexCapacityInput() { return nvertexCapacityInput(address()); }
/** a {@code uint32_t} filled in by the runtime with the count of vertices written in {@code vertices}. */
@NativeType("uint32_t")
public int vertexCountOutput() { return nvertexCountOutput(address()); }
/** an array of {@link XrHandMeshVertexMSFT} filled in by the runtime, specifying the vertices of the hand mesh including the position and normal vector in the hand mesh space. */
@NativeType("XrHandMeshVertexMSFT *")
public XrHandMeshVertexMSFT.@Nullable Buffer vertices() { return nvertices(address()); }
/** Sets the specified value to the {@link #vertexUpdateTime} field. */
public XrHandMeshVertexBufferMSFT vertexUpdateTime(@NativeType("XrTime") long value) { nvertexUpdateTime(address(), value); return this; }
/** Sets the specified value to the {@link #vertexCapacityInput} field. */
public XrHandMeshVertexBufferMSFT vertexCapacityInput(@NativeType("uint32_t") int value) { nvertexCapacityInput(address(), value); return this; }
/** Sets the specified value to the {@link #vertexCountOutput} field. */
public XrHandMeshVertexBufferMSFT vertexCountOutput(@NativeType("uint32_t") int value) { nvertexCountOutput(address(), value); return this; }
/** Sets the address of the specified {@link XrHandMeshVertexMSFT.Buffer} to the {@link #vertices} field. */
public XrHandMeshVertexBufferMSFT vertices(@NativeType("XrHandMeshVertexMSFT *") XrHandMeshVertexMSFT.@Nullable Buffer value) { nvertices(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrHandMeshVertexBufferMSFT set(
long vertexUpdateTime,
int vertexCapacityInput,
int vertexCountOutput,
XrHandMeshVertexMSFT.@Nullable Buffer vertices
) {
vertexUpdateTime(vertexUpdateTime);
vertexCapacityInput(vertexCapacityInput);
vertexCountOutput(vertexCountOutput);
vertices(vertices);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrHandMeshVertexBufferMSFT set(XrHandMeshVertexBufferMSFT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrHandMeshVertexBufferMSFT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrHandMeshVertexBufferMSFT malloc() {
return new XrHandMeshVertexBufferMSFT(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrHandMeshVertexBufferMSFT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrHandMeshVertexBufferMSFT calloc() {
return new XrHandMeshVertexBufferMSFT(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrHandMeshVertexBufferMSFT} instance allocated with {@link BufferUtils}. */
public static XrHandMeshVertexBufferMSFT create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrHandMeshVertexBufferMSFT(memAddress(container), container);
}
/** Returns a new {@code XrHandMeshVertexBufferMSFT} instance for the specified memory address. */
public static XrHandMeshVertexBufferMSFT create(long address) {
return new XrHandMeshVertexBufferMSFT(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrHandMeshVertexBufferMSFT createSafe(long address) {
return address == NULL ? null : new XrHandMeshVertexBufferMSFT(address, null);
}
/**
* Returns a new {@link XrHandMeshVertexBufferMSFT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrHandMeshVertexBufferMSFT.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrHandMeshVertexBufferMSFT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrHandMeshVertexBufferMSFT.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrHandMeshVertexBufferMSFT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrHandMeshVertexBufferMSFT.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrHandMeshVertexBufferMSFT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrHandMeshVertexBufferMSFT.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 XrHandMeshVertexBufferMSFT.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrHandMeshVertexBufferMSFT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrHandMeshVertexBufferMSFT malloc(MemoryStack stack) {
return new XrHandMeshVertexBufferMSFT(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrHandMeshVertexBufferMSFT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrHandMeshVertexBufferMSFT calloc(MemoryStack stack) {
return new XrHandMeshVertexBufferMSFT(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrHandMeshVertexBufferMSFT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrHandMeshVertexBufferMSFT.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrHandMeshVertexBufferMSFT.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 XrHandMeshVertexBufferMSFT.Buffer calloc(int capacity, MemoryStack stack) {
return new Buffer(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #vertexUpdateTime}. */
public static long nvertexUpdateTime(long struct) { return memGetLong(struct + XrHandMeshVertexBufferMSFT.VERTEXUPDATETIME); }
/** Unsafe version of {@link #vertexCapacityInput}. */
public static int nvertexCapacityInput(long struct) { return memGetInt(struct + XrHandMeshVertexBufferMSFT.VERTEXCAPACITYINPUT); }
/** Unsafe version of {@link #vertexCountOutput}. */
public static int nvertexCountOutput(long struct) { return memGetInt(struct + XrHandMeshVertexBufferMSFT.VERTEXCOUNTOUTPUT); }
/** Unsafe version of {@link #vertices}. */
public static XrHandMeshVertexMSFT.@Nullable Buffer nvertices(long struct) { return XrHandMeshVertexMSFT.createSafe(memGetAddress(struct + XrHandMeshVertexBufferMSFT.VERTICES), nvertexCapacityInput(struct)); }
/** Unsafe version of {@link #vertexUpdateTime(long) vertexUpdateTime}. */
public static void nvertexUpdateTime(long struct, long value) { memPutLong(struct + XrHandMeshVertexBufferMSFT.VERTEXUPDATETIME, value); }
/** Sets the specified value to the {@code vertexCapacityInput} field of the specified {@code struct}. */
public static void nvertexCapacityInput(long struct, int value) { memPutInt(struct + XrHandMeshVertexBufferMSFT.VERTEXCAPACITYINPUT, value); }
/** Unsafe version of {@link #vertexCountOutput(int) vertexCountOutput}. */
public static void nvertexCountOutput(long struct, int value) { memPutInt(struct + XrHandMeshVertexBufferMSFT.VERTEXCOUNTOUTPUT, value); }
/** Unsafe version of {@link #vertices(XrHandMeshVertexMSFT.Buffer) vertices}. */
public static void nvertices(long struct, XrHandMeshVertexMSFT.@Nullable Buffer value) { memPutAddress(struct + XrHandMeshVertexBufferMSFT.VERTICES, memAddressSafe(value)); if (value != null) { nvertexCapacityInput(struct, value.remaining()); } }
// -----------------------------------
/** An array of {@link XrHandMeshVertexBufferMSFT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrHandMeshVertexBufferMSFT ELEMENT_FACTORY = XrHandMeshVertexBufferMSFT.create(-1L);
/**
* Creates a new {@code XrHandMeshVertexBufferMSFT.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 XrHandMeshVertexBufferMSFT#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 XrHandMeshVertexBufferMSFT getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrHandMeshVertexBufferMSFT#vertexUpdateTime} field. */
@NativeType("XrTime")
public long vertexUpdateTime() { return XrHandMeshVertexBufferMSFT.nvertexUpdateTime(address()); }
/** @return the value of the {@link XrHandMeshVertexBufferMSFT#vertexCapacityInput} field. */
@NativeType("uint32_t")
public int vertexCapacityInput() { return XrHandMeshVertexBufferMSFT.nvertexCapacityInput(address()); }
/** @return the value of the {@link XrHandMeshVertexBufferMSFT#vertexCountOutput} field. */
@NativeType("uint32_t")
public int vertexCountOutput() { return XrHandMeshVertexBufferMSFT.nvertexCountOutput(address()); }
/** @return a {@link XrHandMeshVertexMSFT.Buffer} view of the struct array pointed to by the {@link XrHandMeshVertexBufferMSFT#vertices} field. */
@NativeType("XrHandMeshVertexMSFT *")
public XrHandMeshVertexMSFT.@Nullable Buffer vertices() { return XrHandMeshVertexBufferMSFT.nvertices(address()); }
/** Sets the specified value to the {@link XrHandMeshVertexBufferMSFT#vertexUpdateTime} field. */
public XrHandMeshVertexBufferMSFT.Buffer vertexUpdateTime(@NativeType("XrTime") long value) { XrHandMeshVertexBufferMSFT.nvertexUpdateTime(address(), value); return this; }
/** Sets the specified value to the {@link XrHandMeshVertexBufferMSFT#vertexCapacityInput} field. */
public XrHandMeshVertexBufferMSFT.Buffer vertexCapacityInput(@NativeType("uint32_t") int value) { XrHandMeshVertexBufferMSFT.nvertexCapacityInput(address(), value); return this; }
/** Sets the specified value to the {@link XrHandMeshVertexBufferMSFT#vertexCountOutput} field. */
public XrHandMeshVertexBufferMSFT.Buffer vertexCountOutput(@NativeType("uint32_t") int value) { XrHandMeshVertexBufferMSFT.nvertexCountOutput(address(), value); return this; }
/** Sets the address of the specified {@link XrHandMeshVertexMSFT.Buffer} to the {@link XrHandMeshVertexBufferMSFT#vertices} field. */
public XrHandMeshVertexBufferMSFT.Buffer vertices(@NativeType("XrHandMeshVertexMSFT *") XrHandMeshVertexMSFT.@Nullable Buffer value) { XrHandMeshVertexBufferMSFT.nvertices(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy