org.lwjgl.openxr.XrBoundary2DFB 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.*;
/**
* Provides additional context of a spatial entity representing a room.
*
* Description
*
* This structure is used by the {@link FBScene#xrGetSpaceBoundary2DFB GetSpaceBoundary2DFB} function to provide the application with the {@link XrVector2f} vertices representing the a spatial entity with a boundary.
*
* Valid Usage (Implicit)
*
*
* - The {@link FBScene XR_FB_scene} extension must be enabled prior to using {@link XrBoundary2DFB}
* - {@code type} must be {@link FBScene#XR_TYPE_BOUNDARY_2D_FB TYPE_BOUNDARY_2D_FB}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
* - If {@code vertexCapacityInput} is not 0, {@code vertices} must be a pointer to an array of {@code vertexCapacityInput} {@link XrVector2f} structures
*
*
* See Also
*
* {@link XrVector2f}, {@link FBScene#xrGetSpaceBoundary2DFB GetSpaceBoundary2DFB}
*
* Layout
*
*
* struct XrBoundary2DFB {
* XrStructureType {@link #type};
* void const * {@link #next};
* uint32_t {@link #vertexCapacityInput};
* uint32_t {@link #vertexCountOutput};
* {@link XrVector2f XrVector2f} * {@link #vertices};
* }
*/
public class XrBoundary2DFB 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,
VERTEXCAPACITYINPUT,
VERTEXCOUNTOUTPUT,
VERTICES;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(4),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
VERTEXCAPACITYINPUT = layout.offsetof(2);
VERTEXCOUNTOUTPUT = layout.offsetof(3);
VERTICES = layout.offsetof(4);
}
protected XrBoundary2DFB(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrBoundary2DFB create(long address, @Nullable ByteBuffer container) {
return new XrBoundary2DFB(address, container);
}
/**
* Creates a {@code XrBoundary2DFB} 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 XrBoundary2DFB(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()); }
/** the capacity of the {@code vertices} array, in number of vertices, or 0 to indicate a request to retrieve the required capacity. */
@NativeType("uint32_t")
public int vertexCapacityInput() { return nvertexCapacityInput(address()); }
/** the count of {@link XrVector2f} written, or the required capacity in the case that {@code vertexCapacityInput} is insufficient. */
@NativeType("uint32_t")
public int vertexCountOutput() { return nvertexCountOutput(address()); }
/** a pointer to an array of {@link XrVector2f}, but can be {@code NULL} if {@code vertexCapacityInput} is 0. */
@NativeType("XrVector2f *")
public XrVector2f.@Nullable Buffer vertices() { return nvertices(address()); }
/** Sets the specified value to the {@link #type} field. */
public XrBoundary2DFB type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link FBScene#XR_TYPE_BOUNDARY_2D_FB TYPE_BOUNDARY_2D_FB} value to the {@link #type} field. */
public XrBoundary2DFB type$Default() { return type(FBScene.XR_TYPE_BOUNDARY_2D_FB); }
/** Sets the specified value to the {@link #next} field. */
public XrBoundary2DFB next(@NativeType("void const *") long value) { nnext(address(), value); return this; }
/** Sets the specified value to the {@link #vertexCapacityInput} field. */
public XrBoundary2DFB vertexCapacityInput(@NativeType("uint32_t") int value) { nvertexCapacityInput(address(), value); return this; }
/** Sets the specified value to the {@link #vertexCountOutput} field. */
public XrBoundary2DFB vertexCountOutput(@NativeType("uint32_t") int value) { nvertexCountOutput(address(), value); return this; }
/** Sets the address of the specified {@link XrVector2f.Buffer} to the {@link #vertices} field. */
public XrBoundary2DFB vertices(@NativeType("XrVector2f *") XrVector2f.@Nullable Buffer value) { nvertices(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrBoundary2DFB set(
int type,
long next,
int vertexCapacityInput,
int vertexCountOutput,
XrVector2f.@Nullable Buffer vertices
) {
type(type);
next(next);
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 XrBoundary2DFB set(XrBoundary2DFB src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrBoundary2DFB} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrBoundary2DFB malloc() {
return new XrBoundary2DFB(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrBoundary2DFB} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrBoundary2DFB calloc() {
return new XrBoundary2DFB(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrBoundary2DFB} instance allocated with {@link BufferUtils}. */
public static XrBoundary2DFB create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrBoundary2DFB(memAddress(container), container);
}
/** Returns a new {@code XrBoundary2DFB} instance for the specified memory address. */
public static XrBoundary2DFB create(long address) {
return new XrBoundary2DFB(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrBoundary2DFB createSafe(long address) {
return address == NULL ? null : new XrBoundary2DFB(address, null);
}
/**
* Returns a new {@link XrBoundary2DFB.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrBoundary2DFB.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrBoundary2DFB.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrBoundary2DFB.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrBoundary2DFB.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrBoundary2DFB.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrBoundary2DFB.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrBoundary2DFB.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 XrBoundary2DFB.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrBoundary2DFB} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrBoundary2DFB malloc(MemoryStack stack) {
return new XrBoundary2DFB(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrBoundary2DFB} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrBoundary2DFB calloc(MemoryStack stack) {
return new XrBoundary2DFB(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrBoundary2DFB.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrBoundary2DFB.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrBoundary2DFB.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 XrBoundary2DFB.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 + XrBoundary2DFB.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrBoundary2DFB.NEXT); }
/** Unsafe version of {@link #vertexCapacityInput}. */
public static int nvertexCapacityInput(long struct) { return memGetInt(struct + XrBoundary2DFB.VERTEXCAPACITYINPUT); }
/** Unsafe version of {@link #vertexCountOutput}. */
public static int nvertexCountOutput(long struct) { return memGetInt(struct + XrBoundary2DFB.VERTEXCOUNTOUTPUT); }
/** Unsafe version of {@link #vertices}. */
public static XrVector2f.@Nullable Buffer nvertices(long struct) { return XrVector2f.createSafe(memGetAddress(struct + XrBoundary2DFB.VERTICES), nvertexCapacityInput(struct)); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrBoundary2DFB.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrBoundary2DFB.NEXT, 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 + XrBoundary2DFB.VERTEXCAPACITYINPUT, value); }
/** Unsafe version of {@link #vertexCountOutput(int) vertexCountOutput}. */
public static void nvertexCountOutput(long struct, int value) { memPutInt(struct + XrBoundary2DFB.VERTEXCOUNTOUTPUT, value); }
/** Unsafe version of {@link #vertices(XrVector2f.Buffer) vertices}. */
public static void nvertices(long struct, XrVector2f.@Nullable Buffer value) { memPutAddress(struct + XrBoundary2DFB.VERTICES, memAddressSafe(value)); if (value != null) { nvertexCapacityInput(struct, value.remaining()); } }
// -----------------------------------
/** An array of {@link XrBoundary2DFB} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrBoundary2DFB ELEMENT_FACTORY = XrBoundary2DFB.create(-1L);
/**
* Creates a new {@code XrBoundary2DFB.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 XrBoundary2DFB#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 XrBoundary2DFB getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrBoundary2DFB#type} field. */
@NativeType("XrStructureType")
public int type() { return XrBoundary2DFB.ntype(address()); }
/** @return the value of the {@link XrBoundary2DFB#next} field. */
@NativeType("void const *")
public long next() { return XrBoundary2DFB.nnext(address()); }
/** @return the value of the {@link XrBoundary2DFB#vertexCapacityInput} field. */
@NativeType("uint32_t")
public int vertexCapacityInput() { return XrBoundary2DFB.nvertexCapacityInput(address()); }
/** @return the value of the {@link XrBoundary2DFB#vertexCountOutput} field. */
@NativeType("uint32_t")
public int vertexCountOutput() { return XrBoundary2DFB.nvertexCountOutput(address()); }
/** @return a {@link XrVector2f.Buffer} view of the struct array pointed to by the {@link XrBoundary2DFB#vertices} field. */
@NativeType("XrVector2f *")
public XrVector2f.@Nullable Buffer vertices() { return XrBoundary2DFB.nvertices(address()); }
/** Sets the specified value to the {@link XrBoundary2DFB#type} field. */
public XrBoundary2DFB.Buffer type(@NativeType("XrStructureType") int value) { XrBoundary2DFB.ntype(address(), value); return this; }
/** Sets the {@link FBScene#XR_TYPE_BOUNDARY_2D_FB TYPE_BOUNDARY_2D_FB} value to the {@link XrBoundary2DFB#type} field. */
public XrBoundary2DFB.Buffer type$Default() { return type(FBScene.XR_TYPE_BOUNDARY_2D_FB); }
/** Sets the specified value to the {@link XrBoundary2DFB#next} field. */
public XrBoundary2DFB.Buffer next(@NativeType("void const *") long value) { XrBoundary2DFB.nnext(address(), value); return this; }
/** Sets the specified value to the {@link XrBoundary2DFB#vertexCapacityInput} field. */
public XrBoundary2DFB.Buffer vertexCapacityInput(@NativeType("uint32_t") int value) { XrBoundary2DFB.nvertexCapacityInput(address(), value); return this; }
/** Sets the specified value to the {@link XrBoundary2DFB#vertexCountOutput} field. */
public XrBoundary2DFB.Buffer vertexCountOutput(@NativeType("uint32_t") int value) { XrBoundary2DFB.nvertexCountOutput(address(), value); return this; }
/** Sets the address of the specified {@link XrVector2f.Buffer} to the {@link XrBoundary2DFB#vertices} field. */
public XrBoundary2DFB.Buffer vertices(@NativeType("XrVector2f *") XrVector2f.@Nullable Buffer value) { XrBoundary2DFB.nvertices(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy