Package org.lwjgl.openxr

Class XrInteractionProfileState

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrInteractionProfileState>
org.lwjgl.openxr.XrInteractionProfileState
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrInteractionProfileState extends org.lwjgl.system.Struct<XrInteractionProfileState> implements org.lwjgl.system.NativeResource
Receives active interaction profile for a top level path.
Description

The runtime must only include interaction profiles that the application has provided bindings for via SuggestInteractionProfileBindings or NULL_PATH. If the runtime is rebinding an interaction profile provided by the application to a device that the application did not provide bindings for, it must return the interaction profile path that it is emulating. If the runtime is unable to provide input because it cannot emulate any of the application-provided interaction profiles, it must return NULL_PATH.

Valid Usage (Implicit)
See Also

XrActionSuggestedBinding, GetCurrentInteractionProfile, SuggestInteractionProfileBindings

Layout


 struct XrInteractionProfileState {
     XrStructureType type();
     void * next();
     XrPath interactionProfile();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • TYPE

      public static final int TYPE
      The struct member offsets.

    • NEXT

      public static final int NEXT
      The struct member offsets.

    • INTERACTIONPROFILE

      public static final int INTERACTIONPROFILE
      The struct member offsets.

  • Constructor Details

    • XrInteractionProfileState

      public XrInteractionProfileState(ByteBuffer container)
      Creates a XrInteractionProfileState instance at the current position of the specified 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.

  • Method Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<XrInteractionProfileState>

    • type

      public int type()
      the XrStructureType of this structure.

    • next

      public long next()
      NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.

    • interactionProfile

      public long interactionProfile()
      the XrPath of the interaction profile path for the GetCurrentInteractionProfile::topLevelUserPath used to retrieve this state, or NULL_PATH if there is no active interaction profile at that top level user path.

    • type

      public XrInteractionProfileState type(int value)
      Sets the specified value to the type() field.

    • type$Default

      public XrInteractionProfileState type$Default()
      Sets the TYPE_INTERACTION_PROFILE_STATE value to the type() field.

    • next

      public XrInteractionProfileState next(long value)
      Sets the specified value to the next() field.

    • interactionProfile

      public XrInteractionProfileState interactionProfile(long value)
      Sets the specified value to the interactionProfile() field.

    • set

      public XrInteractionProfileState set(int type, long next, long interactionProfile)
      Initializes this struct with the specified values.

    • set

      public XrInteractionProfileState set(XrInteractionProfileState src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static XrInteractionProfileState malloc()
      Returns a new XrInteractionProfileState instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static XrInteractionProfileState calloc()
      Returns a new XrInteractionProfileState instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static XrInteractionProfileState create()
      Returns a new XrInteractionProfileState instance allocated with BufferUtils.

    • create

      public static XrInteractionProfileState create(long address)
      Returns a new XrInteractionProfileState instance for the specified memory address.

    • createSafe

      public static @Nullable XrInteractionProfileState createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static XrInteractionProfileState.Buffer malloc(int capacity)
      Returns a new XrInteractionProfileState.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static XrInteractionProfileState.Buffer calloc(int capacity)
      Returns a new XrInteractionProfileState.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static XrInteractionProfileState.Buffer create(int capacity)
      Returns a new XrInteractionProfileState.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static XrInteractionProfileState.Buffer create(long address, int capacity)
      Create a XrInteractionProfileState.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable XrInteractionProfileState.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static XrInteractionProfileState malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new XrInteractionProfileState instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static XrInteractionProfileState calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new XrInteractionProfileState instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static XrInteractionProfileState.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XrInteractionProfileState.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static XrInteractionProfileState.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XrInteractionProfileState.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • ntype

      public static int ntype(long struct)
      Unsafe version of type().

    • nnext

      public static long nnext(long struct)
      Unsafe version of next().

    • ninteractionProfile

      public static long ninteractionProfile(long struct)
      Unsafe version of interactionProfile().

    • ntype

      public static void ntype(long struct, int value)
      Unsafe version of type.

    • nnext

      public static void nnext(long struct, long value)
      Unsafe version of next.

    • ninteractionProfile

      public static void ninteractionProfile(long struct, long value)
      Unsafe version of interactionProfile.