org.lwjgl.openxr.XrEventDataMarkerTrackingUpdateVARJO 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
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.
The newest version!
/*
 * 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.*;

/**
 * Structure representing marker tracking information.
 * 
 * Description
 * 
 * Receiving the {@link XrEventDataMarkerTrackingUpdateVARJO} event structure indicates that the tracking information has changed. The runtime must not send more than one event per frame per marker. The runtime must send an event if the marker has changed its state (active or inactive). The runtime must send an event if it has detected pose change of the active marker.
 * 
 * Valid Usage (Implicit)
 * 
 * 
 * The {@link VARJOMarkerTracking XR_VARJO_marker_tracking} extension must be enabled prior to using {@link XrEventDataMarkerTrackingUpdateVARJO}
 * {@code type} must be {@link VARJOMarkerTracking#XR_TYPE_EVENT_DATA_MARKER_TRACKING_UPDATE_VARJO TYPE_EVENT_DATA_MARKER_TRACKING_UPDATE_VARJO}
 * {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
 * 
 * 
 * See Also
 * 
 * {@link XR10#xrPollEvent PollEvent}
 * 
 * Layout
 * 
 * 
 * struct XrEventDataMarkerTrackingUpdateVARJO {
 *     XrStructureType {@link #type};
 *     void const * {@link #next};
 *     uint64_t {@link #markerId};
 *     XrBool32 {@link #isActive};
 *     XrBool32 {@link #isPredicted};
 *     XrTime {@link #time};
 * }
 */
public class XrEventDataMarkerTrackingUpdateVARJO 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,
        MARKERID,
        ISACTIVE,
        ISPREDICTED,
        TIME;

    static {
        Layout layout = __struct(
            __member(4),
            __member(POINTER_SIZE),
            __member(8),
            __member(4),
            __member(4),
            __member(8)
        );

        SIZEOF = layout.getSize();
        ALIGNOF = layout.getAlignment();

        TYPE = layout.offsetof(0);
        NEXT = layout.offsetof(1);
        MARKERID = layout.offsetof(2);
        ISACTIVE = layout.offsetof(3);
        ISPREDICTED = layout.offsetof(4);
        TIME = layout.offsetof(5);
    }

    protected XrEventDataMarkerTrackingUpdateVARJO(long address, @Nullable ByteBuffer container) {
        super(address, container);
    }

    @Override
    protected XrEventDataMarkerTrackingUpdateVARJO create(long address, @Nullable ByteBuffer container) {
        return new XrEventDataMarkerTrackingUpdateVARJO(address, container);
    }

    /**
     * Creates a {@code XrEventDataMarkerTrackingUpdateVARJO} 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 XrEventDataMarkerTrackingUpdateVARJO(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 or this extension. */
    @NativeType("void const *")
    public long next() { return nnext(address()); }
    /** unique identifier of the marker that has been updated. */
    @NativeType("uint64_t")
    public long markerId() { return nmarkerId(address()); }
    /** the tracking state of the marker. */
    @NativeType("XrBool32")
    public boolean isActive() { return nisActive(address()) != 0; }
    /** the prediction state of the marker. */
    @NativeType("XrBool32")
    public boolean isPredicted() { return nisPredicted(address()) != 0; }
    /** the time of the marker update. */
    @NativeType("XrTime")
    public long time() { return ntime(address()); }

    /** Sets the specified value to the {@link #type} field. */
    public XrEventDataMarkerTrackingUpdateVARJO type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
    /** Sets the {@link VARJOMarkerTracking#XR_TYPE_EVENT_DATA_MARKER_TRACKING_UPDATE_VARJO TYPE_EVENT_DATA_MARKER_TRACKING_UPDATE_VARJO} value to the {@link #type} field. */
    public XrEventDataMarkerTrackingUpdateVARJO type$Default() { return type(VARJOMarkerTracking.XR_TYPE_EVENT_DATA_MARKER_TRACKING_UPDATE_VARJO); }
    /** Sets the specified value to the {@link #next} field. */
    public XrEventDataMarkerTrackingUpdateVARJO next(@NativeType("void const *") long value) { nnext(address(), value); return this; }

    /** Initializes this struct with the specified values. */
    public XrEventDataMarkerTrackingUpdateVARJO 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 XrEventDataMarkerTrackingUpdateVARJO set(XrEventDataMarkerTrackingUpdateVARJO src) {
        memCopy(src.address(), address(), SIZEOF);
        return this;
    }

    // -----------------------------------

    /** Returns a new {@code XrEventDataMarkerTrackingUpdateVARJO} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
    public static XrEventDataMarkerTrackingUpdateVARJO malloc() {
        return new XrEventDataMarkerTrackingUpdateVARJO(nmemAllocChecked(SIZEOF), null);
    }

    /** Returns a new {@code XrEventDataMarkerTrackingUpdateVARJO} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
    public static XrEventDataMarkerTrackingUpdateVARJO calloc() {
        return new XrEventDataMarkerTrackingUpdateVARJO(nmemCallocChecked(1, SIZEOF), null);
    }

    /** Returns a new {@code XrEventDataMarkerTrackingUpdateVARJO} instance allocated with {@link BufferUtils}. */
    public static XrEventDataMarkerTrackingUpdateVARJO create() {
        ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
        return new XrEventDataMarkerTrackingUpdateVARJO(memAddress(container), container);
    }

    /** Returns a new {@code XrEventDataMarkerTrackingUpdateVARJO} instance for the specified memory address. */
    public static XrEventDataMarkerTrackingUpdateVARJO create(long address) {
        return new XrEventDataMarkerTrackingUpdateVARJO(address, null);
    }

    /** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
    public static @Nullable XrEventDataMarkerTrackingUpdateVARJO createSafe(long address) {
        return address == NULL ? null : new XrEventDataMarkerTrackingUpdateVARJO(address, null);
    }

    /** Downcasts the specified {@code XrEventDataBaseHeader} instance to {@code XrEventDataMarkerTrackingUpdateVARJO}. */
    public static XrEventDataMarkerTrackingUpdateVARJO create(XrEventDataBaseHeader value) {
        return new XrEventDataMarkerTrackingUpdateVARJO(value.address(), __getContainer(value));
    }

    /**
     * Returns a new {@link XrEventDataMarkerTrackingUpdateVARJO.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
     *
     * @param capacity the buffer capacity
     */
    public static XrEventDataMarkerTrackingUpdateVARJO.Buffer malloc(int capacity) {
        return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
    }

    /**
     * Returns a new {@link XrEventDataMarkerTrackingUpdateVARJO.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
     *
     * @param capacity the buffer capacity
     */
    public static XrEventDataMarkerTrackingUpdateVARJO.Buffer calloc(int capacity) {
        return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
    }

    /**
     * Returns a new {@link XrEventDataMarkerTrackingUpdateVARJO.Buffer} instance allocated with {@link BufferUtils}.
     *
     * @param capacity the buffer capacity
     */
    public static XrEventDataMarkerTrackingUpdateVARJO.Buffer create(int capacity) {
        ByteBuffer container = __create(capacity, SIZEOF);
        return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
    }

    /**
     * Create a {@link XrEventDataMarkerTrackingUpdateVARJO.Buffer} instance at the specified memory.
     *
     * @param address  the memory address
     * @param capacity the buffer capacity
     */
    public static XrEventDataMarkerTrackingUpdateVARJO.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 XrEventDataMarkerTrackingUpdateVARJO.@Nullable Buffer createSafe(long address, int capacity) {
        return address == NULL ? null : new Buffer(address, capacity);
    }

    /** Downcasts the specified {@code XrEventDataBaseHeader.Buffer} instance to {@code XrEventDataMarkerTrackingUpdateVARJO.Buffer}. */
    public static XrEventDataMarkerTrackingUpdateVARJO.Buffer create(XrEventDataBaseHeader.Buffer value) {
        return new XrEventDataMarkerTrackingUpdateVARJO.Buffer(value.address(), __getContainer(value), -1, 0, value.remaining(), value.remaining());
    }

    /**
     * Returns a new {@code XrEventDataMarkerTrackingUpdateVARJO} instance allocated on the specified {@link MemoryStack}.
     *
     * @param stack the stack from which to allocate
     */
    public static XrEventDataMarkerTrackingUpdateVARJO malloc(MemoryStack stack) {
        return new XrEventDataMarkerTrackingUpdateVARJO(stack.nmalloc(ALIGNOF, SIZEOF), null);
    }

    /**
     * Returns a new {@code XrEventDataMarkerTrackingUpdateVARJO} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
     *
     * @param stack the stack from which to allocate
     */
    public static XrEventDataMarkerTrackingUpdateVARJO calloc(MemoryStack stack) {
        return new XrEventDataMarkerTrackingUpdateVARJO(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
    }

    /**
     * Returns a new {@link XrEventDataMarkerTrackingUpdateVARJO.Buffer} instance allocated on the specified {@link MemoryStack}.
     *
     * @param stack    the stack from which to allocate
     * @param capacity the buffer capacity
     */
    public static XrEventDataMarkerTrackingUpdateVARJO.Buffer malloc(int capacity, MemoryStack stack) {
        return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
    }

    /**
     * Returns a new {@link XrEventDataMarkerTrackingUpdateVARJO.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 XrEventDataMarkerTrackingUpdateVARJO.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 + XrEventDataMarkerTrackingUpdateVARJO.TYPE); }
    /** Unsafe version of {@link #next}. */
    public static long nnext(long struct) { return memGetAddress(struct + XrEventDataMarkerTrackingUpdateVARJO.NEXT); }
    /** Unsafe version of {@link #markerId}. */
    public static long nmarkerId(long struct) { return memGetLong(struct + XrEventDataMarkerTrackingUpdateVARJO.MARKERID); }
    /** Unsafe version of {@link #isActive}. */
    public static int nisActive(long struct) { return memGetInt(struct + XrEventDataMarkerTrackingUpdateVARJO.ISACTIVE); }
    /** Unsafe version of {@link #isPredicted}. */
    public static int nisPredicted(long struct) { return memGetInt(struct + XrEventDataMarkerTrackingUpdateVARJO.ISPREDICTED); }
    /** Unsafe version of {@link #time}. */
    public static long ntime(long struct) { return memGetLong(struct + XrEventDataMarkerTrackingUpdateVARJO.TIME); }

    /** Unsafe version of {@link #type(int) type}. */
    public static void ntype(long struct, int value) { memPutInt(struct + XrEventDataMarkerTrackingUpdateVARJO.TYPE, value); }
    /** Unsafe version of {@link #next(long) next}. */
    public static void nnext(long struct, long value) { memPutAddress(struct + XrEventDataMarkerTrackingUpdateVARJO.NEXT, value); }

    // -----------------------------------

    /** An array of {@link XrEventDataMarkerTrackingUpdateVARJO} structs. */
    public static class Buffer extends StructBuffer implements NativeResource {

        private static final XrEventDataMarkerTrackingUpdateVARJO ELEMENT_FACTORY = XrEventDataMarkerTrackingUpdateVARJO.create(-1L);

        /**
         * Creates a new {@code XrEventDataMarkerTrackingUpdateVARJO.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 XrEventDataMarkerTrackingUpdateVARJO#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 XrEventDataMarkerTrackingUpdateVARJO getElementFactory() {
            return ELEMENT_FACTORY;
        }

        /** @return the value of the {@link XrEventDataMarkerTrackingUpdateVARJO#type} field. */
        @NativeType("XrStructureType")
        public int type() { return XrEventDataMarkerTrackingUpdateVARJO.ntype(address()); }
        /** @return the value of the {@link XrEventDataMarkerTrackingUpdateVARJO#next} field. */
        @NativeType("void const *")
        public long next() { return XrEventDataMarkerTrackingUpdateVARJO.nnext(address()); }
        /** @return the value of the {@link XrEventDataMarkerTrackingUpdateVARJO#markerId} field. */
        @NativeType("uint64_t")
        public long markerId() { return XrEventDataMarkerTrackingUpdateVARJO.nmarkerId(address()); }
        /** @return the value of the {@link XrEventDataMarkerTrackingUpdateVARJO#isActive} field. */
        @NativeType("XrBool32")
        public boolean isActive() { return XrEventDataMarkerTrackingUpdateVARJO.nisActive(address()) != 0; }
        /** @return the value of the {@link XrEventDataMarkerTrackingUpdateVARJO#isPredicted} field. */
        @NativeType("XrBool32")
        public boolean isPredicted() { return XrEventDataMarkerTrackingUpdateVARJO.nisPredicted(address()) != 0; }
        /** @return the value of the {@link XrEventDataMarkerTrackingUpdateVARJO#time} field. */
        @NativeType("XrTime")
        public long time() { return XrEventDataMarkerTrackingUpdateVARJO.ntime(address()); }

        /** Sets the specified value to the {@link XrEventDataMarkerTrackingUpdateVARJO#type} field. */
        public XrEventDataMarkerTrackingUpdateVARJO.Buffer type(@NativeType("XrStructureType") int value) { XrEventDataMarkerTrackingUpdateVARJO.ntype(address(), value); return this; }
        /** Sets the {@link VARJOMarkerTracking#XR_TYPE_EVENT_DATA_MARKER_TRACKING_UPDATE_VARJO TYPE_EVENT_DATA_MARKER_TRACKING_UPDATE_VARJO} value to the {@link XrEventDataMarkerTrackingUpdateVARJO#type} field. */
        public XrEventDataMarkerTrackingUpdateVARJO.Buffer type$Default() { return type(VARJOMarkerTracking.XR_TYPE_EVENT_DATA_MARKER_TRACKING_UPDATE_VARJO); }
        /** Sets the specified value to the {@link XrEventDataMarkerTrackingUpdateVARJO#next} field. */
        public XrEventDataMarkerTrackingUpdateVARJO.Buffer next(@NativeType("void const *") long value) { XrEventDataMarkerTrackingUpdateVARJO.nnext(address(), value); return this; }

    }

}