java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.ovr.OVRHmdDesc

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class OVRHmdDesc
extends org.lwjgl.system.Struct
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();
 }

Nested Class Summary
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`AVAILABLEHMDCAPS AVAILABLETRACKINGCAPS DEFAULTEYEFOV DEFAULTHMDCAPS DEFAULTTRACKINGCAPS DISPLAYREFRESHRATE FIRMWAREMAJOR FIRMWAREMINOR MANUFACTURER MAXEYEFOV PRODUCTID PRODUCTNAME RESOLUTION SERIALNUMBER`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`TYPE VENDORID`	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

OVRHmdDesc(java.nio.ByteBuffer container)
Creates a OVRHmdDesc instance at the current position of the specified ByteBuffer container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`AvailableHmdCaps()`	available `ovrHmdCaps` bits
`int`	`AvailableTrackingCaps()`	available `ovrTrackingCaps` bits
`static OVRHmdDesc`	`calloc()`	Returns a new `OVRHmdDesc` instance allocated with `memCalloc`.
`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.
`static OVRHmdDesc`	`callocStack()`	Deprecated.
`static OVRHmdDesc`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static OVRHmdDesc`	`create()`	Returns a new `OVRHmdDesc` instance allocated with `BufferUtils`.
`static OVRHmdDesc`	`create(long address)`	Returns a new `OVRHmdDesc` instance for the specified memory address.
`static OVRHmdDesc`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`OVRFovPort.Buffer`	`DefaultEyeFov()`	the recommended optical FOV for the HMD
`OVRFovPort`	`DefaultEyeFov(int index)`	the recommended optical FOV for the HMD
`int`	`DefaultHmdCaps()`	default `ovrHmdCaps` bits
`int`	`DefaultTrackingCaps()`	default `ovrTrackingCaps` bits
`float`	`DisplayRefreshRate()`	refresh rate of the display in cycles per second at the time of HMD creation
`short`	`FirmwareMajor()`	HMD firmware major version number
`short`	`FirmwareMinor()`	HMD firmware minor version number
`static OVRHmdDesc`	`malloc()`	Returns a new `OVRHmdDesc` instance allocated with `memAlloc`.
`static OVRHmdDesc`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `OVRHmdDesc` instance allocated on the specified `MemoryStack`.
`static OVRHmdDesc`	`mallocStack()`	Deprecated.
`static OVRHmdDesc`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`java.nio.ByteBuffer`	`Manufacturer()`	string describing the manufacturer.
`java.lang.String`	`ManufacturerString()`	string describing the manufacturer.
`OVRFovPort.Buffer`	`MaxEyeFov()`	the maximum optical FOV for the HMD
`OVRFovPort`	`MaxEyeFov(int index)`	the maximum optical FOV for the HMD
`static int`	`nAvailableHmdCaps(long struct)`	Unsafe version of `AvailableHmdCaps()`.
`static int`	`nAvailableTrackingCaps(long struct)`	Unsafe version of `AvailableTrackingCaps()`.
`static OVRFovPort.Buffer`	`nDefaultEyeFov(long struct)`	Unsafe version of `DefaultEyeFov()`.
`static OVRFovPort`	`nDefaultEyeFov(long struct, int index)`	Unsafe version of `DefaultEyeFov`.
`static int`	`nDefaultHmdCaps(long struct)`	Unsafe version of `DefaultHmdCaps()`.
`static int`	`nDefaultTrackingCaps(long struct)`	Unsafe version of `DefaultTrackingCaps()`.
`static float`	`nDisplayRefreshRate(long struct)`	Unsafe version of `DisplayRefreshRate()`.
`static short`	`nFirmwareMajor(long struct)`	Unsafe version of `FirmwareMajor()`.
`static short`	`nFirmwareMinor(long struct)`	Unsafe version of `FirmwareMinor()`.
`static java.nio.ByteBuffer`	`nManufacturer(long struct)`	Unsafe version of `Manufacturer()`.
`static java.lang.String`	`nManufacturerString(long struct)`	Unsafe version of `ManufacturerString()`.
`static OVRFovPort.Buffer`	`nMaxEyeFov(long struct)`	Unsafe version of `MaxEyeFov()`.
`static OVRFovPort`	`nMaxEyeFov(long struct, int index)`	Unsafe version of `MaxEyeFov`.
`static short`	`nProductId(long struct)`	Unsafe version of `ProductId()`.
`static java.nio.ByteBuffer`	`nProductName(long struct)`	Unsafe version of `ProductName()`.
`static java.lang.String`	`nProductNameString(long struct)`	Unsafe version of `ProductNameString()`.
`static OVRSizei`	`nResolution(long struct)`	Unsafe version of `Resolution()`.
`static java.nio.ByteBuffer`	`nSerialNumber(long struct)`	Unsafe version of `SerialNumber()`.
`static java.lang.String`	`nSerialNumberString(long struct)`	Unsafe version of `SerialNumberString()`.
`static int`	`nType(long struct)`	Unsafe version of `Type()`.
`static short`	`nVendorId(long struct)`	Unsafe version of `VendorId()`.
`short`	`ProductId()`	HID Product ID of the device
`java.nio.ByteBuffer`	`ProductName()`	name string describing the product: "Oculus Rift DK1", etc.
`java.lang.String`	`ProductNameString()`	name string describing the product: "Oculus Rift DK1", etc.
`OVRSizei`	`Resolution()`	resolution of the full HMD screen (both eyes) in pixels
`java.nio.ByteBuffer`	`SerialNumber()`	HMD serial number
`java.lang.String`	`SerialNumberString()`	HMD serial number
`int`	`sizeof()`
`int`	`Type()`	this HMD's type.
`short`	`VendorId()`	HID Vendor ID of the device

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - TYPE, PRODUCTNAME, MANUFACTURER, VENDORID, PRODUCTID, SERIALNUMBER, FIRMWAREMAJOR, FIRMWAREMINOR, AVAILABLEHMDCAPS, DEFAULTHMDCAPS, AVAILABLETRACKINGCAPS, DEFAULTTRACKINGCAPS, DEFAULTEYEFOV, MAXEYEFOV, RESOLUTION, DISPLAYREFRESHRATE
    
    The struct member offsets.
- Constructor Detail
  - OVRHmdDesc
```
public OVRHmdDesc(java.nio.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 Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - Type
```
public int Type()
```
    this HMD's type. One of:
    Hmd_None Hmd_DK2 Hmd_CB Hmd_Other Hmd_E3_2015 Hmd_ES06 Hmd_ES09 Hmd_ES11 Hmd_CV1 Hmd_RiftS
    Hmd_Quest Hmd_Quest2
  - ProductName, ProductNameString
```
public java.nio.ByteBuffer ProductName()

public java.lang.String ProductNameString()
```
    name string describing the product: "Oculus Rift DK1", etc.
  - Manufacturer, ManufacturerString
```
public java.nio.ByteBuffer Manufacturer()

public java.lang.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, SerialNumberString
```
public java.nio.ByteBuffer SerialNumber()

public java.lang.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()

public OVRFovPort DefaultEyeFov(int index)
```
    the recommended optical FOV for the HMD
  - MaxEyeFov
```
public OVRFovPort.Buffer 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
```
@Nullable
public static 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 java.nio.ByteBuffer nProductName(long struct)
```
    Unsafe version of ProductName().
  - nProductNameString
```
public static java.lang.String nProductNameString(long struct)
```
    Unsafe version of ProductNameString().
  - nManufacturer
```
public static java.nio.ByteBuffer nManufacturer(long struct)
```
    Unsafe version of Manufacturer().
  - nManufacturerString
```
public static java.lang.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 java.nio.ByteBuffer nSerialNumber(long struct)
```
    Unsafe version of SerialNumber().
  - nSerialNumberString
```
public static java.lang.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().
  - nAvailableHmdCaps
```
public static int nAvailableHmdCaps(long struct)
```
    Unsafe version of AvailableHmdCaps().
  - nDefaultHmdCaps
```
public static int nDefaultHmdCaps(long struct)
```
    Unsafe version of DefaultHmdCaps().
  - nAvailableTrackingCaps
```
public static int nAvailableTrackingCaps(long struct)
```
    Unsafe version of AvailableTrackingCaps().
  - 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().

`Hmd_None`	`Hmd_DK2`	`Hmd_CB`	`Hmd_Other`	`Hmd_E3_2015`	`Hmd_ES06`	`Hmd_ES09`	`Hmd_ES11`	`Hmd_CV1`	`Hmd_RiftS`
`Hmd_Quest`	`Hmd_Quest2`

Class OVRHmdDesc

Layout

Nested Class Summary

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

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

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

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

TYPE, PRODUCTNAME, MANUFACTURER, VENDORID, PRODUCTID, SERIALNUMBER, FIRMWAREMAJOR, FIRMWAREMINOR, AVAILABLEHMDCAPS, DEFAULTHMDCAPS, AVAILABLETRACKINGCAPS, DEFAULTTRACKINGCAPS, DEFAULTEYEFOV, MAXEYEFOV, RESOLUTION, DISPLAYREFRESHRATE

Constructor Detail

OVRHmdDesc

Method Detail

sizeof

Type

ProductName, ProductNameString

Manufacturer, ManufacturerString

VendorId

ProductId

SerialNumber, SerialNumberString

FirmwareMajor

FirmwareMinor

AvailableHmdCaps

DefaultHmdCaps

AvailableTrackingCaps

DefaultTrackingCaps

DefaultEyeFov

MaxEyeFov

Resolution

DisplayRefreshRate

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

nType

nProductName

nProductNameString

nManufacturer

nManufacturerString

nVendorId

nProductId

nSerialNumber

nSerialNumberString

nFirmwareMajor

nFirmwareMinor

nAvailableHmdCaps

nDefaultHmdCaps

nAvailableTrackingCaps

nDefaultTrackingCaps

nDefaultEyeFov

nDefaultEyeFov

nMaxEyeFov

nMaxEyeFov

nResolution

nDisplayRefreshRate