org.lwjgl.openxr.XrNewSceneComputeInfoMSFT 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.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* The information to compute a new scene.
*
* Valid Usage (Implicit)
*
*
* - The {@link MSFTSceneUnderstanding XR_MSFT_scene_understanding} extension must be enabled prior to using {@link XrNewSceneComputeInfoMSFT}
* - {@code type} must be {@link MSFTSceneUnderstanding#XR_TYPE_NEW_SCENE_COMPUTE_INFO_MSFT TYPE_NEW_SCENE_COMPUTE_INFO_MSFT}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain. See also: {@link XrVisualMeshComputeLodInfoMSFT}
* - {@code requestedFeatures} must be a pointer to an array of {@code requestedFeatureCount} valid {@code XrSceneComputeFeatureMSFT} values
* - {@code consistency} must be a valid {@code XrSceneComputeConsistencyMSFT} value
* - {@code bounds} must be a valid {@link XrSceneBoundsMSFT} structure
* - The {@code requestedFeatureCount} parameter must be greater than 0
*
*
* See Also
*
* {@link XrSceneBoundsMSFT}, {@link MSFTSceneUnderstanding#xrComputeNewSceneMSFT ComputeNewSceneMSFT}
*
* Layout
*
*
* struct XrNewSceneComputeInfoMSFT {
* XrStructureType {@link #type};
* void const * {@link #next};
* uint32_t {@link #requestedFeatureCount};
* XrSceneComputeFeatureMSFT const * {@link #requestedFeatures};
* XrSceneComputeConsistencyMSFT {@link #consistency};
* {@link XrSceneBoundsMSFT XrSceneBoundsMSFT} {@link #bounds};
* }
*/
public class XrNewSceneComputeInfoMSFT 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,
REQUESTEDFEATURECOUNT,
REQUESTEDFEATURES,
CONSISTENCY,
BOUNDS;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(XrSceneBoundsMSFT.SIZEOF, XrSceneBoundsMSFT.ALIGNOF)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
REQUESTEDFEATURECOUNT = layout.offsetof(2);
REQUESTEDFEATURES = layout.offsetof(3);
CONSISTENCY = layout.offsetof(4);
BOUNDS = layout.offsetof(5);
}
protected XrNewSceneComputeInfoMSFT(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrNewSceneComputeInfoMSFT create(long address, @Nullable ByteBuffer container) {
return new XrNewSceneComputeInfoMSFT(address, container);
}
/**
* Creates a {@code XrNewSceneComputeInfoMSFT} 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 XrNewSceneComputeInfoMSFT(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 const *")
public long next() { return nnext(address()); }
/** the number of features. */
@NativeType("uint32_t")
public int requestedFeatureCount() { return nrequestedFeatureCount(address()); }
/** an array of {@code XrSceneComputeFeatureMSFT}. */
@NativeType("XrSceneComputeFeatureMSFT const *")
public IntBuffer requestedFeatures() { return nrequestedFeatures(address()); }
/** indicates the requested {@code XrSceneComputeConsistencyMSFT}, trading off speed against the quality of the resulting scene. */
@NativeType("XrSceneComputeConsistencyMSFT")
public int consistency() { return nconsistency(address()); }
/** an {@link XrSceneBoundsMSFT} representing the culling volume. Scene components entirely outside this volume should culled. */
public XrSceneBoundsMSFT bounds() { return nbounds(address()); }
/** Sets the specified value to the {@link #type} field. */
public XrNewSceneComputeInfoMSFT type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link MSFTSceneUnderstanding#XR_TYPE_NEW_SCENE_COMPUTE_INFO_MSFT TYPE_NEW_SCENE_COMPUTE_INFO_MSFT} value to the {@link #type} field. */
public XrNewSceneComputeInfoMSFT type$Default() { return type(MSFTSceneUnderstanding.XR_TYPE_NEW_SCENE_COMPUTE_INFO_MSFT); }
/** Sets the specified value to the {@link #next} field. */
public XrNewSceneComputeInfoMSFT next(@NativeType("void const *") long value) { nnext(address(), value); return this; }
/** Prepends the specified {@link XrVisualMeshComputeLodInfoMSFT} value to the {@code next} chain. */
public XrNewSceneComputeInfoMSFT next(XrVisualMeshComputeLodInfoMSFT value) { return this.next(value.next(this.next()).address()); }
/** Sets the address of the specified {@link IntBuffer} to the {@link #requestedFeatures} field. */
public XrNewSceneComputeInfoMSFT requestedFeatures(@NativeType("XrSceneComputeFeatureMSFT const *") IntBuffer value) { nrequestedFeatures(address(), value); return this; }
/** Sets the specified value to the {@link #consistency} field. */
public XrNewSceneComputeInfoMSFT consistency(@NativeType("XrSceneComputeConsistencyMSFT") int value) { nconsistency(address(), value); return this; }
/** Copies the specified {@link XrSceneBoundsMSFT} to the {@link #bounds} field. */
public XrNewSceneComputeInfoMSFT bounds(XrSceneBoundsMSFT value) { nbounds(address(), value); return this; }
/** Passes the {@link #bounds} field to the specified {@link java.util.function.Consumer Consumer}. */
public XrNewSceneComputeInfoMSFT bounds(java.util.function.Consumer consumer) { consumer.accept(bounds()); return this; }
/** Initializes this struct with the specified values. */
public XrNewSceneComputeInfoMSFT set(
int type,
long next,
IntBuffer requestedFeatures,
int consistency,
XrSceneBoundsMSFT bounds
) {
type(type);
next(next);
requestedFeatures(requestedFeatures);
consistency(consistency);
bounds(bounds);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrNewSceneComputeInfoMSFT set(XrNewSceneComputeInfoMSFT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrNewSceneComputeInfoMSFT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrNewSceneComputeInfoMSFT malloc() {
return new XrNewSceneComputeInfoMSFT(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrNewSceneComputeInfoMSFT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrNewSceneComputeInfoMSFT calloc() {
return new XrNewSceneComputeInfoMSFT(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrNewSceneComputeInfoMSFT} instance allocated with {@link BufferUtils}. */
public static XrNewSceneComputeInfoMSFT create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrNewSceneComputeInfoMSFT(memAddress(container), container);
}
/** Returns a new {@code XrNewSceneComputeInfoMSFT} instance for the specified memory address. */
public static XrNewSceneComputeInfoMSFT create(long address) {
return new XrNewSceneComputeInfoMSFT(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrNewSceneComputeInfoMSFT createSafe(long address) {
return address == NULL ? null : new XrNewSceneComputeInfoMSFT(address, null);
}
/**
* Returns a new {@link XrNewSceneComputeInfoMSFT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrNewSceneComputeInfoMSFT.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrNewSceneComputeInfoMSFT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrNewSceneComputeInfoMSFT.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrNewSceneComputeInfoMSFT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrNewSceneComputeInfoMSFT.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrNewSceneComputeInfoMSFT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrNewSceneComputeInfoMSFT.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 XrNewSceneComputeInfoMSFT.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrNewSceneComputeInfoMSFT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrNewSceneComputeInfoMSFT malloc(MemoryStack stack) {
return new XrNewSceneComputeInfoMSFT(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrNewSceneComputeInfoMSFT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrNewSceneComputeInfoMSFT calloc(MemoryStack stack) {
return new XrNewSceneComputeInfoMSFT(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrNewSceneComputeInfoMSFT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrNewSceneComputeInfoMSFT.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrNewSceneComputeInfoMSFT.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 XrNewSceneComputeInfoMSFT.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 + XrNewSceneComputeInfoMSFT.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrNewSceneComputeInfoMSFT.NEXT); }
/** Unsafe version of {@link #requestedFeatureCount}. */
public static int nrequestedFeatureCount(long struct) { return memGetInt(struct + XrNewSceneComputeInfoMSFT.REQUESTEDFEATURECOUNT); }
/** Unsafe version of {@link #requestedFeatures() requestedFeatures}. */
public static IntBuffer nrequestedFeatures(long struct) { return memIntBuffer(memGetAddress(struct + XrNewSceneComputeInfoMSFT.REQUESTEDFEATURES), nrequestedFeatureCount(struct)); }
/** Unsafe version of {@link #consistency}. */
public static int nconsistency(long struct) { return memGetInt(struct + XrNewSceneComputeInfoMSFT.CONSISTENCY); }
/** Unsafe version of {@link #bounds}. */
public static XrSceneBoundsMSFT nbounds(long struct) { return XrSceneBoundsMSFT.create(struct + XrNewSceneComputeInfoMSFT.BOUNDS); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrNewSceneComputeInfoMSFT.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrNewSceneComputeInfoMSFT.NEXT, value); }
/** Sets the specified value to the {@code requestedFeatureCount} field of the specified {@code struct}. */
public static void nrequestedFeatureCount(long struct, int value) { memPutInt(struct + XrNewSceneComputeInfoMSFT.REQUESTEDFEATURECOUNT, value); }
/** Unsafe version of {@link #requestedFeatures(IntBuffer) requestedFeatures}. */
public static void nrequestedFeatures(long struct, IntBuffer value) { memPutAddress(struct + XrNewSceneComputeInfoMSFT.REQUESTEDFEATURES, memAddress(value)); nrequestedFeatureCount(struct, value.remaining()); }
/** Unsafe version of {@link #consistency(int) consistency}. */
public static void nconsistency(long struct, int value) { memPutInt(struct + XrNewSceneComputeInfoMSFT.CONSISTENCY, value); }
/** Unsafe version of {@link #bounds(XrSceneBoundsMSFT) bounds}. */
public static void nbounds(long struct, XrSceneBoundsMSFT value) { memCopy(value.address(), struct + XrNewSceneComputeInfoMSFT.BOUNDS, XrSceneBoundsMSFT.SIZEOF); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + XrNewSceneComputeInfoMSFT.REQUESTEDFEATURES));
XrSceneBoundsMSFT.validate(struct + XrNewSceneComputeInfoMSFT.BOUNDS);
}
// -----------------------------------
/** An array of {@link XrNewSceneComputeInfoMSFT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrNewSceneComputeInfoMSFT ELEMENT_FACTORY = XrNewSceneComputeInfoMSFT.create(-1L);
/**
* Creates a new {@code XrNewSceneComputeInfoMSFT.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 XrNewSceneComputeInfoMSFT#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 XrNewSceneComputeInfoMSFT getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrNewSceneComputeInfoMSFT#type} field. */
@NativeType("XrStructureType")
public int type() { return XrNewSceneComputeInfoMSFT.ntype(address()); }
/** @return the value of the {@link XrNewSceneComputeInfoMSFT#next} field. */
@NativeType("void const *")
public long next() { return XrNewSceneComputeInfoMSFT.nnext(address()); }
/** @return the value of the {@link XrNewSceneComputeInfoMSFT#requestedFeatureCount} field. */
@NativeType("uint32_t")
public int requestedFeatureCount() { return XrNewSceneComputeInfoMSFT.nrequestedFeatureCount(address()); }
/** @return a {@link IntBuffer} view of the data pointed to by the {@link XrNewSceneComputeInfoMSFT#requestedFeatures} field. */
@NativeType("XrSceneComputeFeatureMSFT const *")
public IntBuffer requestedFeatures() { return XrNewSceneComputeInfoMSFT.nrequestedFeatures(address()); }
/** @return the value of the {@link XrNewSceneComputeInfoMSFT#consistency} field. */
@NativeType("XrSceneComputeConsistencyMSFT")
public int consistency() { return XrNewSceneComputeInfoMSFT.nconsistency(address()); }
/** @return a {@link XrSceneBoundsMSFT} view of the {@link XrNewSceneComputeInfoMSFT#bounds} field. */
public XrSceneBoundsMSFT bounds() { return XrNewSceneComputeInfoMSFT.nbounds(address()); }
/** Sets the specified value to the {@link XrNewSceneComputeInfoMSFT#type} field. */
public XrNewSceneComputeInfoMSFT.Buffer type(@NativeType("XrStructureType") int value) { XrNewSceneComputeInfoMSFT.ntype(address(), value); return this; }
/** Sets the {@link MSFTSceneUnderstanding#XR_TYPE_NEW_SCENE_COMPUTE_INFO_MSFT TYPE_NEW_SCENE_COMPUTE_INFO_MSFT} value to the {@link XrNewSceneComputeInfoMSFT#type} field. */
public XrNewSceneComputeInfoMSFT.Buffer type$Default() { return type(MSFTSceneUnderstanding.XR_TYPE_NEW_SCENE_COMPUTE_INFO_MSFT); }
/** Sets the specified value to the {@link XrNewSceneComputeInfoMSFT#next} field. */
public XrNewSceneComputeInfoMSFT.Buffer next(@NativeType("void const *") long value) { XrNewSceneComputeInfoMSFT.nnext(address(), value); return this; }
/** Prepends the specified {@link XrVisualMeshComputeLodInfoMSFT} value to the {@code next} chain. */
public XrNewSceneComputeInfoMSFT.Buffer next(XrVisualMeshComputeLodInfoMSFT value) { return this.next(value.next(this.next()).address()); }
/** Sets the address of the specified {@link IntBuffer} to the {@link XrNewSceneComputeInfoMSFT#requestedFeatures} field. */
public XrNewSceneComputeInfoMSFT.Buffer requestedFeatures(@NativeType("XrSceneComputeFeatureMSFT const *") IntBuffer value) { XrNewSceneComputeInfoMSFT.nrequestedFeatures(address(), value); return this; }
/** Sets the specified value to the {@link XrNewSceneComputeInfoMSFT#consistency} field. */
public XrNewSceneComputeInfoMSFT.Buffer consistency(@NativeType("XrSceneComputeConsistencyMSFT") int value) { XrNewSceneComputeInfoMSFT.nconsistency(address(), value); return this; }
/** Copies the specified {@link XrSceneBoundsMSFT} to the {@link XrNewSceneComputeInfoMSFT#bounds} field. */
public XrNewSceneComputeInfoMSFT.Buffer bounds(XrSceneBoundsMSFT value) { XrNewSceneComputeInfoMSFT.nbounds(address(), value); return this; }
/** Passes the {@link XrNewSceneComputeInfoMSFT#bounds} field to the specified {@link java.util.function.Consumer Consumer}. */
public XrNewSceneComputeInfoMSFT.Buffer bounds(java.util.function.Consumer consumer) { consumer.accept(bounds()); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy