org.lwjgl.openvr.VREventProcess 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 events about processes.
 * 
 * Layout
 * 
 * 
 * struct VREvent_Process_t {
 *     uint32_t pid;
 *     uint32_t oldPid;
 *     bool bForced;
 *     bool {@link #bConnectionLost};
 * }
 */
@NativeType("struct VREvent_Process_t")
public class VREventProcess 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
        PID,
        OLDPID,
        BFORCED,
        BCONNECTIONLOST;

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

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

        PID = layout.offsetof(0);
        OLDPID = layout.offsetof(1);
        BFORCED = layout.offsetof(2);
        BCONNECTIONLOST = layout.offsetof(3);
    }

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

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

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

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

    /** @return the value of the {@code pid} field. */
    @NativeType("uint32_t")
    public int pid() { return npid(address()); }
    /** @return the value of the {@code oldPid} field. */
    @NativeType("uint32_t")
    public int oldPid() { return noldPid(address()); }
    /** @return the value of the {@code bForced} field. */
    @NativeType("bool")
    public boolean bForced() { return nbForced(address()); }
    /** if the associated event was triggered by a connection loss */
    @NativeType("bool")
    public boolean bConnectionLost() { return nbConnectionLost(address()); }

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

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

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

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

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

    /** Unsafe version of {@link #pid}. */
    public static int npid(long struct) { return memGetInt(struct + VREventProcess.PID); }
    /** Unsafe version of {@link #oldPid}. */
    public static int noldPid(long struct) { return memGetInt(struct + VREventProcess.OLDPID); }
    /** Unsafe version of {@link #bForced}. */
    public static boolean nbForced(long struct) { return memGetByte(struct + VREventProcess.BFORCED) != 0; }
    /** Unsafe version of {@link #bConnectionLost}. */
    public static boolean nbConnectionLost(long struct) { return memGetByte(struct + VREventProcess.BCONNECTIONLOST) != 0; }

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

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

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

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

        /** @return the value of the {@code pid} field. */
        @NativeType("uint32_t")
        public int pid() { return VREventProcess.npid(address()); }
        /** @return the value of the {@code oldPid} field. */
        @NativeType("uint32_t")
        public int oldPid() { return VREventProcess.noldPid(address()); }
        /** @return the value of the {@code bForced} field. */
        @NativeType("bool")
        public boolean bForced() { return VREventProcess.nbForced(address()); }
        /** @return the value of the {@link VREventProcess#bConnectionLost} field. */
        @NativeType("bool")
        public boolean bConnectionLost() { return VREventProcess.nbConnectionLost(address()); }

    }

}