Package org.lwjgl.openxr

Class XrHapticActionInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrHapticActionInfo>
org.lwjgl.openxr.XrHapticActionInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrHapticActionInfo extends org.lwjgl.system.Struct<XrHapticActionInfo> implements org.lwjgl.system.NativeResource
Information to output haptic feedback.
Description

See XrActionCreateInfo for a description of subaction paths, and the restrictions on their use.

Valid Usage (Implicit)
See Also

ApplyHapticFeedback, GetDeviceSampleRateFB, StopHapticFeedback

Layout


 struct XrHapticActionInfo {
     XrStructureType type();
     void const * next();
     XrAction action();
     XrPath subactionPath();
 }

  • 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.

    • ACTION

      public static final int ACTION
      The struct member offsets.

    • SUBACTIONPATH

      public static final int SUBACTIONPATH
      The struct member offsets.

  • Constructor Details

    • XrHapticActionInfo

      public XrHapticActionInfo(ByteBuffer container)
      Creates a XrHapticActionInfo 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<XrHapticActionInfo>

    • 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.

    • action

      public long action()
      the XrAction handle for the desired output haptic action.

    • subactionPath

      public long subactionPath()
      the subaction path XrPath of the device to send the haptic event to, or NULL_PATH to specify all subaction paths. If the subaction path is specified, it is one of the subaction paths that were specified when the action was created. If the subaction path was not specified when the action was created, the runtime must return ERROR_PATH_UNSUPPORTED. If this parameter is specified, the runtime must trigger the haptic events only on the device from the subaction path.

    • type

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

    • type$Default

      public XrHapticActionInfo type$Default()
      Sets the TYPE_HAPTIC_ACTION_INFO value to the type() field.

    • next

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

    • action

      public XrHapticActionInfo action(XrAction value)
      Sets the specified value to the action() field.

    • subactionPath

      public XrHapticActionInfo subactionPath(long value)
      Sets the specified value to the subactionPath() field.

    • set

      public XrHapticActionInfo set(int type, long next, XrAction action, long subactionPath)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

      public static XrHapticActionInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XrHapticActionInfo.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().

    • naction

      public static long naction(long struct)
      Unsafe version of action().

    • nsubactionPath

      public static long nsubactionPath(long struct)
      Unsafe version of subactionPath().

    • 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.

    • naction

      public static void naction(long struct, XrAction value)
      Unsafe version of action.

    • nsubactionPath

      public static void nsubactionPath(long struct, long value)
      Unsafe version of subactionPath.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate