org.lwjgl.openxr.XrEventDataColocationDiscoveryResultMETA 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.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
import static org.lwjgl.openxr.METAColocationDiscovery.*;
/**
* Colocation discovery result.
*
* Description
*
* {@code advertisementUuid} and {@code buffer} are both considered the payload of colocated advertisements. The value of {@code advertisementUuid} matches the value returned in {@link XrEventDataStartColocationAdvertisementCompleteMETA}{@code ::advertisementUuid} on the advertising device.
*
* Valid Usage (Implicit)
*
*
* - The {@link METAColocationDiscovery XR_META_colocation_discovery} extension must be enabled prior to using {@link XrEventDataColocationDiscoveryResultMETA}
* - {@code type} must be {@link METAColocationDiscovery#XR_TYPE_EVENT_DATA_COLOCATION_DISCOVERY_RESULT_META TYPE_EVENT_DATA_COLOCATION_DISCOVERY_RESULT_META}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
* - Any given element of {@code buffer} must be a pointer to an array of {@code bufferSize} {@code uint8_t} values
* - The {@code bufferSize} parameter must be greater than 0
*
*
* See Also
*
* {@link XrUuid}, {@link METAColocationDiscovery#xrStartColocationDiscoveryMETA StartColocationDiscoveryMETA}
*
* Layout
*
*
* struct XrEventDataColocationDiscoveryResultMETA {
* XrStructureType {@link #type};
* void const * {@link #next};
* XrAsyncRequestIdFB {@link #discoveryRequestId};
* {@link XrUuid XrUuid} {@link #advertisementUuid};
* uint32_t {@link #bufferSize};
* uint8_t {@link #buffer}[XR_MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META];
* }
*/
public class XrEventDataColocationDiscoveryResultMETA 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,
DISCOVERYREQUESTID,
ADVERTISEMENTUUID,
BUFFERSIZE,
BUFFER;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(8),
__member(XrUuid.SIZEOF, XrUuid.ALIGNOF),
__member(4),
__array(1, XR_MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
DISCOVERYREQUESTID = layout.offsetof(2);
ADVERTISEMENTUUID = layout.offsetof(3);
BUFFERSIZE = layout.offsetof(4);
BUFFER = layout.offsetof(5);
}
protected XrEventDataColocationDiscoveryResultMETA(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrEventDataColocationDiscoveryResultMETA create(long address, @Nullable ByteBuffer container) {
return new XrEventDataColocationDiscoveryResultMETA(address, container);
}
/**
* Creates a {@code XrEventDataColocationDiscoveryResultMETA} 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 XrEventDataColocationDiscoveryResultMETA(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()); }
/** an {@code XrAsyncRequestIdFB} specifying the original start discovery async request id. The runtime must return a value which matches a previously returned {@code discoveryRequestId} value from an {@link METAColocationDiscovery#xrStartColocationDiscoveryMETA StartColocationDiscoveryMETA} request. */
@NativeType("XrAsyncRequestIdFB")
public long discoveryRequestId() { return ndiscoveryRequestId(address()); }
/** an {@link XrUuid} of the discovered colocated application. */
public XrUuid advertisementUuid() { return nadvertisementUuid(address()); }
/** the count of bytes used in the {@code buffer} array. */
@NativeType("uint32_t")
public int bufferSize() { return nbufferSize(address()); }
/** a byte array which is the application may set when the application starts the advertisement. */
@NativeType("uint8_t[XR_MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META]")
public ByteBuffer buffer() { return nbuffer(address()); }
/** a byte array which is the application may set when the application starts the advertisement. */
@NativeType("uint8_t")
public byte buffer(int index) { return nbuffer(address(), index); }
/** Sets the specified value to the {@link #type} field. */
public XrEventDataColocationDiscoveryResultMETA type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link METAColocationDiscovery#XR_TYPE_EVENT_DATA_COLOCATION_DISCOVERY_RESULT_META TYPE_EVENT_DATA_COLOCATION_DISCOVERY_RESULT_META} value to the {@link #type} field. */
public XrEventDataColocationDiscoveryResultMETA type$Default() { return type(METAColocationDiscovery.XR_TYPE_EVENT_DATA_COLOCATION_DISCOVERY_RESULT_META); }
/** Sets the specified value to the {@link #next} field. */
public XrEventDataColocationDiscoveryResultMETA next(@NativeType("void const *") long value) { nnext(address(), value); return this; }
/** Sets the specified value to the {@link #discoveryRequestId} field. */
public XrEventDataColocationDiscoveryResultMETA discoveryRequestId(@NativeType("XrAsyncRequestIdFB") long value) { ndiscoveryRequestId(address(), value); return this; }
/** Copies the specified {@link XrUuid} to the {@link #advertisementUuid} field. */
public XrEventDataColocationDiscoveryResultMETA advertisementUuid(XrUuid value) { nadvertisementUuid(address(), value); return this; }
/** Passes the {@link #advertisementUuid} field to the specified {@link java.util.function.Consumer Consumer}. */
public XrEventDataColocationDiscoveryResultMETA advertisementUuid(java.util.function.Consumer consumer) { consumer.accept(advertisementUuid()); return this; }
/** Copies the specified {@link ByteBuffer} to the {@link #buffer} field. */
public XrEventDataColocationDiscoveryResultMETA buffer(@NativeType("uint8_t[XR_MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META]") ByteBuffer value) { nbuffer(address(), value); return this; }
/** Sets the specified value at the specified index of the {@link #buffer} field. */
public XrEventDataColocationDiscoveryResultMETA buffer(int index, @NativeType("uint8_t") byte value) { nbuffer(address(), index, value); return this; }
/** Initializes this struct with the specified values. */
public XrEventDataColocationDiscoveryResultMETA set(
int type,
long next,
long discoveryRequestId,
XrUuid advertisementUuid,
ByteBuffer buffer
) {
type(type);
next(next);
discoveryRequestId(discoveryRequestId);
advertisementUuid(advertisementUuid);
buffer(buffer);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrEventDataColocationDiscoveryResultMETA set(XrEventDataColocationDiscoveryResultMETA src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrEventDataColocationDiscoveryResultMETA} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrEventDataColocationDiscoveryResultMETA malloc() {
return new XrEventDataColocationDiscoveryResultMETA(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrEventDataColocationDiscoveryResultMETA} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrEventDataColocationDiscoveryResultMETA calloc() {
return new XrEventDataColocationDiscoveryResultMETA(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrEventDataColocationDiscoveryResultMETA} instance allocated with {@link BufferUtils}. */
public static XrEventDataColocationDiscoveryResultMETA create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrEventDataColocationDiscoveryResultMETA(memAddress(container), container);
}
/** Returns a new {@code XrEventDataColocationDiscoveryResultMETA} instance for the specified memory address. */
public static XrEventDataColocationDiscoveryResultMETA create(long address) {
return new XrEventDataColocationDiscoveryResultMETA(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrEventDataColocationDiscoveryResultMETA createSafe(long address) {
return address == NULL ? null : new XrEventDataColocationDiscoveryResultMETA(address, null);
}
/**
* Returns a new {@link XrEventDataColocationDiscoveryResultMETA.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrEventDataColocationDiscoveryResultMETA.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrEventDataColocationDiscoveryResultMETA.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrEventDataColocationDiscoveryResultMETA.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrEventDataColocationDiscoveryResultMETA.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrEventDataColocationDiscoveryResultMETA.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrEventDataColocationDiscoveryResultMETA.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrEventDataColocationDiscoveryResultMETA.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 XrEventDataColocationDiscoveryResultMETA.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code XrEventDataColocationDiscoveryResultMETA} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrEventDataColocationDiscoveryResultMETA malloc(MemoryStack stack) {
return new XrEventDataColocationDiscoveryResultMETA(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrEventDataColocationDiscoveryResultMETA} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrEventDataColocationDiscoveryResultMETA calloc(MemoryStack stack) {
return new XrEventDataColocationDiscoveryResultMETA(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrEventDataColocationDiscoveryResultMETA.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrEventDataColocationDiscoveryResultMETA.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrEventDataColocationDiscoveryResultMETA.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 XrEventDataColocationDiscoveryResultMETA.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 + XrEventDataColocationDiscoveryResultMETA.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrEventDataColocationDiscoveryResultMETA.NEXT); }
/** Unsafe version of {@link #discoveryRequestId}. */
public static long ndiscoveryRequestId(long struct) { return memGetLong(struct + XrEventDataColocationDiscoveryResultMETA.DISCOVERYREQUESTID); }
/** Unsafe version of {@link #advertisementUuid}. */
public static XrUuid nadvertisementUuid(long struct) { return XrUuid.create(struct + XrEventDataColocationDiscoveryResultMETA.ADVERTISEMENTUUID); }
/** Unsafe version of {@link #bufferSize}. */
public static int nbufferSize(long struct) { return memGetInt(struct + XrEventDataColocationDiscoveryResultMETA.BUFFERSIZE); }
/** Unsafe version of {@link #buffer}. */
public static ByteBuffer nbuffer(long struct) { return memByteBuffer(struct + XrEventDataColocationDiscoveryResultMETA.BUFFER, nbufferSize(struct)); }
/** Unsafe version of {@link #buffer(int) buffer}. */
public static byte nbuffer(long struct, int index) {
return memGetByte(struct + XrEventDataColocationDiscoveryResultMETA.BUFFER + check(index, XR_MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META) * 1);
}
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrEventDataColocationDiscoveryResultMETA.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrEventDataColocationDiscoveryResultMETA.NEXT, value); }
/** Unsafe version of {@link #discoveryRequestId(long) discoveryRequestId}. */
public static void ndiscoveryRequestId(long struct, long value) { memPutLong(struct + XrEventDataColocationDiscoveryResultMETA.DISCOVERYREQUESTID, value); }
/** Unsafe version of {@link #advertisementUuid(XrUuid) advertisementUuid}. */
public static void nadvertisementUuid(long struct, XrUuid value) { memCopy(value.address(), struct + XrEventDataColocationDiscoveryResultMETA.ADVERTISEMENTUUID, XrUuid.SIZEOF); }
/** Sets the specified value to the {@code bufferSize} field of the specified {@code struct}. */
public static void nbufferSize(long struct, int value) { memPutInt(struct + XrEventDataColocationDiscoveryResultMETA.BUFFERSIZE, value); }
/** Unsafe version of {@link #buffer(ByteBuffer) buffer}. */
public static void nbuffer(long struct, ByteBuffer value) {
if (CHECKS) { checkGT(value, XR_MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META); }
memCopy(memAddress(value), struct + XrEventDataColocationDiscoveryResultMETA.BUFFER, value.remaining() * 1);
nbufferSize(struct, value.remaining());
}
/** Unsafe version of {@link #buffer(int, byte) buffer}. */
public static void nbuffer(long struct, int index, byte value) {
memPutByte(struct + XrEventDataColocationDiscoveryResultMETA.BUFFER + check(index, XR_MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META) * 1, value);
}
// -----------------------------------
/** An array of {@link XrEventDataColocationDiscoveryResultMETA} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrEventDataColocationDiscoveryResultMETA ELEMENT_FACTORY = XrEventDataColocationDiscoveryResultMETA.create(-1L);
/**
* Creates a new {@code XrEventDataColocationDiscoveryResultMETA.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 XrEventDataColocationDiscoveryResultMETA#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 XrEventDataColocationDiscoveryResultMETA getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrEventDataColocationDiscoveryResultMETA#type} field. */
@NativeType("XrStructureType")
public int type() { return XrEventDataColocationDiscoveryResultMETA.ntype(address()); }
/** @return the value of the {@link XrEventDataColocationDiscoveryResultMETA#next} field. */
@NativeType("void const *")
public long next() { return XrEventDataColocationDiscoveryResultMETA.nnext(address()); }
/** @return the value of the {@link XrEventDataColocationDiscoveryResultMETA#discoveryRequestId} field. */
@NativeType("XrAsyncRequestIdFB")
public long discoveryRequestId() { return XrEventDataColocationDiscoveryResultMETA.ndiscoveryRequestId(address()); }
/** @return a {@link XrUuid} view of the {@link XrEventDataColocationDiscoveryResultMETA#advertisementUuid} field. */
public XrUuid advertisementUuid() { return XrEventDataColocationDiscoveryResultMETA.nadvertisementUuid(address()); }
/** @return the value of the {@link XrEventDataColocationDiscoveryResultMETA#bufferSize} field. */
@NativeType("uint32_t")
public int bufferSize() { return XrEventDataColocationDiscoveryResultMETA.nbufferSize(address()); }
/** @return a {@link ByteBuffer} view of the {@link XrEventDataColocationDiscoveryResultMETA#buffer} field. */
@NativeType("uint8_t[XR_MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META]")
public ByteBuffer buffer() { return XrEventDataColocationDiscoveryResultMETA.nbuffer(address()); }
/** @return the value at the specified index of the {@link XrEventDataColocationDiscoveryResultMETA#buffer} field. */
@NativeType("uint8_t")
public byte buffer(int index) { return XrEventDataColocationDiscoveryResultMETA.nbuffer(address(), index); }
/** Sets the specified value to the {@link XrEventDataColocationDiscoveryResultMETA#type} field. */
public XrEventDataColocationDiscoveryResultMETA.Buffer type(@NativeType("XrStructureType") int value) { XrEventDataColocationDiscoveryResultMETA.ntype(address(), value); return this; }
/** Sets the {@link METAColocationDiscovery#XR_TYPE_EVENT_DATA_COLOCATION_DISCOVERY_RESULT_META TYPE_EVENT_DATA_COLOCATION_DISCOVERY_RESULT_META} value to the {@link XrEventDataColocationDiscoveryResultMETA#type} field. */
public XrEventDataColocationDiscoveryResultMETA.Buffer type$Default() { return type(METAColocationDiscovery.XR_TYPE_EVENT_DATA_COLOCATION_DISCOVERY_RESULT_META); }
/** Sets the specified value to the {@link XrEventDataColocationDiscoveryResultMETA#next} field. */
public XrEventDataColocationDiscoveryResultMETA.Buffer next(@NativeType("void const *") long value) { XrEventDataColocationDiscoveryResultMETA.nnext(address(), value); return this; }
/** Sets the specified value to the {@link XrEventDataColocationDiscoveryResultMETA#discoveryRequestId} field. */
public XrEventDataColocationDiscoveryResultMETA.Buffer discoveryRequestId(@NativeType("XrAsyncRequestIdFB") long value) { XrEventDataColocationDiscoveryResultMETA.ndiscoveryRequestId(address(), value); return this; }
/** Copies the specified {@link XrUuid} to the {@link XrEventDataColocationDiscoveryResultMETA#advertisementUuid} field. */
public XrEventDataColocationDiscoveryResultMETA.Buffer advertisementUuid(XrUuid value) { XrEventDataColocationDiscoveryResultMETA.nadvertisementUuid(address(), value); return this; }
/** Passes the {@link XrEventDataColocationDiscoveryResultMETA#advertisementUuid} field to the specified {@link java.util.function.Consumer Consumer}. */
public XrEventDataColocationDiscoveryResultMETA.Buffer advertisementUuid(java.util.function.Consumer consumer) { consumer.accept(advertisementUuid()); return this; }
/** Copies the specified {@link ByteBuffer} to the {@link XrEventDataColocationDiscoveryResultMETA#buffer} field. */
public XrEventDataColocationDiscoveryResultMETA.Buffer buffer(@NativeType("uint8_t[XR_MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META]") ByteBuffer value) { XrEventDataColocationDiscoveryResultMETA.nbuffer(address(), value); return this; }
/** Sets the specified value at the specified index of the {@link XrEventDataColocationDiscoveryResultMETA#buffer} field. */
public XrEventDataColocationDiscoveryResultMETA.Buffer buffer(int index, @NativeType("uint8_t") byte value) { XrEventDataColocationDiscoveryResultMETA.nbuffer(address(), index, value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy