Package org.lwjgl.ovr

Class OVRHmdDesc

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<OVRHmdDesc>
org.lwjgl.ovr.OVRHmdDesc
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class OVRHmdDesc extends org.lwjgl.system.Struct<OVRHmdDesc> implements org.lwjgl.system.NativeResource
A complete descriptor of the HMD.

Layout


 struct ovrHmdDesc {
     ovrHmdType Type();
     char[4];
     char ProductName()[64];
     char Manufacturer()[64];
     short VendorId();
     short ProductId();
     char SerialNumber()[24];
     short FirmwareMajor();
     short FirmwareMinor();
     unsigned int AvailableHmdCaps();
     unsigned int DefaultHmdCaps();
     unsigned int AvailableTrackingCaps();
     unsigned int DefaultTrackingCaps();
     ovrFovPort DefaultEyeFov()[ovrEye_Count];
     ovrFovPort MaxEyeFov()[ovrEye_Count];
     ovrSizei Resolution();
     float DisplayRefreshRate();
 }

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

    • PRODUCTNAME

      public static final int PRODUCTNAME
      The struct member offsets.

    • MANUFACTURER

      public static final int MANUFACTURER
      The struct member offsets.

    • VENDORID

      public static final int VENDORID
      The struct member offsets.

    • PRODUCTID

      public static final int PRODUCTID
      The struct member offsets.

    • SERIALNUMBER

      public static final int SERIALNUMBER
      The struct member offsets.

    • FIRMWAREMAJOR

      public static final int FIRMWAREMAJOR
      The struct member offsets.

    • FIRMWAREMINOR

      public static final int FIRMWAREMINOR
      The struct member offsets.

    • AVAILABLEHMDCAPS

      public static final int AVAILABLEHMDCAPS
      The struct member offsets.

    • DEFAULTHMDCAPS

      public static final int DEFAULTHMDCAPS
      The struct member offsets.

    • AVAILABLETRACKINGCAPS

      public static final int AVAILABLETRACKINGCAPS
      The struct member offsets.

    • DEFAULTTRACKINGCAPS

      public static final int DEFAULTTRACKINGCAPS
      The struct member offsets.

    • DEFAULTEYEFOV

      public static final int DEFAULTEYEFOV
      The struct member offsets.

    • MAXEYEFOV

      public static final int MAXEYEFOV
      The struct member offsets.

    • RESOLUTION

      public static final int RESOLUTION
      The struct member offsets.

    • DISPLAYREFRESHRATE

      public static final int DISPLAYREFRESHRATE
      The struct member offsets.

  • Constructor Details

    • OVRHmdDesc

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

    • Type

      public int Type()
      this HMD's type. One of:
      Hmd_NoneHmd_DK2Hmd_CBHmd_OtherHmd_E3_2015Hmd_ES06Hmd_ES09Hmd_ES11Hmd_CV1Hmd_RiftS
      Hmd_QuestHmd_Quest2

    • ProductName

      public ByteBuffer ProductName()
      name string describing the product: "Oculus Rift DK1", etc.

    • ProductNameString

      public String ProductNameString()
      name string describing the product: "Oculus Rift DK1", etc.

    • Manufacturer

      public ByteBuffer Manufacturer()
      string describing the manufacturer. Usually "Oculus".

    • ManufacturerString

      public String ManufacturerString()
      string describing the manufacturer. Usually "Oculus".

    • VendorId

      public short VendorId()
      HID Vendor ID of the device

    • ProductId

      public short ProductId()
      HID Product ID of the device

    • SerialNumber

      public ByteBuffer SerialNumber()
      HMD serial number

    • SerialNumberString

      public String SerialNumberString()
      HMD serial number

    • FirmwareMajor

      public short FirmwareMajor()
      HMD firmware major version number

    • FirmwareMinor

      public short FirmwareMinor()
      HMD firmware minor version number

    • AvailableHmdCaps

      public int AvailableHmdCaps()
      available ovrHmdCaps bits

    • DefaultHmdCaps

      public int DefaultHmdCaps()
      default ovrHmdCaps bits

    • AvailableTrackingCaps

      public int AvailableTrackingCaps()
      available ovrTrackingCaps bits

    • DefaultTrackingCaps

      public int DefaultTrackingCaps()
      default ovrTrackingCaps bits

    • DefaultEyeFov

      public OVRFovPort.Buffer DefaultEyeFov()
      the recommended optical FOV for the HMD

    • DefaultEyeFov

      public OVRFovPort DefaultEyeFov(int index)
      the recommended optical FOV for the HMD

    • MaxEyeFov

      public OVRFovPort.Buffer MaxEyeFov()
      the maximum optical FOV for the HMD

    • MaxEyeFov

      public OVRFovPort MaxEyeFov(int index)
      the maximum optical FOV for the HMD

    • Resolution

      public OVRSizei Resolution()
      resolution of the full HMD screen (both eyes) in pixels

    • DisplayRefreshRate

      public float DisplayRefreshRate()
      refresh rate of the display in cycles per second at the time of HMD creation

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • mallocStack

      @Deprecated public static OVRHmdDesc mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static OVRHmdDesc callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static OVRHmdDesc mallocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static OVRHmdDesc callocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • malloc

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

    • calloc

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

    • nType

      public static int nType(long struct)
      Unsafe version of Type().

    • nProductName

      public static ByteBuffer nProductName(long struct)
      Unsafe version of ProductName().

    • nProductNameString

      public static String nProductNameString(long struct)
      Unsafe version of ProductNameString().

    • nManufacturer

      public static ByteBuffer nManufacturer(long struct)
      Unsafe version of Manufacturer().

    • nManufacturerString

      public static String nManufacturerString(long struct)
      Unsafe version of ManufacturerString().

    • nVendorId

      public static short nVendorId(long struct)
      Unsafe version of VendorId().

    • nProductId

      public static short nProductId(long struct)
      Unsafe version of ProductId().

    • nSerialNumber

      public static ByteBuffer nSerialNumber(long struct)
      Unsafe version of SerialNumber().

    • nSerialNumberString

      public static String nSerialNumberString(long struct)
      Unsafe version of SerialNumberString().

    • nFirmwareMajor

      public static short nFirmwareMajor(long struct)
      Unsafe version of FirmwareMajor().

    • nFirmwareMinor

      public static short nFirmwareMinor(long struct)
      Unsafe version of FirmwareMinor().

    • nDefaultHmdCaps

      public static int nDefaultHmdCaps(long struct)
      Unsafe version of DefaultHmdCaps().

    • nDefaultTrackingCaps

      public static int nDefaultTrackingCaps(long struct)
      Unsafe version of DefaultTrackingCaps().

    • nDefaultEyeFov

      public static OVRFovPort.Buffer nDefaultEyeFov(long struct)
      Unsafe version of DefaultEyeFov().

    • nDefaultEyeFov

      public static OVRFovPort nDefaultEyeFov(long struct, int index)
      Unsafe version of DefaultEyeFov.

    • nMaxEyeFov

      public static OVRFovPort.Buffer nMaxEyeFov(long struct)
      Unsafe version of MaxEyeFov().

    • nMaxEyeFov

      public static OVRFovPort nMaxEyeFov(long struct, int index)
      Unsafe version of MaxEyeFov.

    • nResolution

      public static OVRSizei nResolution(long struct)
      Unsafe version of Resolution().

    • nDisplayRefreshRate

      public static float nDisplayRefreshRate(long struct)
      Unsafe version of DisplayRefreshRate().