org.lwjgl.openxr.XrSceneDeserializeInfoMSFT Maven / Gradle / Ivy
Show all versions of lwjgl-openxr Show documentation
/*
* 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 deserialize a binary scene.
*
* Description
*
* If the scene fragments are not in the same order as returned by {@link MSFTSceneUnderstanding#xrGetSceneComponentsMSFT GetSceneComponentsMSFT} or the runtime failed to deserialized the binary data then {@link MSFTSceneUnderstanding#xrGetSceneComputeStateMSFT GetSceneComputeStateMSFT} must return {@link MSFTSceneUnderstanding#XR_SCENE_COMPUTE_STATE_COMPLETED_WITH_ERROR_MSFT SCENE_COMPUTE_STATE_COMPLETED_WITH_ERROR_MSFT}.
*
* Valid Usage (Implicit)
*
*
* - The {@link MSFTSceneUnderstandingSerialization XR_MSFT_scene_understanding_serialization} extension must be enabled prior to using {@link XrSceneDeserializeInfoMSFT}
* - {@code type} must be {@link MSFTSceneUnderstandingSerialization#XR_TYPE_SCENE_DESERIALIZE_INFO_MSFT TYPE_SCENE_DESERIALIZE_INFO_MSFT}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
* - If {@code fragmentCount} is not 0, {@code fragments} must be a pointer to an array of {@code fragmentCount} valid {@link XrDeserializeSceneFragmentMSFT} structures
*
*
* See Also
*
* {@link XrDeserializeSceneFragmentMSFT}, {@link MSFTSceneUnderstandingSerialization#xrDeserializeSceneMSFT DeserializeSceneMSFT}
*
* Layout
*
*
* struct XrSceneDeserializeInfoMSFT {
* XrStructureType {@link #type};
* void const * {@link #next};
* uint32_t {@link #fragmentCount};
* {@link XrDeserializeSceneFragmentMSFT XrDeserializeSceneFragmentMSFT} const * {@link #fragments};
* }
*/
public class XrSceneDeserializeInfoMSFT 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,
FRAGMENTCOUNT,
FRAGMENTS;
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);
FRAGMENTCOUNT = layout.offsetof(2);
FRAGMENTS = layout.offsetof(3);
}
protected XrSceneDeserializeInfoMSFT(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrSceneDeserializeInfoMSFT create(long address, @Nullable ByteBuffer container) {
return new XrSceneDeserializeInfoMSFT(address, container);
}
/**
* Creates a {@code XrSceneDeserializeInfoMSFT} 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 XrSceneDeserializeInfoMSFT(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 count of {@link XrDeserializeSceneFragmentMSFT} structures in the {@code fragments} array. */
@NativeType("uint32_t")
public int fragmentCount() { return nfragmentCount(address()); }
/** an array of {@link XrDeserializeSceneFragmentMSFT}. */
@NativeType("XrDeserializeSceneFragmentMSFT const *")
public XrDeserializeSceneFragmentMSFT.@Nullable Buffer fragments() { return nfragments(address()); }
/** Sets the specified value to the {@link #type} field. */
public XrSceneDeserializeInfoMSFT type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link MSFTSceneUnderstandingSerialization#XR_TYPE_SCENE_DESERIALIZE_INFO_MSFT TYPE_SCENE_DESERIALIZE_INFO_MSFT} value to the {@link #type} field. */
public XrSceneDeserializeInfoMSFT type$Default() { return type(MSFTSceneUnderstandingSerialization.XR_TYPE_SCENE_DESERIALIZE_INFO_MSFT); }
/** Sets the specified value to the {@link #next} field. */
public XrSceneDeserializeInfoMSFT next(@NativeType("void const *") long value) { nnext(address(), value); return this; }
/** Sets the specified value to the {@link #fragmentCount} field. */
public XrSceneDeserializeInfoMSFT fragmentCount(@NativeType("uint32_t") int value) { nfragmentCount(address(), value); return this; }
/** Sets the address of the specified {@link XrDeserializeSceneFragmentMSFT.Buffer} to the {@link #fragments} field. */
public XrSceneDeserializeInfoMSFT fragments(@NativeType("XrDeserializeSceneFragmentMSFT const *") XrDeserializeSceneFragmentMSFT.@Nullable Buffer value) { nfragments(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrSceneDeserializeInfoMSFT set(
int type,
long next,
int fragmentCount,
XrDeserializeSceneFragmentMSFT.@Nullable Buffer fragments
) {
type(type);
next(next);
fragmentCount(fragmentCount);
fragments(fragments);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrSceneDeserializeInfoMSFT set(XrSceneDeserializeInfoMSFT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrSceneDeserializeInfoMSFT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrSceneDeserializeInfoMSFT malloc() {
return new XrSceneDeserializeInfoMSFT(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrSceneDeserializeInfoMSFT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrSceneDeserializeInfoMSFT calloc() {
return new XrSceneDeserializeInfoMSFT(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrSceneDeserializeInfoMSFT} instance allocated with {@link BufferUtils}. */
public static XrSceneDeserializeInfoMSFT create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrSceneDeserializeInfoMSFT(memAddress(container), container);
}
/** Returns a new {@code XrSceneDeserializeInfoMSFT} instance for the specified memory address. */
public static XrSceneDeserializeInfoMSFT create(long address) {
return new XrSceneDeserializeInfoMSFT(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrSceneDeserializeInfoMSFT createSafe(long address) {
return address == NULL ? null : new XrSceneDeserializeInfoMSFT(address, null);
}
/**
* Returns a new {@link XrSceneDeserializeInfoMSFT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrSceneDeserializeInfoMSFT.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrSceneDeserializeInfoMSFT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrSceneDeserializeInfoMSFT.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrSceneDeserializeInfoMSFT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrSceneDeserializeInfoMSFT.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrSceneDeserializeInfoMSFT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrSceneDeserializeInfoMSFT.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 XrSceneDeserializeInfoMSFT.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrSceneDeserializeInfoMSFT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrSceneDeserializeInfoMSFT malloc(MemoryStack stack) {
return new XrSceneDeserializeInfoMSFT(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrSceneDeserializeInfoMSFT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrSceneDeserializeInfoMSFT calloc(MemoryStack stack) {
return new XrSceneDeserializeInfoMSFT(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrSceneDeserializeInfoMSFT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrSceneDeserializeInfoMSFT.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrSceneDeserializeInfoMSFT.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 XrSceneDeserializeInfoMSFT.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 + XrSceneDeserializeInfoMSFT.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrSceneDeserializeInfoMSFT.NEXT); }
/** Unsafe version of {@link #fragmentCount}. */
public static int nfragmentCount(long struct) { return memGetInt(struct + XrSceneDeserializeInfoMSFT.FRAGMENTCOUNT); }
/** Unsafe version of {@link #fragments}. */
public static XrDeserializeSceneFragmentMSFT.@Nullable Buffer nfragments(long struct) { return XrDeserializeSceneFragmentMSFT.createSafe(memGetAddress(struct + XrSceneDeserializeInfoMSFT.FRAGMENTS), nfragmentCount(struct)); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrSceneDeserializeInfoMSFT.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrSceneDeserializeInfoMSFT.NEXT, value); }
/** Sets the specified value to the {@code fragmentCount} field of the specified {@code struct}. */
public static void nfragmentCount(long struct, int value) { memPutInt(struct + XrSceneDeserializeInfoMSFT.FRAGMENTCOUNT, value); }
/** Unsafe version of {@link #fragments(XrDeserializeSceneFragmentMSFT.Buffer) fragments}. */
public static void nfragments(long struct, XrDeserializeSceneFragmentMSFT.@Nullable Buffer value) { memPutAddress(struct + XrSceneDeserializeInfoMSFT.FRAGMENTS, memAddressSafe(value)); if (value != null) { nfragmentCount(struct, value.remaining()); } }
// -----------------------------------
/** An array of {@link XrSceneDeserializeInfoMSFT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrSceneDeserializeInfoMSFT ELEMENT_FACTORY = XrSceneDeserializeInfoMSFT.create(-1L);
/**
* Creates a new {@code XrSceneDeserializeInfoMSFT.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 XrSceneDeserializeInfoMSFT#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 XrSceneDeserializeInfoMSFT getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrSceneDeserializeInfoMSFT#type} field. */
@NativeType("XrStructureType")
public int type() { return XrSceneDeserializeInfoMSFT.ntype(address()); }
/** @return the value of the {@link XrSceneDeserializeInfoMSFT#next} field. */
@NativeType("void const *")
public long next() { return XrSceneDeserializeInfoMSFT.nnext(address()); }
/** @return the value of the {@link XrSceneDeserializeInfoMSFT#fragmentCount} field. */
@NativeType("uint32_t")
public int fragmentCount() { return XrSceneDeserializeInfoMSFT.nfragmentCount(address()); }
/** @return a {@link XrDeserializeSceneFragmentMSFT.Buffer} view of the struct array pointed to by the {@link XrSceneDeserializeInfoMSFT#fragments} field. */
@NativeType("XrDeserializeSceneFragmentMSFT const *")
public XrDeserializeSceneFragmentMSFT.@Nullable Buffer fragments() { return XrSceneDeserializeInfoMSFT.nfragments(address()); }
/** Sets the specified value to the {@link XrSceneDeserializeInfoMSFT#type} field. */
public XrSceneDeserializeInfoMSFT.Buffer type(@NativeType("XrStructureType") int value) { XrSceneDeserializeInfoMSFT.ntype(address(), value); return this; }
/** Sets the {@link MSFTSceneUnderstandingSerialization#XR_TYPE_SCENE_DESERIALIZE_INFO_MSFT TYPE_SCENE_DESERIALIZE_INFO_MSFT} value to the {@link XrSceneDeserializeInfoMSFT#type} field. */
public XrSceneDeserializeInfoMSFT.Buffer type$Default() { return type(MSFTSceneUnderstandingSerialization.XR_TYPE_SCENE_DESERIALIZE_INFO_MSFT); }
/** Sets the specified value to the {@link XrSceneDeserializeInfoMSFT#next} field. */
public XrSceneDeserializeInfoMSFT.Buffer next(@NativeType("void const *") long value) { XrSceneDeserializeInfoMSFT.nnext(address(), value); return this; }
/** Sets the specified value to the {@link XrSceneDeserializeInfoMSFT#fragmentCount} field. */
public XrSceneDeserializeInfoMSFT.Buffer fragmentCount(@NativeType("uint32_t") int value) { XrSceneDeserializeInfoMSFT.nfragmentCount(address(), value); return this; }
/** Sets the address of the specified {@link XrDeserializeSceneFragmentMSFT.Buffer} to the {@link XrSceneDeserializeInfoMSFT#fragments} field. */
public XrSceneDeserializeInfoMSFT.Buffer fragments(@NativeType("XrDeserializeSceneFragmentMSFT const *") XrDeserializeSceneFragmentMSFT.@Nullable Buffer value) { XrSceneDeserializeInfoMSFT.nfragments(address(), value); return this; }
}
}