org.lwjgl.openxr.XrSceneObjectsMSFT 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.*;
/**
* Scene objects.
*
* Description
*
* The runtime must only set {@link XrSceneObjectMSFT}{@code ::objectType} to any of the following {@code XrSceneObjectTypeMSFT} values:
*
*
* - {@link MSFTSceneUnderstanding#XR_SCENE_OBJECT_TYPE_UNCATEGORIZED_MSFT SCENE_OBJECT_TYPE_UNCATEGORIZED_MSFT}
* - {@link MSFTSceneUnderstanding#XR_SCENE_OBJECT_TYPE_BACKGROUND_MSFT SCENE_OBJECT_TYPE_BACKGROUND_MSFT}
* - {@link MSFTSceneUnderstanding#XR_SCENE_OBJECT_TYPE_WALL_MSFT SCENE_OBJECT_TYPE_WALL_MSFT}
* - {@link MSFTSceneUnderstanding#XR_SCENE_OBJECT_TYPE_FLOOR_MSFT SCENE_OBJECT_TYPE_FLOOR_MSFT}
* - {@link MSFTSceneUnderstanding#XR_SCENE_OBJECT_TYPE_CEILING_MSFT SCENE_OBJECT_TYPE_CEILING_MSFT}
* - {@link MSFTSceneUnderstanding#XR_SCENE_OBJECT_TYPE_PLATFORM_MSFT SCENE_OBJECT_TYPE_PLATFORM_MSFT}
* - {@link MSFTSceneUnderstanding#XR_SCENE_OBJECT_TYPE_INFERRED_MSFT SCENE_OBJECT_TYPE_INFERRED_MSFT}
*
*
* Valid Usage (Implicit)
*
*
* - The {@link MSFTSceneUnderstanding XR_MSFT_scene_understanding} extension must be enabled prior to using {@link XrSceneObjectsMSFT}
* - {@code type} must be {@link MSFTSceneUnderstanding#XR_TYPE_SCENE_OBJECTS_MSFT TYPE_SCENE_OBJECTS_MSFT}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
* - If {@code sceneObjectCount} is not 0, {@code sceneObjects} must be a pointer to an array of {@code sceneObjectCount} {@link XrSceneObjectMSFT} structures
*
*
* See Also
*
* {@link XrSceneComponentsMSFT}, {@link XrSceneObjectMSFT}
*
* Layout
*
*
* struct XrSceneObjectsMSFT {
* XrStructureType {@link #type};
* void * {@link #next};
* uint32_t {@link #sceneObjectCount};
* {@link XrSceneObjectMSFT XrSceneObjectMSFT} * {@link #sceneObjects};
* }
*/
public class XrSceneObjectsMSFT 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,
SCENEOBJECTCOUNT,
SCENEOBJECTS;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
SCENEOBJECTCOUNT = layout.offsetof(2);
SCENEOBJECTS = layout.offsetof(3);
}
protected XrSceneObjectsMSFT(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrSceneObjectsMSFT create(long address, @Nullable ByteBuffer container) {
return new XrSceneObjectsMSFT(address, container);
}
/**
* Creates a {@code XrSceneObjectsMSFT} 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 XrSceneObjectsMSFT(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. */
@NativeType("void *")
public long next() { return nnext(address()); }
/** a {@code uint32_t} describing the count of elements in the {@code sceneObjects} array. */
@NativeType("uint32_t")
public int sceneObjectCount() { return nsceneObjectCount(address()); }
/** an array of {@link XrSceneObjectMSFT}. */
@NativeType("XrSceneObjectMSFT *")
public XrSceneObjectMSFT.@Nullable Buffer sceneObjects() { return nsceneObjects(address()); }
/** Sets the specified value to the {@link #type} field. */
public XrSceneObjectsMSFT type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link MSFTSceneUnderstanding#XR_TYPE_SCENE_OBJECTS_MSFT TYPE_SCENE_OBJECTS_MSFT} value to the {@link #type} field. */
public XrSceneObjectsMSFT type$Default() { return type(MSFTSceneUnderstanding.XR_TYPE_SCENE_OBJECTS_MSFT); }
/** Sets the specified value to the {@link #next} field. */
public XrSceneObjectsMSFT next(@NativeType("void *") long value) { nnext(address(), value); return this; }
/** Sets the specified value to the {@link #sceneObjectCount} field. */
public XrSceneObjectsMSFT sceneObjectCount(@NativeType("uint32_t") int value) { nsceneObjectCount(address(), value); return this; }
/** Sets the address of the specified {@link XrSceneObjectMSFT.Buffer} to the {@link #sceneObjects} field. */
public XrSceneObjectsMSFT sceneObjects(@NativeType("XrSceneObjectMSFT *") XrSceneObjectMSFT.@Nullable Buffer value) { nsceneObjects(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrSceneObjectsMSFT set(
int type,
long next,
int sceneObjectCount,
XrSceneObjectMSFT.@Nullable Buffer sceneObjects
) {
type(type);
next(next);
sceneObjectCount(sceneObjectCount);
sceneObjects(sceneObjects);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrSceneObjectsMSFT set(XrSceneObjectsMSFT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrSceneObjectsMSFT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrSceneObjectsMSFT malloc() {
return new XrSceneObjectsMSFT(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrSceneObjectsMSFT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrSceneObjectsMSFT calloc() {
return new XrSceneObjectsMSFT(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrSceneObjectsMSFT} instance allocated with {@link BufferUtils}. */
public static XrSceneObjectsMSFT create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrSceneObjectsMSFT(memAddress(container), container);
}
/** Returns a new {@code XrSceneObjectsMSFT} instance for the specified memory address. */
public static XrSceneObjectsMSFT create(long address) {
return new XrSceneObjectsMSFT(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrSceneObjectsMSFT createSafe(long address) {
return address == NULL ? null : new XrSceneObjectsMSFT(address, null);
}
/**
* Returns a new {@link XrSceneObjectsMSFT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrSceneObjectsMSFT.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrSceneObjectsMSFT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrSceneObjectsMSFT.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrSceneObjectsMSFT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrSceneObjectsMSFT.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrSceneObjectsMSFT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrSceneObjectsMSFT.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 XrSceneObjectsMSFT.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrSceneObjectsMSFT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrSceneObjectsMSFT malloc(MemoryStack stack) {
return new XrSceneObjectsMSFT(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrSceneObjectsMSFT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrSceneObjectsMSFT calloc(MemoryStack stack) {
return new XrSceneObjectsMSFT(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrSceneObjectsMSFT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrSceneObjectsMSFT.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrSceneObjectsMSFT.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 XrSceneObjectsMSFT.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 + XrSceneObjectsMSFT.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrSceneObjectsMSFT.NEXT); }
/** Unsafe version of {@link #sceneObjectCount}. */
public static int nsceneObjectCount(long struct) { return memGetInt(struct + XrSceneObjectsMSFT.SCENEOBJECTCOUNT); }
/** Unsafe version of {@link #sceneObjects}. */
public static XrSceneObjectMSFT.@Nullable Buffer nsceneObjects(long struct) { return XrSceneObjectMSFT.createSafe(memGetAddress(struct + XrSceneObjectsMSFT.SCENEOBJECTS), nsceneObjectCount(struct)); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrSceneObjectsMSFT.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrSceneObjectsMSFT.NEXT, value); }
/** Sets the specified value to the {@code sceneObjectCount} field of the specified {@code struct}. */
public static void nsceneObjectCount(long struct, int value) { memPutInt(struct + XrSceneObjectsMSFT.SCENEOBJECTCOUNT, value); }
/** Unsafe version of {@link #sceneObjects(XrSceneObjectMSFT.Buffer) sceneObjects}. */
public static void nsceneObjects(long struct, XrSceneObjectMSFT.@Nullable Buffer value) { memPutAddress(struct + XrSceneObjectsMSFT.SCENEOBJECTS, memAddressSafe(value)); if (value != null) { nsceneObjectCount(struct, value.remaining()); } }
// -----------------------------------
/** An array of {@link XrSceneObjectsMSFT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrSceneObjectsMSFT ELEMENT_FACTORY = XrSceneObjectsMSFT.create(-1L);
/**
* Creates a new {@code XrSceneObjectsMSFT.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 XrSceneObjectsMSFT#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 XrSceneObjectsMSFT getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrSceneObjectsMSFT#type} field. */
@NativeType("XrStructureType")
public int type() { return XrSceneObjectsMSFT.ntype(address()); }
/** @return the value of the {@link XrSceneObjectsMSFT#next} field. */
@NativeType("void *")
public long next() { return XrSceneObjectsMSFT.nnext(address()); }
/** @return the value of the {@link XrSceneObjectsMSFT#sceneObjectCount} field. */
@NativeType("uint32_t")
public int sceneObjectCount() { return XrSceneObjectsMSFT.nsceneObjectCount(address()); }
/** @return a {@link XrSceneObjectMSFT.Buffer} view of the struct array pointed to by the {@link XrSceneObjectsMSFT#sceneObjects} field. */
@NativeType("XrSceneObjectMSFT *")
public XrSceneObjectMSFT.@Nullable Buffer sceneObjects() { return XrSceneObjectsMSFT.nsceneObjects(address()); }
/** Sets the specified value to the {@link XrSceneObjectsMSFT#type} field. */
public XrSceneObjectsMSFT.Buffer type(@NativeType("XrStructureType") int value) { XrSceneObjectsMSFT.ntype(address(), value); return this; }
/** Sets the {@link MSFTSceneUnderstanding#XR_TYPE_SCENE_OBJECTS_MSFT TYPE_SCENE_OBJECTS_MSFT} value to the {@link XrSceneObjectsMSFT#type} field. */
public XrSceneObjectsMSFT.Buffer type$Default() { return type(MSFTSceneUnderstanding.XR_TYPE_SCENE_OBJECTS_MSFT); }
/** Sets the specified value to the {@link XrSceneObjectsMSFT#next} field. */
public XrSceneObjectsMSFT.Buffer next(@NativeType("void *") long value) { XrSceneObjectsMSFT.nnext(address(), value); return this; }
/** Sets the specified value to the {@link XrSceneObjectsMSFT#sceneObjectCount} field. */
public XrSceneObjectsMSFT.Buffer sceneObjectCount(@NativeType("uint32_t") int value) { XrSceneObjectsMSFT.nsceneObjectCount(address(), value); return this; }
/** Sets the address of the specified {@link XrSceneObjectMSFT.Buffer} to the {@link XrSceneObjectsMSFT#sceneObjects} field. */
public XrSceneObjectsMSFT.Buffer sceneObjects(@NativeType("XrSceneObjectMSFT *") XrSceneObjectMSFT.@Nullable Buffer value) { XrSceneObjectsMSFT.nsceneObjects(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy