org.lwjgl.openvr.VREventOverlay Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-openvr Show documentation
An API and runtime that allows access to VR hardware from multiple vendors without requiring that applications have specific knowledge of the hardware they are targeting.
The newest version!
/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.openvr;

import org.jspecify.annotations.*;

import java.nio.*;

import org.lwjgl.system.*;

import static org.lwjgl.system.MemoryUtil.*;

/**
 * Used for a few events about overlays.
 * 
 * Layout
 * 
 * 
 * struct VREvent_Overlay_t {
 *     uint64_t {@link #overlayHandle};
 *     uint64_t devicePath;
 *     uint64_t memoryBlockId;
 *     uint32_t {@link #cursorIndex};
 * }
 */
@NativeType("struct VREvent_Overlay_t")
public class VREventOverlay extends Struct {

    /** 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
        OVERLAYHANDLE,
        DEVICEPATH,
        MEMORYBLOCKID,
        CURSORINDEX;

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

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

        OVERLAYHANDLE = layout.offsetof(0);
        DEVICEPATH = layout.offsetof(1);
        MEMORYBLOCKID = layout.offsetof(2);
        CURSORINDEX = layout.offsetof(3);
    }

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

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

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

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

    /** one of:
{@link VR#EVRState_VRState_Undefined} {@link VR#EVRState_VRState_Off} {@link VR#EVRState_VRState_Searching}
{@link VR#EVRState_VRState_Searching_Alert} {@link VR#EVRState_VRState_Ready} {@link VR#EVRState_VRState_Ready_Alert}
{@link VR#EVRState_VRState_NotReady} {@link VR#EVRState_VRState_Standby} {@link VR#EVRState_VRState_Ready_Alert_Low} */
    @NativeType("uint64_t")
    public long overlayHandle() { return noverlayHandle(address()); }
    /** @return the value of the {@code devicePath} field. */
    @NativeType("uint64_t")
    public long devicePath() { return ndevicePath(address()); }
    /** @return the value of the {@code memoryBlockId} field. */
    @NativeType("uint64_t")
    public long memoryBlockId() { return nmemoryBlockId(address()); }
    /** if from an event triggered by cursor input on an overlay that supports multiple cursors, this is the index of which tracked cursor the event is for */
    @NativeType("uint32_t")
    public int cursorIndex() { return ncursorIndex(address()); }

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

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

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

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

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

    /** Unsafe version of {@link #overlayHandle}. */
    public static long noverlayHandle(long struct) { return memGetLong(struct + VREventOverlay.OVERLAYHANDLE); }
    /** Unsafe version of {@link #devicePath}. */
    public static long ndevicePath(long struct) { return memGetLong(struct + VREventOverlay.DEVICEPATH); }
    /** Unsafe version of {@link #memoryBlockId}. */
    public static long nmemoryBlockId(long struct) { return memGetLong(struct + VREventOverlay.MEMORYBLOCKID); }
    /** Unsafe version of {@link #cursorIndex}. */
    public static int ncursorIndex(long struct) { return memGetInt(struct + VREventOverlay.CURSORINDEX); }

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

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

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

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

        /** @return the value of the {@link VREventOverlay#overlayHandle} field. */
        @NativeType("uint64_t")
        public long overlayHandle() { return VREventOverlay.noverlayHandle(address()); }
        /** @return the value of the {@code devicePath} field. */
        @NativeType("uint64_t")
        public long devicePath() { return VREventOverlay.ndevicePath(address()); }
        /** @return the value of the {@code memoryBlockId} field. */
        @NativeType("uint64_t")
        public long memoryBlockId() { return VREventOverlay.nmemoryBlockId(address()); }
        /** @return the value of the {@link VREventOverlay#cursorIndex} field. */
        @NativeType("uint32_t")
        public int cursorIndex() { return VREventOverlay.ncursorIndex(address()); }

    }

}
{@link VR#EVRState_VRState_Undefined}	{@link VR#EVRState_VRState_Off}	{@link VR#EVRState_VRState_Searching}
{@link VR#EVRState_VRState_Searching_Alert}	{@link VR#EVRState_VRState_Ready}	{@link VR#EVRState_VRState_Ready_Alert}
{@link VR#EVRState_VRState_NotReady}	{@link VR#EVRState_VRState_Standby}	{@link VR#EVRState_VRState_Ready_Alert_Low}