org.lwjgl.openxr.XrExtensionProperties 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.*;
import static org.lwjgl.openxr.XR10.*;
/**
* Returns properties of available instance extensions.
*
* Valid Usage (Implicit)
*
*
* - {@code type} must be {@link XR10#XR_TYPE_EXTENSION_PROPERTIES TYPE_EXTENSION_PROPERTIES}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
*
*
* See Also
*
* {@link XR10#xrEnumerateInstanceExtensionProperties EnumerateInstanceExtensionProperties}
*
* Layout
*
*
* struct XrExtensionProperties {
* XrStructureType {@link #type};
* void * {@link #next};
* char {@link #extensionName}[XR_MAX_EXTENSION_NAME_SIZE];
* uint32_t {@link #extensionVersion};
* }
*/
public class XrExtensionProperties 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,
EXTENSIONNAME,
EXTENSIONVERSION;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__array(1, XR_MAX_EXTENSION_NAME_SIZE),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
EXTENSIONNAME = layout.offsetof(2);
EXTENSIONVERSION = layout.offsetof(3);
}
protected XrExtensionProperties(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrExtensionProperties create(long address, @Nullable ByteBuffer container) {
return new XrExtensionProperties(address, container);
}
/**
* Creates a {@code XrExtensionProperties} 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 XrExtensionProperties(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()); }
/** a {@code NULL} terminated string specifying the name of the extension. */
@NativeType("char[XR_MAX_EXTENSION_NAME_SIZE]")
public ByteBuffer extensionName() { return nextensionName(address()); }
/** a {@code NULL} terminated string specifying the name of the extension. */
@NativeType("char[XR_MAX_EXTENSION_NAME_SIZE]")
public String extensionNameString() { return nextensionNameString(address()); }
/** the version of this extension. It is an integer, incremented with backward compatible changes. */
@NativeType("uint32_t")
public int extensionVersion() { return nextensionVersion(address()); }
/** Sets the specified value to the {@link #type} field. */
public XrExtensionProperties type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link XR10#XR_TYPE_EXTENSION_PROPERTIES TYPE_EXTENSION_PROPERTIES} value to the {@link #type} field. */
public XrExtensionProperties type$Default() { return type(XR10.XR_TYPE_EXTENSION_PROPERTIES); }
/** Sets the specified value to the {@link #next} field. */
public XrExtensionProperties next(@NativeType("void *") long value) { nnext(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrExtensionProperties 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 XrExtensionProperties set(XrExtensionProperties src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrExtensionProperties} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrExtensionProperties malloc() {
return new XrExtensionProperties(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrExtensionProperties} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrExtensionProperties calloc() {
return new XrExtensionProperties(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrExtensionProperties} instance allocated with {@link BufferUtils}. */
public static XrExtensionProperties create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrExtensionProperties(memAddress(container), container);
}
/** Returns a new {@code XrExtensionProperties} instance for the specified memory address. */
public static XrExtensionProperties create(long address) {
return new XrExtensionProperties(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrExtensionProperties createSafe(long address) {
return address == NULL ? null : new XrExtensionProperties(address, null);
}
/**
* Returns a new {@link XrExtensionProperties.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrExtensionProperties.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrExtensionProperties.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrExtensionProperties.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrExtensionProperties.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrExtensionProperties.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrExtensionProperties.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrExtensionProperties.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 XrExtensionProperties.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrExtensionProperties} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrExtensionProperties malloc(MemoryStack stack) {
return new XrExtensionProperties(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrExtensionProperties} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrExtensionProperties calloc(MemoryStack stack) {
return new XrExtensionProperties(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrExtensionProperties.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrExtensionProperties.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrExtensionProperties.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 XrExtensionProperties.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 + XrExtensionProperties.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrExtensionProperties.NEXT); }
/** Unsafe version of {@link #extensionName}. */
public static ByteBuffer nextensionName(long struct) { return memByteBuffer(struct + XrExtensionProperties.EXTENSIONNAME, XR_MAX_EXTENSION_NAME_SIZE); }
/** Unsafe version of {@link #extensionNameString}. */
public static String nextensionNameString(long struct) { return memUTF8(struct + XrExtensionProperties.EXTENSIONNAME); }
/** Unsafe version of {@link #extensionVersion}. */
public static int nextensionVersion(long struct) { return memGetInt(struct + XrExtensionProperties.EXTENSIONVERSION); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrExtensionProperties.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrExtensionProperties.NEXT, value); }
// -----------------------------------
/** An array of {@link XrExtensionProperties} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrExtensionProperties ELEMENT_FACTORY = XrExtensionProperties.create(-1L);
/**
* Creates a new {@code XrExtensionProperties.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 XrExtensionProperties#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 XrExtensionProperties getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrExtensionProperties#type} field. */
@NativeType("XrStructureType")
public int type() { return XrExtensionProperties.ntype(address()); }
/** @return the value of the {@link XrExtensionProperties#next} field. */
@NativeType("void *")
public long next() { return XrExtensionProperties.nnext(address()); }
/** @return a {@link ByteBuffer} view of the {@link XrExtensionProperties#extensionName} field. */
@NativeType("char[XR_MAX_EXTENSION_NAME_SIZE]")
public ByteBuffer extensionName() { return XrExtensionProperties.nextensionName(address()); }
/** @return the null-terminated string stored in the {@link XrExtensionProperties#extensionName} field. */
@NativeType("char[XR_MAX_EXTENSION_NAME_SIZE]")
public String extensionNameString() { return XrExtensionProperties.nextensionNameString(address()); }
/** @return the value of the {@link XrExtensionProperties#extensionVersion} field. */
@NativeType("uint32_t")
public int extensionVersion() { return XrExtensionProperties.nextensionVersion(address()); }
/** Sets the specified value to the {@link XrExtensionProperties#type} field. */
public XrExtensionProperties.Buffer type(@NativeType("XrStructureType") int value) { XrExtensionProperties.ntype(address(), value); return this; }
/** Sets the {@link XR10#XR_TYPE_EXTENSION_PROPERTIES TYPE_EXTENSION_PROPERTIES} value to the {@link XrExtensionProperties#type} field. */
public XrExtensionProperties.Buffer type$Default() { return type(XR10.XR_TYPE_EXTENSION_PROPERTIES); }
/** Sets the specified value to the {@link XrExtensionProperties#next} field. */
public XrExtensionProperties.Buffer next(@NativeType("void *") long value) { XrExtensionProperties.nnext(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy