org.lwjgl.openxr.XrScenePlaneMSFT 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.
/*
* 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.*;
/**
* Scene plane.
*
* Description
*
* The {@code size} of a plane refers to the plane’s size in the x-y plane of the plane’s coordinate system. A plane with a position of {0,0,0}, rotation of {0,0,0,1} (no rotation), and an extent of {1,1} refers to a 1 meter x 1 meter plane centered at {0,0,0} with its front face normal vector pointing towards the +Z direction in the plane component’s space. For planes with an alignment of {@link MSFTSceneUnderstanding#XR_SCENE_PLANE_ALIGNMENT_TYPE_VERTICAL_MSFT SCENE_PLANE_ALIGNMENT_TYPE_VERTICAL_MSFT}, the +Y direction must point up away from the direction of gravity.
*
* Note
*
* OpenXR uses an X-Y plane with +Z as the plane normal but other APIs may use an X-Z plane with +Y as the plane normal. The X-Y plane can be converted to an X-Z plane by rotating -π/2 radians around the +X axis.
*
*
* Valid Usage (Implicit)
*
*
* - The {@link MSFTSceneUnderstanding XR_MSFT_scene_understanding} extension must be enabled prior to using {@link XrScenePlaneMSFT}
* - {@code alignment} must be a valid {@code XrScenePlaneAlignmentTypeMSFT} value
*
*
* See Also
*
* {@link XrExtent2Df}, {@link XrScenePlanesMSFT}
*
* Layout
*
*
* struct XrScenePlaneMSFT {
* XrScenePlaneAlignmentTypeMSFT {@link #alignment};
* {@link XrExtent2Df XrExtent2Df} {@link #size};
* uint64_t {@link #meshBufferId};
* XrBool32 {@link #supportsIndicesUint16};
* }
*/
public class XrScenePlaneMSFT 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
ALIGNMENT,
SIZE,
MESHBUFFERID,
SUPPORTSINDICESUINT16;
static {
Layout layout = __struct(
__member(4),
__member(XrExtent2Df.SIZEOF, XrExtent2Df.ALIGNOF),
__member(8),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
ALIGNMENT = layout.offsetof(0);
SIZE = layout.offsetof(1);
MESHBUFFERID = layout.offsetof(2);
SUPPORTSINDICESUINT16 = layout.offsetof(3);
}
protected XrScenePlaneMSFT(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrScenePlaneMSFT create(long address, @Nullable ByteBuffer container) {
return new XrScenePlaneMSFT(address, container);
}
/**
* Creates a {@code XrScenePlaneMSFT} 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 XrScenePlaneMSFT(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** the alignment type of the plane specified by {@code XrScenePlaneAlignmentTypeMSFT}. */
@NativeType("XrScenePlaneAlignmentTypeMSFT")
public int alignment() { return nalignment(address()); }
/** the 2D size of the plane’s extent, where {@link XrExtent2Df}{@code ::width} is the width of the plane along the X axis, and {@link XrExtent2Df}{@code ::height} is the height of the plane along the Y axis. */
public XrExtent2Df size() { return nsize(address()); }
/** the {@code uint64_t} identifier that specifies the scene mesh buffer of this plane’s triangle mesh. If {@code meshBufferId} is zero then this plane does not have a mesh. The triangles in a planar mesh are coplanar. */
@NativeType("uint64_t")
public long meshBufferId() { return nmeshBufferId(address()); }
/** {@link XR10#XR_TRUE TRUE} if the mesh supports reading 16-bit unsigned indices. */
@NativeType("XrBool32")
public boolean supportsIndicesUint16() { return nsupportsIndicesUint16(address()) != 0; }
/** Sets the specified value to the {@link #alignment} field. */
public XrScenePlaneMSFT alignment(@NativeType("XrScenePlaneAlignmentTypeMSFT") int value) { nalignment(address(), value); return this; }
/** Copies the specified {@link XrExtent2Df} to the {@link #size} field. */
public XrScenePlaneMSFT size(XrExtent2Df value) { nsize(address(), value); return this; }
/** Passes the {@link #size} field to the specified {@link java.util.function.Consumer Consumer}. */
public XrScenePlaneMSFT size(java.util.function.Consumer consumer) { consumer.accept(size()); return this; }
/** Sets the specified value to the {@link #meshBufferId} field. */
public XrScenePlaneMSFT meshBufferId(@NativeType("uint64_t") long value) { nmeshBufferId(address(), value); return this; }
/** Sets the specified value to the {@link #supportsIndicesUint16} field. */
public XrScenePlaneMSFT supportsIndicesUint16(@NativeType("XrBool32") boolean value) { nsupportsIndicesUint16(address(), value ? 1 : 0); return this; }
/** Initializes this struct with the specified values. */
public XrScenePlaneMSFT set(
int alignment,
XrExtent2Df size,
long meshBufferId,
boolean supportsIndicesUint16
) {
alignment(alignment);
size(size);
meshBufferId(meshBufferId);
supportsIndicesUint16(supportsIndicesUint16);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrScenePlaneMSFT set(XrScenePlaneMSFT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrScenePlaneMSFT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrScenePlaneMSFT malloc() {
return new XrScenePlaneMSFT(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrScenePlaneMSFT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrScenePlaneMSFT calloc() {
return new XrScenePlaneMSFT(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrScenePlaneMSFT} instance allocated with {@link BufferUtils}. */
public static XrScenePlaneMSFT create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrScenePlaneMSFT(memAddress(container), container);
}
/** Returns a new {@code XrScenePlaneMSFT} instance for the specified memory address. */
public static XrScenePlaneMSFT create(long address) {
return new XrScenePlaneMSFT(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrScenePlaneMSFT createSafe(long address) {
return address == NULL ? null : new XrScenePlaneMSFT(address, null);
}
/**
* Returns a new {@link XrScenePlaneMSFT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrScenePlaneMSFT.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrScenePlaneMSFT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrScenePlaneMSFT.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrScenePlaneMSFT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrScenePlaneMSFT.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrScenePlaneMSFT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrScenePlaneMSFT.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 XrScenePlaneMSFT.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrScenePlaneMSFT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrScenePlaneMSFT malloc(MemoryStack stack) {
return new XrScenePlaneMSFT(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrScenePlaneMSFT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrScenePlaneMSFT calloc(MemoryStack stack) {
return new XrScenePlaneMSFT(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrScenePlaneMSFT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrScenePlaneMSFT.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrScenePlaneMSFT.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 XrScenePlaneMSFT.Buffer calloc(int capacity, MemoryStack stack) {
return new Buffer(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #alignment}. */
public static int nalignment(long struct) { return memGetInt(struct + XrScenePlaneMSFT.ALIGNMENT); }
/** Unsafe version of {@link #size}. */
public static XrExtent2Df nsize(long struct) { return XrExtent2Df.create(struct + XrScenePlaneMSFT.SIZE); }
/** Unsafe version of {@link #meshBufferId}. */
public static long nmeshBufferId(long struct) { return memGetLong(struct + XrScenePlaneMSFT.MESHBUFFERID); }
/** Unsafe version of {@link #supportsIndicesUint16}. */
public static int nsupportsIndicesUint16(long struct) { return memGetInt(struct + XrScenePlaneMSFT.SUPPORTSINDICESUINT16); }
/** Unsafe version of {@link #alignment(int) alignment}. */
public static void nalignment(long struct, int value) { memPutInt(struct + XrScenePlaneMSFT.ALIGNMENT, value); }
/** Unsafe version of {@link #size(XrExtent2Df) size}. */
public static void nsize(long struct, XrExtent2Df value) { memCopy(value.address(), struct + XrScenePlaneMSFT.SIZE, XrExtent2Df.SIZEOF); }
/** Unsafe version of {@link #meshBufferId(long) meshBufferId}. */
public static void nmeshBufferId(long struct, long value) { memPutLong(struct + XrScenePlaneMSFT.MESHBUFFERID, value); }
/** Unsafe version of {@link #supportsIndicesUint16(boolean) supportsIndicesUint16}. */
public static void nsupportsIndicesUint16(long struct, int value) { memPutInt(struct + XrScenePlaneMSFT.SUPPORTSINDICESUINT16, value); }
// -----------------------------------
/** An array of {@link XrScenePlaneMSFT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrScenePlaneMSFT ELEMENT_FACTORY = XrScenePlaneMSFT.create(-1L);
/**
* Creates a new {@code XrScenePlaneMSFT.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 XrScenePlaneMSFT#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 XrScenePlaneMSFT getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrScenePlaneMSFT#alignment} field. */
@NativeType("XrScenePlaneAlignmentTypeMSFT")
public int alignment() { return XrScenePlaneMSFT.nalignment(address()); }
/** @return a {@link XrExtent2Df} view of the {@link XrScenePlaneMSFT#size} field. */
public XrExtent2Df size() { return XrScenePlaneMSFT.nsize(address()); }
/** @return the value of the {@link XrScenePlaneMSFT#meshBufferId} field. */
@NativeType("uint64_t")
public long meshBufferId() { return XrScenePlaneMSFT.nmeshBufferId(address()); }
/** @return the value of the {@link XrScenePlaneMSFT#supportsIndicesUint16} field. */
@NativeType("XrBool32")
public boolean supportsIndicesUint16() { return XrScenePlaneMSFT.nsupportsIndicesUint16(address()) != 0; }
/** Sets the specified value to the {@link XrScenePlaneMSFT#alignment} field. */
public XrScenePlaneMSFT.Buffer alignment(@NativeType("XrScenePlaneAlignmentTypeMSFT") int value) { XrScenePlaneMSFT.nalignment(address(), value); return this; }
/** Copies the specified {@link XrExtent2Df} to the {@link XrScenePlaneMSFT#size} field. */
public XrScenePlaneMSFT.Buffer size(XrExtent2Df value) { XrScenePlaneMSFT.nsize(address(), value); return this; }
/** Passes the {@link XrScenePlaneMSFT#size} field to the specified {@link java.util.function.Consumer Consumer}. */
public XrScenePlaneMSFT.Buffer size(java.util.function.Consumer consumer) { consumer.accept(size()); return this; }
/** Sets the specified value to the {@link XrScenePlaneMSFT#meshBufferId} field. */
public XrScenePlaneMSFT.Buffer meshBufferId(@NativeType("uint64_t") long value) { XrScenePlaneMSFT.nmeshBufferId(address(), value); return this; }
/** Sets the specified value to the {@link XrScenePlaneMSFT#supportsIndicesUint16} field. */
public XrScenePlaneMSFT.Buffer supportsIndicesUint16(@NativeType("XrBool32") boolean value) { XrScenePlaneMSFT.nsupportsIndicesUint16(address(), value ? 1 : 0); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy