org.lwjgl.openxr.XrViewConfigurationProperties 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.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Detailed configuration properties for an XrViewConfigurationProperties.
*
* Valid Usage (Implicit)
*
*
* - {@code type} must be {@link XR10#XR_TYPE_VIEW_CONFIGURATION_PROPERTIES TYPE_VIEW_CONFIGURATION_PROPERTIES}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
* - {@code viewConfigurationType} must be a valid {@code XrViewConfigurationType} value
*
*
* See Also
*
* {@link XrViewConfigurationView}, {@link XR10#xrGetViewConfigurationProperties GetViewConfigurationProperties}
*
* Layout
*
*
* struct XrViewConfigurationProperties {
* XrStructureType {@link #type};
* void * {@link #next};
* XrViewConfigurationType {@link #viewConfigurationType};
* XrBool32 {@link #fovMutable};
* }
*/
public class XrViewConfigurationProperties 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,
FOVMUTABLE;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
VIEWCONFIGURATIONTYPE = layout.offsetof(2);
FOVMUTABLE = layout.offsetof(3);
}
protected XrViewConfigurationProperties(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrViewConfigurationProperties create(long address, @Nullable ByteBuffer container) {
return new XrViewConfigurationProperties(address, container);
}
/**
* Creates a {@code XrViewConfigurationProperties} 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 XrViewConfigurationProperties(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 *")
public long next() { return nnext(address()); }
/** the {@code XrViewConfigurationType} of the configuration. */
@NativeType("XrViewConfigurationType")
public int viewConfigurationType() { return nviewConfigurationType(address()); }
/** indicates if the view field of view can be modified by the application. */
@NativeType("XrBool32")
public boolean fovMutable() { return nfovMutable(address()) != 0; }
/** Sets the specified value to the {@link #type} field. */
public XrViewConfigurationProperties type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link XR10#XR_TYPE_VIEW_CONFIGURATION_PROPERTIES TYPE_VIEW_CONFIGURATION_PROPERTIES} value to the {@link #type} field. */
public XrViewConfigurationProperties type$Default() { return type(XR10.XR_TYPE_VIEW_CONFIGURATION_PROPERTIES); }
/** Sets the specified value to the {@link #next} field. */
public XrViewConfigurationProperties next(@NativeType("void *") long value) { nnext(address(), value); return this; }
/** Sets the specified value to the {@link #viewConfigurationType} field. */
public XrViewConfigurationProperties viewConfigurationType(@NativeType("XrViewConfigurationType") int value) { nviewConfigurationType(address(), value); return this; }
/** Sets the specified value to the {@link #fovMutable} field. */
public XrViewConfigurationProperties fovMutable(@NativeType("XrBool32") boolean value) { nfovMutable(address(), value ? 1 : 0); return this; }
/** Initializes this struct with the specified values. */
public XrViewConfigurationProperties set(
int type,
long next,
int viewConfigurationType,
boolean fovMutable
) {
type(type);
next(next);
viewConfigurationType(viewConfigurationType);
fovMutable(fovMutable);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrViewConfigurationProperties set(XrViewConfigurationProperties src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrViewConfigurationProperties} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrViewConfigurationProperties malloc() {
return new XrViewConfigurationProperties(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrViewConfigurationProperties} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrViewConfigurationProperties calloc() {
return new XrViewConfigurationProperties(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrViewConfigurationProperties} instance allocated with {@link BufferUtils}. */
public static XrViewConfigurationProperties create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrViewConfigurationProperties(memAddress(container), container);
}
/** Returns a new {@code XrViewConfigurationProperties} instance for the specified memory address. */
public static XrViewConfigurationProperties create(long address) {
return new XrViewConfigurationProperties(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrViewConfigurationProperties createSafe(long address) {
return address == NULL ? null : new XrViewConfigurationProperties(address, null);
}
/**
* Returns a new {@link XrViewConfigurationProperties.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrViewConfigurationProperties.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrViewConfigurationProperties.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrViewConfigurationProperties.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrViewConfigurationProperties.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrViewConfigurationProperties.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrViewConfigurationProperties.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrViewConfigurationProperties.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 XrViewConfigurationProperties.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrViewConfigurationProperties} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrViewConfigurationProperties malloc(MemoryStack stack) {
return new XrViewConfigurationProperties(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrViewConfigurationProperties} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrViewConfigurationProperties calloc(MemoryStack stack) {
return new XrViewConfigurationProperties(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrViewConfigurationProperties.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrViewConfigurationProperties.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrViewConfigurationProperties.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 XrViewConfigurationProperties.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 + XrViewConfigurationProperties.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrViewConfigurationProperties.NEXT); }
/** Unsafe version of {@link #viewConfigurationType}. */
public static int nviewConfigurationType(long struct) { return memGetInt(struct + XrViewConfigurationProperties.VIEWCONFIGURATIONTYPE); }
/** Unsafe version of {@link #fovMutable}. */
public static int nfovMutable(long struct) { return memGetInt(struct + XrViewConfigurationProperties.FOVMUTABLE); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrViewConfigurationProperties.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrViewConfigurationProperties.NEXT, value); }
/** Unsafe version of {@link #viewConfigurationType(int) viewConfigurationType}. */
public static void nviewConfigurationType(long struct, int value) { memPutInt(struct + XrViewConfigurationProperties.VIEWCONFIGURATIONTYPE, value); }
/** Unsafe version of {@link #fovMutable(boolean) fovMutable}. */
public static void nfovMutable(long struct, int value) { memPutInt(struct + XrViewConfigurationProperties.FOVMUTABLE, value); }
// -----------------------------------
/** An array of {@link XrViewConfigurationProperties} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrViewConfigurationProperties ELEMENT_FACTORY = XrViewConfigurationProperties.create(-1L);
/**
* Creates a new {@code XrViewConfigurationProperties.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 XrViewConfigurationProperties#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 XrViewConfigurationProperties getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrViewConfigurationProperties#type} field. */
@NativeType("XrStructureType")
public int type() { return XrViewConfigurationProperties.ntype(address()); }
/** @return the value of the {@link XrViewConfigurationProperties#next} field. */
@NativeType("void *")
public long next() { return XrViewConfigurationProperties.nnext(address()); }
/** @return the value of the {@link XrViewConfigurationProperties#viewConfigurationType} field. */
@NativeType("XrViewConfigurationType")
public int viewConfigurationType() { return XrViewConfigurationProperties.nviewConfigurationType(address()); }
/** @return the value of the {@link XrViewConfigurationProperties#fovMutable} field. */
@NativeType("XrBool32")
public boolean fovMutable() { return XrViewConfigurationProperties.nfovMutable(address()) != 0; }
/** Sets the specified value to the {@link XrViewConfigurationProperties#type} field. */
public XrViewConfigurationProperties.Buffer type(@NativeType("XrStructureType") int value) { XrViewConfigurationProperties.ntype(address(), value); return this; }
/** Sets the {@link XR10#XR_TYPE_VIEW_CONFIGURATION_PROPERTIES TYPE_VIEW_CONFIGURATION_PROPERTIES} value to the {@link XrViewConfigurationProperties#type} field. */
public XrViewConfigurationProperties.Buffer type$Default() { return type(XR10.XR_TYPE_VIEW_CONFIGURATION_PROPERTIES); }
/** Sets the specified value to the {@link XrViewConfigurationProperties#next} field. */
public XrViewConfigurationProperties.Buffer next(@NativeType("void *") long value) { XrViewConfigurationProperties.nnext(address(), value); return this; }
/** Sets the specified value to the {@link XrViewConfigurationProperties#viewConfigurationType} field. */
public XrViewConfigurationProperties.Buffer viewConfigurationType(@NativeType("XrViewConfigurationType") int value) { XrViewConfigurationProperties.nviewConfigurationType(address(), value); return this; }
/** Sets the specified value to the {@link XrViewConfigurationProperties#fovMutable} field. */
public XrViewConfigurationProperties.Buffer fovMutable(@NativeType("XrBool32") boolean value) { XrViewConfigurationProperties.nfovMutable(address(), value ? 1 : 0); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy