org.lwjgl.openxr.XrEventDataReferenceSpaceChangePending 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.*;
/**
* Notifies the application that a reference space is changing.
*
* Description
*
* The {@link XrEventDataReferenceSpaceChangePending} event is sent to the application to notify it that the origin (and perhaps the bounds) of a reference space is changing. This may occur due to the user recentering the space explicitly, or the runtime otherwise switching to a different space definition.
*
* The reference space change must only take effect for {@link XR10#xrLocateSpace LocateSpace} or {@link XR10#xrLocateViews LocateViews} calls whose {@code XrTime} parameter is greater than or equal to the {@code changeTime} provided in that event. Runtimes should provide a {@code changeTime} to applications that allows for a deep render pipeline to present frames that are already in flight using the previous definition of the space. Runtimes should choose a {@code changeTime} that is midway between the {@link XrFrameState}{@code ::predictedDisplayTime} of future frames to avoid threshold issues with applications that calculate future frame times using {@link XrFrameState}{@code ::predictedDisplayPeriod}.
*
* The {@code poseInPreviousSpace} provided here must only describe the change in the natural origin of the reference space and must not incorporate any origin offsets specified by the application during calls to {@link XR10#xrCreateReferenceSpace CreateReferenceSpace}. If the runtime does not know the location of the space’s new origin relative to its previous origin, {@code poseValid} must be false, and the position and orientation of {@code poseInPreviousSpace} are undefined. .Valid Usage (Implicit)
*
*
* - {@code type} must be {@link XR10#XR_TYPE_EVENT_DATA_REFERENCE_SPACE_CHANGE_PENDING TYPE_EVENT_DATA_REFERENCE_SPACE_CHANGE_PENDING}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
*
*
* See Also
*
* {@link XrPosef}, {@link XR10#xrCreateReferenceSpace CreateReferenceSpace}
*
* Layout
*
*
* struct XrEventDataReferenceSpaceChangePending {
* XrStructureType {@link #type};
* void const * {@link #next};
* XrSession {@link #session};
* XrReferenceSpaceType {@link #referenceSpaceType};
* XrTime {@link #changeTime};
* XrBool32 {@link #poseValid};
* {@link XrPosef XrPosef} {@link #poseInPreviousSpace};
* }
*/
public class XrEventDataReferenceSpaceChangePending 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,
SESSION,
REFERENCESPACETYPE,
CHANGETIME,
POSEVALID,
POSEINPREVIOUSSPACE;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(4),
__member(8),
__member(4),
__member(XrPosef.SIZEOF, XrPosef.ALIGNOF)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
SESSION = layout.offsetof(2);
REFERENCESPACETYPE = layout.offsetof(3);
CHANGETIME = layout.offsetof(4);
POSEVALID = layout.offsetof(5);
POSEINPREVIOUSSPACE = layout.offsetof(6);
}
protected XrEventDataReferenceSpaceChangePending(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrEventDataReferenceSpaceChangePending create(long address, @Nullable ByteBuffer container) {
return new XrEventDataReferenceSpaceChangePending(address, container);
}
/**
* Creates a {@code XrEventDataReferenceSpaceChangePending} 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 XrEventDataReferenceSpaceChangePending(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. */
@NativeType("void const *")
public long next() { return nnext(address()); }
/** the {@code XrSession} for which the reference space is changing. */
@NativeType("XrSession")
public long session() { return nsession(address()); }
/** the {@code XrReferenceSpaceType} that is changing. */
@NativeType("XrReferenceSpaceType")
public int referenceSpaceType() { return nreferenceSpaceType(address()); }
/** the target {@code XrTime} after which {@link XR10#xrLocateSpace LocateSpace} or {@link XR10#xrLocateViews LocateViews} will return values that respect this change. */
@NativeType("XrTime")
public long changeTime() { return nchangeTime(address()); }
/** true if the runtime can determine the {@code poseInPreviousSpace} of the new space in the previous space before the change. */
@NativeType("XrBool32")
public boolean poseValid() { return nposeValid(address()) != 0; }
/** an {@link XrPosef} defining the position and orientation of the new reference space’s natural origin within the natural reference frame of its previous space. */
public XrPosef poseInPreviousSpace() { return nposeInPreviousSpace(address()); }
/** Sets the specified value to the {@link #type} field. */
public XrEventDataReferenceSpaceChangePending type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link XR10#XR_TYPE_EVENT_DATA_REFERENCE_SPACE_CHANGE_PENDING TYPE_EVENT_DATA_REFERENCE_SPACE_CHANGE_PENDING} value to the {@link #type} field. */
public XrEventDataReferenceSpaceChangePending type$Default() { return type(XR10.XR_TYPE_EVENT_DATA_REFERENCE_SPACE_CHANGE_PENDING); }
/** Sets the specified value to the {@link #next} field. */
public XrEventDataReferenceSpaceChangePending next(@NativeType("void const *") long value) { nnext(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrEventDataReferenceSpaceChangePending set(
int type,
long next
) {
type(type);
next(next);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrEventDataReferenceSpaceChangePending set(XrEventDataReferenceSpaceChangePending src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrEventDataReferenceSpaceChangePending} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrEventDataReferenceSpaceChangePending malloc() {
return new XrEventDataReferenceSpaceChangePending(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrEventDataReferenceSpaceChangePending} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrEventDataReferenceSpaceChangePending calloc() {
return new XrEventDataReferenceSpaceChangePending(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrEventDataReferenceSpaceChangePending} instance allocated with {@link BufferUtils}. */
public static XrEventDataReferenceSpaceChangePending create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrEventDataReferenceSpaceChangePending(memAddress(container), container);
}
/** Returns a new {@code XrEventDataReferenceSpaceChangePending} instance for the specified memory address. */
public static XrEventDataReferenceSpaceChangePending create(long address) {
return new XrEventDataReferenceSpaceChangePending(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrEventDataReferenceSpaceChangePending createSafe(long address) {
return address == NULL ? null : new XrEventDataReferenceSpaceChangePending(address, null);
}
/** Downcasts the specified {@code XrEventDataBaseHeader} instance to {@code XrEventDataReferenceSpaceChangePending}. */
public static XrEventDataReferenceSpaceChangePending create(XrEventDataBaseHeader value) {
return new XrEventDataReferenceSpaceChangePending(value.address(), __getContainer(value));
}
/**
* Returns a new {@link XrEventDataReferenceSpaceChangePending.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrEventDataReferenceSpaceChangePending.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrEventDataReferenceSpaceChangePending.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrEventDataReferenceSpaceChangePending.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrEventDataReferenceSpaceChangePending.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrEventDataReferenceSpaceChangePending.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrEventDataReferenceSpaceChangePending.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrEventDataReferenceSpaceChangePending.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 XrEventDataReferenceSpaceChangePending.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/** Downcasts the specified {@code XrEventDataBaseHeader.Buffer} instance to {@code XrEventDataReferenceSpaceChangePending.Buffer}. */
public static XrEventDataReferenceSpaceChangePending.Buffer create(XrEventDataBaseHeader.Buffer value) {
return new XrEventDataReferenceSpaceChangePending.Buffer(value.address(), __getContainer(value), -1, 0, value.remaining(), value.remaining());
}
/**
* Returns a new {@code XrEventDataReferenceSpaceChangePending} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrEventDataReferenceSpaceChangePending malloc(MemoryStack stack) {
return new XrEventDataReferenceSpaceChangePending(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrEventDataReferenceSpaceChangePending} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrEventDataReferenceSpaceChangePending calloc(MemoryStack stack) {
return new XrEventDataReferenceSpaceChangePending(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrEventDataReferenceSpaceChangePending.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrEventDataReferenceSpaceChangePending.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrEventDataReferenceSpaceChangePending.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 XrEventDataReferenceSpaceChangePending.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 + XrEventDataReferenceSpaceChangePending.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrEventDataReferenceSpaceChangePending.NEXT); }
/** Unsafe version of {@link #session}. */
public static long nsession(long struct) { return memGetAddress(struct + XrEventDataReferenceSpaceChangePending.SESSION); }
/** Unsafe version of {@link #referenceSpaceType}. */
public static int nreferenceSpaceType(long struct) { return memGetInt(struct + XrEventDataReferenceSpaceChangePending.REFERENCESPACETYPE); }
/** Unsafe version of {@link #changeTime}. */
public static long nchangeTime(long struct) { return memGetLong(struct + XrEventDataReferenceSpaceChangePending.CHANGETIME); }
/** Unsafe version of {@link #poseValid}. */
public static int nposeValid(long struct) { return memGetInt(struct + XrEventDataReferenceSpaceChangePending.POSEVALID); }
/** Unsafe version of {@link #poseInPreviousSpace}. */
public static XrPosef nposeInPreviousSpace(long struct) { return XrPosef.create(struct + XrEventDataReferenceSpaceChangePending.POSEINPREVIOUSSPACE); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrEventDataReferenceSpaceChangePending.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrEventDataReferenceSpaceChangePending.NEXT, value); }
// -----------------------------------
/** An array of {@link XrEventDataReferenceSpaceChangePending} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrEventDataReferenceSpaceChangePending ELEMENT_FACTORY = XrEventDataReferenceSpaceChangePending.create(-1L);
/**
* Creates a new {@code XrEventDataReferenceSpaceChangePending.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 XrEventDataReferenceSpaceChangePending#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 XrEventDataReferenceSpaceChangePending getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrEventDataReferenceSpaceChangePending#type} field. */
@NativeType("XrStructureType")
public int type() { return XrEventDataReferenceSpaceChangePending.ntype(address()); }
/** @return the value of the {@link XrEventDataReferenceSpaceChangePending#next} field. */
@NativeType("void const *")
public long next() { return XrEventDataReferenceSpaceChangePending.nnext(address()); }
/** @return the value of the {@link XrEventDataReferenceSpaceChangePending#session} field. */
@NativeType("XrSession")
public long session() { return XrEventDataReferenceSpaceChangePending.nsession(address()); }
/** @return the value of the {@link XrEventDataReferenceSpaceChangePending#referenceSpaceType} field. */
@NativeType("XrReferenceSpaceType")
public int referenceSpaceType() { return XrEventDataReferenceSpaceChangePending.nreferenceSpaceType(address()); }
/** @return the value of the {@link XrEventDataReferenceSpaceChangePending#changeTime} field. */
@NativeType("XrTime")
public long changeTime() { return XrEventDataReferenceSpaceChangePending.nchangeTime(address()); }
/** @return the value of the {@link XrEventDataReferenceSpaceChangePending#poseValid} field. */
@NativeType("XrBool32")
public boolean poseValid() { return XrEventDataReferenceSpaceChangePending.nposeValid(address()) != 0; }
/** @return a {@link XrPosef} view of the {@link XrEventDataReferenceSpaceChangePending#poseInPreviousSpace} field. */
public XrPosef poseInPreviousSpace() { return XrEventDataReferenceSpaceChangePending.nposeInPreviousSpace(address()); }
/** Sets the specified value to the {@link XrEventDataReferenceSpaceChangePending#type} field. */
public XrEventDataReferenceSpaceChangePending.Buffer type(@NativeType("XrStructureType") int value) { XrEventDataReferenceSpaceChangePending.ntype(address(), value); return this; }
/** Sets the {@link XR10#XR_TYPE_EVENT_DATA_REFERENCE_SPACE_CHANGE_PENDING TYPE_EVENT_DATA_REFERENCE_SPACE_CHANGE_PENDING} value to the {@link XrEventDataReferenceSpaceChangePending#type} field. */
public XrEventDataReferenceSpaceChangePending.Buffer type$Default() { return type(XR10.XR_TYPE_EVENT_DATA_REFERENCE_SPACE_CHANGE_PENDING); }
/** Sets the specified value to the {@link XrEventDataReferenceSpaceChangePending#next} field. */
public XrEventDataReferenceSpaceChangePending.Buffer next(@NativeType("void const *") long value) { XrEventDataReferenceSpaceChangePending.nnext(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy