org.lwjgl.openvr.VREventInputBindingLoad 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.
There is a newer version: 3.3.6
Show 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.*;

/**
 * Layout
 * 
 * 
 * struct VREvent_InputBindingLoad_t {
 *     PropertyContainerHandle_t ulAppContainer;
 *     uint64_t pathMessage;
 *     uint64_t pathUrl;
 *     uint64_t pathControllerType;
 * }
 */
@NativeType("struct VREvent_InputBindingLoad_t")
public class VREventInputBindingLoad 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
        ULAPPCONTAINER,
        PATHMESSAGE,
        PATHURL,
        PATHCONTROLLERTYPE;

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

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

        ULAPPCONTAINER = layout.offsetof(0);
        PATHMESSAGE = layout.offsetof(1);
        PATHURL = layout.offsetof(2);
        PATHCONTROLLERTYPE = layout.offsetof(3);
    }

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

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

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

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

    /** @return the value of the {@code ulAppContainer} field. */
    @NativeType("PropertyContainerHandle_t")
    public long ulAppContainer() { return nulAppContainer(address()); }
    /** @return the value of the {@code pathMessage} field. */
    @NativeType("uint64_t")
    public long pathMessage() { return npathMessage(address()); }
    /** @return the value of the {@code pathUrl} field. */
    @NativeType("uint64_t")
    public long pathUrl() { return npathUrl(address()); }
    /** @return the value of the {@code pathControllerType} field. */
    @NativeType("uint64_t")
    public long pathControllerType() { return npathControllerType(address()); }

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

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

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

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

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

    /** Unsafe version of {@link #ulAppContainer}. */
    public static long nulAppContainer(long struct) { return memGetLong(struct + VREventInputBindingLoad.ULAPPCONTAINER); }
    /** Unsafe version of {@link #pathMessage}. */
    public static long npathMessage(long struct) { return memGetLong(struct + VREventInputBindingLoad.PATHMESSAGE); }
    /** Unsafe version of {@link #pathUrl}. */
    public static long npathUrl(long struct) { return memGetLong(struct + VREventInputBindingLoad.PATHURL); }
    /** Unsafe version of {@link #pathControllerType}. */
    public static long npathControllerType(long struct) { return memGetLong(struct + VREventInputBindingLoad.PATHCONTROLLERTYPE); }

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

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

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

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

        /** @return the value of the {@code ulAppContainer} field. */
        @NativeType("PropertyContainerHandle_t")
        public long ulAppContainer() { return VREventInputBindingLoad.nulAppContainer(address()); }
        /** @return the value of the {@code pathMessage} field. */
        @NativeType("uint64_t")
        public long pathMessage() { return VREventInputBindingLoad.npathMessage(address()); }
        /** @return the value of the {@code pathUrl} field. */
        @NativeType("uint64_t")
        public long pathUrl() { return VREventInputBindingLoad.npathUrl(address()); }
        /** @return the value of the {@code pathControllerType} field. */
        @NativeType("uint64_t")
        public long pathControllerType() { return VREventInputBindingLoad.npathControllerType(address()); }

    }

}