Package org.lwjgl.openvr

Class VREventMouse

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VREventMouse>
org.lwjgl.openvr.VREventMouse
All Implemented Interfaces:
org.lwjgl.system.Pointer
public class VREventMouse extends org.lwjgl.system.Struct<VREventMouse>
Used for simulated mouse events in overlay space.

Layout


 struct VREvent_Mouse_t {
     float x();
     float y;
     uint32_t button();
     uint32_t cursorIndex();
 }

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    VREventMouse.Buffer
    An array of VREventMouse structs.

    Nested classes/interfaces inherited from class org.lwjgl.system.Struct

    org.lwjgl.system.Struct.StructValidation

    Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

    org.lwjgl.system.Pointer.Default

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALIGNOF
    The struct alignment in bytes.
    static final int
    BUTTON
    The struct member offsets.
    static final int
    CURSORINDEX
    The struct member offsets.
    static final int
    SIZEOF
    The struct size in bytes.
    static final int
    X
    The struct member offsets.
    static final int
    Y
    The struct member offsets.

    Fields inherited from interface org.lwjgl.system.Pointer

    BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    VREventMouse(ByteBuffer container)
    Creates a VREventMouse instance at the current position of the specified ByteBuffer container.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    button()
    one of:
    VR.EVRMouseButton_VRMouseButton_LeftVR.EVRMouseButton_VRMouseButton_RightVR.EVRMouseButton_VRMouseButton_Middle
    static VREventMouse
    create(long address)
    Returns a new VREventMouse instance for the specified memory address.
    static VREventMouse.Buffer
    create(long address, int capacity)
    Create a VREventMouse.Buffer instance at the specified memory.
    static @Nullable VREventMouse
    createSafe(long address)
    Like create, but returns null if address is NULL.
    static @Nullable VREventMouse.Buffer
    createSafe(long address, int capacity)
    Like create, but returns null if address is NULL.
    int
    cursorIndex()
    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
    static int
    nbutton(long struct)
    Unsafe version of button().
    static int
    ncursorIndex(long struct)
    Unsafe version of cursorIndex().
    static float
    nx(long struct)
    Unsafe version of x().
    static float
    ny(long struct)
    Unsafe version of y().
    int
    sizeof()
     
    float
    x()
    coords are in GL space, bottom left of the texture is 0,0
    float
    y()
     

    Methods inherited from class org.lwjgl.system.Struct

    clear, free, isNull, validate, validate

    Methods inherited from class org.lwjgl.system.Pointer.Default

    address, equals, hashCode, toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • X

      public static final int X
      The struct member offsets.

    • Y

      public static final int Y
      The struct member offsets.

    • BUTTON

      public static final int BUTTON
      The struct member offsets.

    • CURSORINDEX

      public static final int CURSORINDEX
      The struct member offsets.

  • Constructor Details

    • VREventMouse

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

    • x

      public float x()
      coords are in GL space, bottom left of the texture is 0,0

    • y

      public float y()
      Returns:
      the value of the y field.

    • button

      public int button()
      one of:
      VR.EVRMouseButton_VRMouseButton_LeftVR.EVRMouseButton_VRMouseButton_Right
      VR.EVRMouseButton_VRMouseButton_Middle

    • cursorIndex

      public int cursorIndex()
      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

    • create

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

    • createSafe

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

    • create

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

    • createSafe

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

    • nx

      public static float nx(long struct)
      Unsafe version of x().

    • ny

      public static float ny(long struct)
      Unsafe version of y().

    • nbutton

      public static int nbutton(long struct)
      Unsafe version of button().

    • ncursorIndex

      public static int ncursorIndex(long struct)
      Unsafe version of cursorIndex().