org.lwjgl.openxr.XrTriangleMeshCreateInfoFB 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 information to create a triangle mesh.
*
* Description
*
* Mesh buffers can be updated between {@link FBTriangleMesh#xrTriangleMeshBeginUpdateFB TriangleMeshBeginUpdateFB} and {@link FBTriangleMesh#xrTriangleMeshEndUpdateFB TriangleMeshEndUpdateFB} calls.
*
* If the mesh is non-mutable, {@code vertexBuffer} must be a pointer to an array of {@code vertexCount} {@link XrVector3f} structures. If the mesh is non-mutable, {@code indexBuffer} must be a pointer to an array of 3 * {@code triangleCount} {@code uint32_t} vertex indices.
*
* Valid Usage (Implicit)
*
*
* - The {@link FBTriangleMesh XR_FB_triangle_mesh} extension must be enabled prior to using {@link XrTriangleMeshCreateInfoFB}
* - {@code type} must be {@link FBTriangleMesh#XR_TYPE_TRIANGLE_MESH_CREATE_INFO_FB TYPE_TRIANGLE_MESH_CREATE_INFO_FB}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
* - {@code flags} must be 0 or a valid combination of {@code XrTriangleMeshFlagBitsFB} values
* - {@code windingOrder} must be a valid {@code XrWindingOrderFB} value
*
*
* See Also
*
* {@link XrVector3f}, {@link FBTriangleMesh#xrCreateTriangleMeshFB CreateTriangleMeshFB}
*
* Layout
*
*
* struct XrTriangleMeshCreateInfoFB {
* XrStructureType {@link #type};
* void const * {@link #next};
* XrTriangleMeshFlagsFB {@link #flags};
* XrWindingOrderFB {@link #windingOrder};
* uint32_t {@link #vertexCount};
* {@link XrVector3f XrVector3f} const * {@link #vertexBuffer};
* uint32_t {@link #triangleCount};
* uint32_t const * {@link #indexBuffer};
* }
*/
public class XrTriangleMeshCreateInfoFB 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,
FLAGS,
WINDINGORDER,
VERTEXCOUNT,
VERTEXBUFFER,
TRIANGLECOUNT,
INDEXBUFFER;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(8),
__member(4),
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
FLAGS = layout.offsetof(2);
WINDINGORDER = layout.offsetof(3);
VERTEXCOUNT = layout.offsetof(4);
VERTEXBUFFER = layout.offsetof(5);
TRIANGLECOUNT = layout.offsetof(6);
INDEXBUFFER = layout.offsetof(7);
}
protected XrTriangleMeshCreateInfoFB(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrTriangleMeshCreateInfoFB create(long address, @Nullable ByteBuffer container) {
return new XrTriangleMeshCreateInfoFB(address, container);
}
/**
* Creates a {@code XrTriangleMeshCreateInfoFB} 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 XrTriangleMeshCreateInfoFB(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 bitmask of {@code XrTriangleMeshFlagBitsFB} that specify behavior. */
@NativeType("XrTriangleMeshFlagsFB")
public long flags() { return nflags(address()); }
/** the {@code XrWindingOrderFB} value defining the winding order of the mesh triangles. */
@NativeType("XrWindingOrderFB")
public int windingOrder() { return nwindingOrder(address()); }
/** the number of vertices in the mesh. In the case of the mutable mesh, the value is treated as the maximum number of vertices the mesh will be able to represent at any time in its lifecycle. The actual number of vertices can vary and is defined when {@link FBTriangleMesh#xrTriangleMeshEndUpdateFB TriangleMeshEndUpdateFB} is called. */
@NativeType("uint32_t")
public int vertexCount() { return nvertexCount(address()); }
/** a pointer to the vertex data. The size of the array must be {@code vertexCount} elements. When the mesh is mutable ({@code ({@code flags} & {@link FBTriangleMesh#XR_TRIANGLE_MESH_MUTABLE_BIT_FB TRIANGLE_MESH_MUTABLE_BIT_FB}) != 0}), the {@code vertexBuffer} parameter must be {@code NULL} and mesh data must be populated separately. */
@NativeType("XrVector3f const *")
public @Nullable XrVector3f vertexBuffer() { return nvertexBuffer(address()); }
/** the number of triangles in the mesh. In the case of the mutable mesh, the value is treated as the maximum number of triangles the mesh will be able to represent at any time in its lifecycle. The actual number of triangles can vary and is defined when {@link FBTriangleMesh#xrTriangleMeshEndUpdateFB TriangleMeshEndUpdateFB} is called. */
@NativeType("uint32_t")
public int triangleCount() { return ntriangleCount(address()); }
/**
* @param capacity the number of elements in the returned buffer
*
* @return the triangle indices. The size of the array must be {@code triangleCount} elements. When the mesh is mutable ({@code ({@code flags} & {@link FBTriangleMesh#XR_TRIANGLE_MESH_MUTABLE_BIT_FB TRIANGLE_MESH_MUTABLE_BIT_FB}) != 0}), the {@code indexBuffer} parameter must be {@code NULL} and mesh data must be populated separately.
*/
@NativeType("uint32_t const *")
public @Nullable IntBuffer indexBuffer(int capacity) { return nindexBuffer(address(), capacity); }
/** Sets the specified value to the {@link #type} field. */
public XrTriangleMeshCreateInfoFB type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link FBTriangleMesh#XR_TYPE_TRIANGLE_MESH_CREATE_INFO_FB TYPE_TRIANGLE_MESH_CREATE_INFO_FB} value to the {@link #type} field. */
public XrTriangleMeshCreateInfoFB type$Default() { return type(FBTriangleMesh.XR_TYPE_TRIANGLE_MESH_CREATE_INFO_FB); }
/** Sets the specified value to the {@link #next} field. */
public XrTriangleMeshCreateInfoFB next(@NativeType("void const *") long value) { nnext(address(), value); return this; }
/** Sets the specified value to the {@link #flags} field. */
public XrTriangleMeshCreateInfoFB flags(@NativeType("XrTriangleMeshFlagsFB") long value) { nflags(address(), value); return this; }
/** Sets the specified value to the {@link #windingOrder} field. */
public XrTriangleMeshCreateInfoFB windingOrder(@NativeType("XrWindingOrderFB") int value) { nwindingOrder(address(), value); return this; }
/** Sets the specified value to the {@link #vertexCount} field. */
public XrTriangleMeshCreateInfoFB vertexCount(@NativeType("uint32_t") int value) { nvertexCount(address(), value); return this; }
/** Sets the address of the specified {@link XrVector3f} to the {@link #vertexBuffer} field. */
public XrTriangleMeshCreateInfoFB vertexBuffer(@Nullable @NativeType("XrVector3f const *") XrVector3f value) { nvertexBuffer(address(), value); return this; }
/** Sets the specified value to the {@link #triangleCount} field. */
public XrTriangleMeshCreateInfoFB triangleCount(@NativeType("uint32_t") int value) { ntriangleCount(address(), value); return this; }
/** Sets the address of the specified {@link IntBuffer} to the {@link #indexBuffer} field. */
public XrTriangleMeshCreateInfoFB indexBuffer(@Nullable @NativeType("uint32_t const *") IntBuffer value) { nindexBuffer(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrTriangleMeshCreateInfoFB set(
int type,
long next,
long flags,
int windingOrder,
int vertexCount,
@Nullable XrVector3f vertexBuffer,
int triangleCount,
@Nullable IntBuffer indexBuffer
) {
type(type);
next(next);
flags(flags);
windingOrder(windingOrder);
vertexCount(vertexCount);
vertexBuffer(vertexBuffer);
triangleCount(triangleCount);
indexBuffer(indexBuffer);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrTriangleMeshCreateInfoFB set(XrTriangleMeshCreateInfoFB src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrTriangleMeshCreateInfoFB} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrTriangleMeshCreateInfoFB malloc() {
return new XrTriangleMeshCreateInfoFB(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrTriangleMeshCreateInfoFB} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrTriangleMeshCreateInfoFB calloc() {
return new XrTriangleMeshCreateInfoFB(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrTriangleMeshCreateInfoFB} instance allocated with {@link BufferUtils}. */
public static XrTriangleMeshCreateInfoFB create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrTriangleMeshCreateInfoFB(memAddress(container), container);
}
/** Returns a new {@code XrTriangleMeshCreateInfoFB} instance for the specified memory address. */
public static XrTriangleMeshCreateInfoFB create(long address) {
return new XrTriangleMeshCreateInfoFB(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrTriangleMeshCreateInfoFB createSafe(long address) {
return address == NULL ? null : new XrTriangleMeshCreateInfoFB(address, null);
}
/**
* Returns a new {@link XrTriangleMeshCreateInfoFB.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrTriangleMeshCreateInfoFB.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrTriangleMeshCreateInfoFB.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrTriangleMeshCreateInfoFB.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrTriangleMeshCreateInfoFB.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrTriangleMeshCreateInfoFB.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrTriangleMeshCreateInfoFB.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrTriangleMeshCreateInfoFB.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 XrTriangleMeshCreateInfoFB.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrTriangleMeshCreateInfoFB} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrTriangleMeshCreateInfoFB malloc(MemoryStack stack) {
return new XrTriangleMeshCreateInfoFB(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrTriangleMeshCreateInfoFB} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrTriangleMeshCreateInfoFB calloc(MemoryStack stack) {
return new XrTriangleMeshCreateInfoFB(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrTriangleMeshCreateInfoFB.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrTriangleMeshCreateInfoFB.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrTriangleMeshCreateInfoFB.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 XrTriangleMeshCreateInfoFB.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 + XrTriangleMeshCreateInfoFB.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrTriangleMeshCreateInfoFB.NEXT); }
/** Unsafe version of {@link #flags}. */
public static long nflags(long struct) { return memGetLong(struct + XrTriangleMeshCreateInfoFB.FLAGS); }
/** Unsafe version of {@link #windingOrder}. */
public static int nwindingOrder(long struct) { return memGetInt(struct + XrTriangleMeshCreateInfoFB.WINDINGORDER); }
/** Unsafe version of {@link #vertexCount}. */
public static int nvertexCount(long struct) { return memGetInt(struct + XrTriangleMeshCreateInfoFB.VERTEXCOUNT); }
/** Unsafe version of {@link #vertexBuffer}. */
public static @Nullable XrVector3f nvertexBuffer(long struct) { return XrVector3f.createSafe(memGetAddress(struct + XrTriangleMeshCreateInfoFB.VERTEXBUFFER)); }
/** Unsafe version of {@link #triangleCount}. */
public static int ntriangleCount(long struct) { return memGetInt(struct + XrTriangleMeshCreateInfoFB.TRIANGLECOUNT); }
/** Unsafe version of {@link #indexBuffer(int) indexBuffer}. */
public static @Nullable IntBuffer nindexBuffer(long struct, int capacity) { return memIntBufferSafe(memGetAddress(struct + XrTriangleMeshCreateInfoFB.INDEXBUFFER), capacity); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrTriangleMeshCreateInfoFB.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrTriangleMeshCreateInfoFB.NEXT, value); }
/** Unsafe version of {@link #flags(long) flags}. */
public static void nflags(long struct, long value) { memPutLong(struct + XrTriangleMeshCreateInfoFB.FLAGS, value); }
/** Unsafe version of {@link #windingOrder(int) windingOrder}. */
public static void nwindingOrder(long struct, int value) { memPutInt(struct + XrTriangleMeshCreateInfoFB.WINDINGORDER, value); }
/** Unsafe version of {@link #vertexCount(int) vertexCount}. */
public static void nvertexCount(long struct, int value) { memPutInt(struct + XrTriangleMeshCreateInfoFB.VERTEXCOUNT, value); }
/** Unsafe version of {@link #vertexBuffer(XrVector3f) vertexBuffer}. */
public static void nvertexBuffer(long struct, @Nullable XrVector3f value) { memPutAddress(struct + XrTriangleMeshCreateInfoFB.VERTEXBUFFER, memAddressSafe(value)); }
/** Unsafe version of {@link #triangleCount(int) triangleCount}. */
public static void ntriangleCount(long struct, int value) { memPutInt(struct + XrTriangleMeshCreateInfoFB.TRIANGLECOUNT, value); }
/** Unsafe version of {@link #indexBuffer(IntBuffer) indexBuffer}. */
public static void nindexBuffer(long struct, @Nullable IntBuffer value) { memPutAddress(struct + XrTriangleMeshCreateInfoFB.INDEXBUFFER, memAddressSafe(value)); }
// -----------------------------------
/** An array of {@link XrTriangleMeshCreateInfoFB} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrTriangleMeshCreateInfoFB ELEMENT_FACTORY = XrTriangleMeshCreateInfoFB.create(-1L);
/**
* Creates a new {@code XrTriangleMeshCreateInfoFB.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 XrTriangleMeshCreateInfoFB#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 XrTriangleMeshCreateInfoFB getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrTriangleMeshCreateInfoFB#type} field. */
@NativeType("XrStructureType")
public int type() { return XrTriangleMeshCreateInfoFB.ntype(address()); }
/** @return the value of the {@link XrTriangleMeshCreateInfoFB#next} field. */
@NativeType("void const *")
public long next() { return XrTriangleMeshCreateInfoFB.nnext(address()); }
/** @return the value of the {@link XrTriangleMeshCreateInfoFB#flags} field. */
@NativeType("XrTriangleMeshFlagsFB")
public long flags() { return XrTriangleMeshCreateInfoFB.nflags(address()); }
/** @return the value of the {@link XrTriangleMeshCreateInfoFB#windingOrder} field. */
@NativeType("XrWindingOrderFB")
public int windingOrder() { return XrTriangleMeshCreateInfoFB.nwindingOrder(address()); }
/** @return the value of the {@link XrTriangleMeshCreateInfoFB#vertexCount} field. */
@NativeType("uint32_t")
public int vertexCount() { return XrTriangleMeshCreateInfoFB.nvertexCount(address()); }
/** @return a {@link XrVector3f} view of the struct pointed to by the {@link XrTriangleMeshCreateInfoFB#vertexBuffer} field. */
@NativeType("XrVector3f const *")
public @Nullable XrVector3f vertexBuffer() { return XrTriangleMeshCreateInfoFB.nvertexBuffer(address()); }
/** @return the value of the {@link XrTriangleMeshCreateInfoFB#triangleCount} field. */
@NativeType("uint32_t")
public int triangleCount() { return XrTriangleMeshCreateInfoFB.ntriangleCount(address()); }
/**
* @return a {@link IntBuffer} view of the data pointed to by the {@link XrTriangleMeshCreateInfoFB#indexBuffer} field.
*
* @param capacity the number of elements in the returned buffer
*/
@NativeType("uint32_t const *")
public @Nullable IntBuffer indexBuffer(int capacity) { return XrTriangleMeshCreateInfoFB.nindexBuffer(address(), capacity); }
/** Sets the specified value to the {@link XrTriangleMeshCreateInfoFB#type} field. */
public XrTriangleMeshCreateInfoFB.Buffer type(@NativeType("XrStructureType") int value) { XrTriangleMeshCreateInfoFB.ntype(address(), value); return this; }
/** Sets the {@link FBTriangleMesh#XR_TYPE_TRIANGLE_MESH_CREATE_INFO_FB TYPE_TRIANGLE_MESH_CREATE_INFO_FB} value to the {@link XrTriangleMeshCreateInfoFB#type} field. */
public XrTriangleMeshCreateInfoFB.Buffer type$Default() { return type(FBTriangleMesh.XR_TYPE_TRIANGLE_MESH_CREATE_INFO_FB); }
/** Sets the specified value to the {@link XrTriangleMeshCreateInfoFB#next} field. */
public XrTriangleMeshCreateInfoFB.Buffer next(@NativeType("void const *") long value) { XrTriangleMeshCreateInfoFB.nnext(address(), value); return this; }
/** Sets the specified value to the {@link XrTriangleMeshCreateInfoFB#flags} field. */
public XrTriangleMeshCreateInfoFB.Buffer flags(@NativeType("XrTriangleMeshFlagsFB") long value) { XrTriangleMeshCreateInfoFB.nflags(address(), value); return this; }
/** Sets the specified value to the {@link XrTriangleMeshCreateInfoFB#windingOrder} field. */
public XrTriangleMeshCreateInfoFB.Buffer windingOrder(@NativeType("XrWindingOrderFB") int value) { XrTriangleMeshCreateInfoFB.nwindingOrder(address(), value); return this; }
/** Sets the specified value to the {@link XrTriangleMeshCreateInfoFB#vertexCount} field. */
public XrTriangleMeshCreateInfoFB.Buffer vertexCount(@NativeType("uint32_t") int value) { XrTriangleMeshCreateInfoFB.nvertexCount(address(), value); return this; }
/** Sets the address of the specified {@link XrVector3f} to the {@link XrTriangleMeshCreateInfoFB#vertexBuffer} field. */
public XrTriangleMeshCreateInfoFB.Buffer vertexBuffer(@Nullable @NativeType("XrVector3f const *") XrVector3f value) { XrTriangleMeshCreateInfoFB.nvertexBuffer(address(), value); return this; }
/** Sets the specified value to the {@link XrTriangleMeshCreateInfoFB#triangleCount} field. */
public XrTriangleMeshCreateInfoFB.Buffer triangleCount(@NativeType("uint32_t") int value) { XrTriangleMeshCreateInfoFB.ntriangleCount(address(), value); return this; }
/** Sets the address of the specified {@link IntBuffer} to the {@link XrTriangleMeshCreateInfoFB#indexBuffer} field. */
public XrTriangleMeshCreateInfoFB.Buffer indexBuffer(@Nullable @NativeType("uint32_t const *") IntBuffer value) { XrTriangleMeshCreateInfoFB.nindexBuffer(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy