org.lwjgl.openxr.XrViewLocateInfo 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.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Struct containing view locate information.
*
* Description
*
* The {@link XrViewLocateInfo} structure contains the display time and space used to locate the view {@link XrView} structures.
*
* The runtime must return error {@link XR10#XR_ERROR_VIEW_CONFIGURATION_TYPE_UNSUPPORTED ERROR_VIEW_CONFIGURATION_TYPE_UNSUPPORTED} if the given {@code viewConfigurationType} is not one of the supported type reported by {@link XR10#xrEnumerateViewConfigurations EnumerateViewConfigurations}.
*
* Valid Usage (Implicit)
*
*
* - {@code type} must be {@link XR10#XR_TYPE_VIEW_LOCATE_INFO TYPE_VIEW_LOCATE_INFO}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain. See also: {@link XrViewLocateFoveatedRenderingVARJO}
* - {@code viewConfigurationType} must be a valid {@code XrViewConfigurationType} value
* - {@code space} must be a valid {@code XrSpace} handle
*
*
* See Also
*
* {@link XrView}, {@link XrViewState}, {@link XR10#xrLocateViews LocateViews}
*
* Layout
*
*
* struct XrViewLocateInfo {
* XrStructureType {@link #type};
* void const * {@link #next};
* XrViewConfigurationType {@link #viewConfigurationType};
* XrTime {@link #displayTime};
* XrSpace {@link #space};
* }
*/
public class XrViewLocateInfo 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,
VIEWCONFIGURATIONTYPE,
DISPLAYTIME,
SPACE;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(8),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
VIEWCONFIGURATIONTYPE = layout.offsetof(2);
DISPLAYTIME = layout.offsetof(3);
SPACE = layout.offsetof(4);
}
protected XrViewLocateInfo(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrViewLocateInfo create(long address, @Nullable ByteBuffer container) {
return new XrViewLocateInfo(address, container);
}
/**
* Creates a {@code XrViewLocateInfo} 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 XrViewLocateInfo(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()); }
/** {@code XrViewConfigurationType} to query for. */
@NativeType("XrViewConfigurationType")
public int viewConfigurationType() { return nviewConfigurationType(address()); }
/** the time for which the view poses are predicted. */
@NativeType("XrTime")
public long displayTime() { return ndisplayTime(address()); }
/** the {@code XrSpace} in which the {@code pose} in each {@link XrView} is expressed. */
@NativeType("XrSpace")
public long space() { return nspace(address()); }
/** Sets the specified value to the {@link #type} field. */
public XrViewLocateInfo type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link XR10#XR_TYPE_VIEW_LOCATE_INFO TYPE_VIEW_LOCATE_INFO} value to the {@link #type} field. */
public XrViewLocateInfo type$Default() { return type(XR10.XR_TYPE_VIEW_LOCATE_INFO); }
/** Sets the specified value to the {@link #next} field. */
public XrViewLocateInfo next(@NativeType("void const *") long value) { nnext(address(), value); return this; }
/** Prepends the specified {@link XrViewLocateFoveatedRenderingVARJO} value to the {@code next} chain. */
public XrViewLocateInfo next(XrViewLocateFoveatedRenderingVARJO value) { return this.next(value.next(this.next()).address()); }
/** Sets the specified value to the {@link #viewConfigurationType} field. */
public XrViewLocateInfo viewConfigurationType(@NativeType("XrViewConfigurationType") int value) { nviewConfigurationType(address(), value); return this; }
/** Sets the specified value to the {@link #displayTime} field. */
public XrViewLocateInfo displayTime(@NativeType("XrTime") long value) { ndisplayTime(address(), value); return this; }
/** Sets the specified value to the {@link #space} field. */
public XrViewLocateInfo space(XrSpace value) { nspace(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrViewLocateInfo set(
int type,
long next,
int viewConfigurationType,
long displayTime,
XrSpace space
) {
type(type);
next(next);
viewConfigurationType(viewConfigurationType);
displayTime(displayTime);
space(space);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrViewLocateInfo set(XrViewLocateInfo src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrViewLocateInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrViewLocateInfo malloc() {
return new XrViewLocateInfo(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrViewLocateInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrViewLocateInfo calloc() {
return new XrViewLocateInfo(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrViewLocateInfo} instance allocated with {@link BufferUtils}. */
public static XrViewLocateInfo create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrViewLocateInfo(memAddress(container), container);
}
/** Returns a new {@code XrViewLocateInfo} instance for the specified memory address. */
public static XrViewLocateInfo create(long address) {
return new XrViewLocateInfo(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrViewLocateInfo createSafe(long address) {
return address == NULL ? null : new XrViewLocateInfo(address, null);
}
/**
* Returns a new {@link XrViewLocateInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrViewLocateInfo.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrViewLocateInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrViewLocateInfo.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrViewLocateInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrViewLocateInfo.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrViewLocateInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrViewLocateInfo.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 XrViewLocateInfo.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrViewLocateInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrViewLocateInfo malloc(MemoryStack stack) {
return new XrViewLocateInfo(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrViewLocateInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrViewLocateInfo calloc(MemoryStack stack) {
return new XrViewLocateInfo(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrViewLocateInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrViewLocateInfo.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrViewLocateInfo.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 XrViewLocateInfo.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 + XrViewLocateInfo.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrViewLocateInfo.NEXT); }
/** Unsafe version of {@link #viewConfigurationType}. */
public static int nviewConfigurationType(long struct) { return memGetInt(struct + XrViewLocateInfo.VIEWCONFIGURATIONTYPE); }
/** Unsafe version of {@link #displayTime}. */
public static long ndisplayTime(long struct) { return memGetLong(struct + XrViewLocateInfo.DISPLAYTIME); }
/** Unsafe version of {@link #space}. */
public static long nspace(long struct) { return memGetAddress(struct + XrViewLocateInfo.SPACE); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrViewLocateInfo.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrViewLocateInfo.NEXT, value); }
/** Unsafe version of {@link #viewConfigurationType(int) viewConfigurationType}. */
public static void nviewConfigurationType(long struct, int value) { memPutInt(struct + XrViewLocateInfo.VIEWCONFIGURATIONTYPE, value); }
/** Unsafe version of {@link #displayTime(long) displayTime}. */
public static void ndisplayTime(long struct, long value) { memPutLong(struct + XrViewLocateInfo.DISPLAYTIME, value); }
/** Unsafe version of {@link #space(XrSpace) space}. */
public static void nspace(long struct, XrSpace value) { memPutAddress(struct + XrViewLocateInfo.SPACE, value.address()); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + XrViewLocateInfo.SPACE));
}
// -----------------------------------
/** An array of {@link XrViewLocateInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrViewLocateInfo ELEMENT_FACTORY = XrViewLocateInfo.create(-1L);
/**
* Creates a new {@code XrViewLocateInfo.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 XrViewLocateInfo#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 XrViewLocateInfo getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrViewLocateInfo#type} field. */
@NativeType("XrStructureType")
public int type() { return XrViewLocateInfo.ntype(address()); }
/** @return the value of the {@link XrViewLocateInfo#next} field. */
@NativeType("void const *")
public long next() { return XrViewLocateInfo.nnext(address()); }
/** @return the value of the {@link XrViewLocateInfo#viewConfigurationType} field. */
@NativeType("XrViewConfigurationType")
public int viewConfigurationType() { return XrViewLocateInfo.nviewConfigurationType(address()); }
/** @return the value of the {@link XrViewLocateInfo#displayTime} field. */
@NativeType("XrTime")
public long displayTime() { return XrViewLocateInfo.ndisplayTime(address()); }
/** @return the value of the {@link XrViewLocateInfo#space} field. */
@NativeType("XrSpace")
public long space() { return XrViewLocateInfo.nspace(address()); }
/** Sets the specified value to the {@link XrViewLocateInfo#type} field. */
public XrViewLocateInfo.Buffer type(@NativeType("XrStructureType") int value) { XrViewLocateInfo.ntype(address(), value); return this; }
/** Sets the {@link XR10#XR_TYPE_VIEW_LOCATE_INFO TYPE_VIEW_LOCATE_INFO} value to the {@link XrViewLocateInfo#type} field. */
public XrViewLocateInfo.Buffer type$Default() { return type(XR10.XR_TYPE_VIEW_LOCATE_INFO); }
/** Sets the specified value to the {@link XrViewLocateInfo#next} field. */
public XrViewLocateInfo.Buffer next(@NativeType("void const *") long value) { XrViewLocateInfo.nnext(address(), value); return this; }
/** Prepends the specified {@link XrViewLocateFoveatedRenderingVARJO} value to the {@code next} chain. */
public XrViewLocateInfo.Buffer next(XrViewLocateFoveatedRenderingVARJO value) { return this.next(value.next(this.next()).address()); }
/** Sets the specified value to the {@link XrViewLocateInfo#viewConfigurationType} field. */
public XrViewLocateInfo.Buffer viewConfigurationType(@NativeType("XrViewConfigurationType") int value) { XrViewLocateInfo.nviewConfigurationType(address(), value); return this; }
/** Sets the specified value to the {@link XrViewLocateInfo#displayTime} field. */
public XrViewLocateInfo.Buffer displayTime(@NativeType("XrTime") long value) { XrViewLocateInfo.ndisplayTime(address(), value); return this; }
/** Sets the specified value to the {@link XrViewLocateInfo#space} field. */
public XrViewLocateInfo.Buffer space(XrSpace value) { XrViewLocateInfo.nspace(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy