org.lwjgl.openxr.XrSystemTrackingProperties 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.*;

/**
 * Tracking-related properties of a particular system.
 * 
 * See Also
 * 
 * {@link XrSystemGraphicsProperties}, {@link XrSystemProperties}, {@link XR10#xrGetSystem GetSystem}, {@link XR10#xrGetSystemProperties GetSystemProperties}
 * 
 * Layout
 * 
 * 
 * struct XrSystemTrackingProperties {
 *     XrBool32 {@link #orientationTracking};
 *     XrBool32 {@link #positionTracking};
 * }
 */
public class XrSystemTrackingProperties 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
        ORIENTATIONTRACKING,
        POSITIONTRACKING;

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

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

        ORIENTATIONTRACKING = layout.offsetof(0);
        POSITIONTRACKING = layout.offsetof(1);
    }

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

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

    /**
     * Creates a {@code XrSystemTrackingProperties} 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 XrSystemTrackingProperties(ByteBuffer container) {
        super(memAddress(container), __checkContainer(container, SIZEOF));
    }

    @Override
    public int sizeof() { return SIZEOF; }

    /** set to {@link XR10#XR_TRUE TRUE} to indicate the system supports orientational tracking of the view pose(s), {@link XR10#XR_FALSE FALSE} otherwise. */
    @NativeType("XrBool32")
    public boolean orientationTracking() { return norientationTracking(address()) != 0; }
    /** set to {@link XR10#XR_TRUE TRUE} to indicate the system supports positional tracking of the view pose(s), {@link XR10#XR_FALSE FALSE} otherwise. */
    @NativeType("XrBool32")
    public boolean positionTracking() { return npositionTracking(address()) != 0; }

    /** Sets the specified value to the {@link #orientationTracking} field. */
    public XrSystemTrackingProperties orientationTracking(@NativeType("XrBool32") boolean value) { norientationTracking(address(), value ? 1 : 0); return this; }
    /** Sets the specified value to the {@link #positionTracking} field. */
    public XrSystemTrackingProperties positionTracking(@NativeType("XrBool32") boolean value) { npositionTracking(address(), value ? 1 : 0); return this; }

    /** Initializes this struct with the specified values. */
    public XrSystemTrackingProperties set(
        boolean orientationTracking,
        boolean positionTracking
    ) {
        orientationTracking(orientationTracking);
        positionTracking(positionTracking);

        return this;
    }

    /**
     * Copies the specified struct data to this struct.
     *
     * @param src the source struct
     *
     * @return this struct
     */
    public XrSystemTrackingProperties set(XrSystemTrackingProperties src) {
        memCopy(src.address(), address(), SIZEOF);
        return this;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

    /**
     * Returns a new {@link XrSystemTrackingProperties.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 XrSystemTrackingProperties.Buffer calloc(int capacity, MemoryStack stack) {
        return new Buffer(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
    }

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

    /** Unsafe version of {@link #orientationTracking}. */
    public static int norientationTracking(long struct) { return memGetInt(struct + XrSystemTrackingProperties.ORIENTATIONTRACKING); }
    /** Unsafe version of {@link #positionTracking}. */
    public static int npositionTracking(long struct) { return memGetInt(struct + XrSystemTrackingProperties.POSITIONTRACKING); }

    /** Unsafe version of {@link #orientationTracking(boolean) orientationTracking}. */
    public static void norientationTracking(long struct, int value) { memPutInt(struct + XrSystemTrackingProperties.ORIENTATIONTRACKING, value); }
    /** Unsafe version of {@link #positionTracking(boolean) positionTracking}. */
    public static void npositionTracking(long struct, int value) { memPutInt(struct + XrSystemTrackingProperties.POSITIONTRACKING, value); }

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

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

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

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

        /** @return the value of the {@link XrSystemTrackingProperties#orientationTracking} field. */
        @NativeType("XrBool32")
        public boolean orientationTracking() { return XrSystemTrackingProperties.norientationTracking(address()) != 0; }
        /** @return the value of the {@link XrSystemTrackingProperties#positionTracking} field. */
        @NativeType("XrBool32")
        public boolean positionTracking() { return XrSystemTrackingProperties.npositionTracking(address()) != 0; }

        /** Sets the specified value to the {@link XrSystemTrackingProperties#orientationTracking} field. */
        public XrSystemTrackingProperties.Buffer orientationTracking(@NativeType("XrBool32") boolean value) { XrSystemTrackingProperties.norientationTracking(address(), value ? 1 : 0); return this; }
        /** Sets the specified value to the {@link XrSystemTrackingProperties#positionTracking} field. */
        public XrSystemTrackingProperties.Buffer positionTracking(@NativeType("XrBool32") boolean value) { XrSystemTrackingProperties.npositionTracking(address(), value ? 1 : 0); return this; }

    }

}