org.lwjgl.openxr.XrBaseInStructure 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.*;
/**
* Convenience type for iterating (read only).
*
* Description
*
* {@link XrBaseInStructure} can be used to facilitate iterating through a read-only structure pointer chain.
*
* See Also
*
* {@link XrBaseInStructure}, {@link XrBaseOutStructure}
*
* Layout
*
*
* struct XrBaseInStructure {
* XrStructureType {@link #type};
* {@link XrBaseInStructure XrBaseInStructure} const * {@link #next};
* }
*/
public class XrBaseInStructure 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;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
}
protected XrBaseInStructure(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrBaseInStructure create(long address, @Nullable ByteBuffer container) {
return new XrBaseInStructure(address, container);
}
/**
* Creates a {@code XrBaseInStructure} 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 XrBaseInStructure(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** the {@code XrStructureType} of this structure. This base structure itself has no associated {@code XrStructureType} value. */
@NativeType("XrStructureType")
public int type() { return ntype(address()); }
/** {@code NULL} or a pointer to the next structure in a structure chain. */
@NativeType("XrBaseInStructure const *")
public XrBaseInStructure next() { return nnext(address()); }
/** Sets the specified value to the {@link #type} field. */
public XrBaseInStructure type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the address of the specified {@link XrBaseInStructure} to the {@link #next} field. */
public XrBaseInStructure next(@NativeType("XrBaseInStructure const *") XrBaseInStructure value) { nnext(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrBaseInStructure set(
int type,
XrBaseInStructure next
) {
type(type);
next(next);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrBaseInStructure set(XrBaseInStructure src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrBaseInStructure} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrBaseInStructure malloc() {
return new XrBaseInStructure(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrBaseInStructure} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrBaseInStructure calloc() {
return new XrBaseInStructure(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrBaseInStructure} instance allocated with {@link BufferUtils}. */
public static XrBaseInStructure create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrBaseInStructure(memAddress(container), container);
}
/** Returns a new {@code XrBaseInStructure} instance for the specified memory address. */
public static XrBaseInStructure create(long address) {
return new XrBaseInStructure(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrBaseInStructure createSafe(long address) {
return address == NULL ? null : new XrBaseInStructure(address, null);
}
/**
* Returns a new {@link XrBaseInStructure.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrBaseInStructure.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrBaseInStructure.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrBaseInStructure.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrBaseInStructure.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrBaseInStructure.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrBaseInStructure.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrBaseInStructure.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 XrBaseInStructure.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrBaseInStructure} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrBaseInStructure malloc(MemoryStack stack) {
return new XrBaseInStructure(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrBaseInStructure} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrBaseInStructure calloc(MemoryStack stack) {
return new XrBaseInStructure(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrBaseInStructure.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrBaseInStructure.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrBaseInStructure.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 XrBaseInStructure.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 + XrBaseInStructure.TYPE); }
/** Unsafe version of {@link #next}. */
public static XrBaseInStructure nnext(long struct) { return XrBaseInStructure.create(memGetAddress(struct + XrBaseInStructure.NEXT)); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrBaseInStructure.TYPE, value); }
/** Unsafe version of {@link #next(XrBaseInStructure) next}. */
public static void nnext(long struct, XrBaseInStructure value) { memPutAddress(struct + XrBaseInStructure.NEXT, 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 + XrBaseInStructure.NEXT));
}
// -----------------------------------
/** An array of {@link XrBaseInStructure} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrBaseInStructure ELEMENT_FACTORY = XrBaseInStructure.create(-1L);
/**
* Creates a new {@code XrBaseInStructure.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 XrBaseInStructure#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 XrBaseInStructure getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrBaseInStructure#type} field. */
@NativeType("XrStructureType")
public int type() { return XrBaseInStructure.ntype(address()); }
/** @return a {@link XrBaseInStructure} view of the struct pointed to by the {@link XrBaseInStructure#next} field. */
@NativeType("XrBaseInStructure const *")
public XrBaseInStructure next() { return XrBaseInStructure.nnext(address()); }
/** Sets the specified value to the {@link XrBaseInStructure#type} field. */
public XrBaseInStructure.Buffer type(@NativeType("XrStructureType") int value) { XrBaseInStructure.ntype(address(), value); return this; }
/** Sets the address of the specified {@link XrBaseInStructure} to the {@link XrBaseInStructure#next} field. */
public XrBaseInStructure.Buffer next(@NativeType("XrBaseInStructure const *") XrBaseInStructure value) { XrBaseInStructure.nnext(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy