Top Description Fields Constructors Methods
org.lwjgl.ovr

public Class OVRHmdDesc

extends Struct<OVRHmdDesc>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct ovrHmdDesc
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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 Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
AVAILABLEHMDCAPS

The struct member offsets.

public static final int
AVAILABLETRACKINGCAPS

The struct member offsets.

public static final int
DEFAULTEYEFOV

The struct member offsets.

public static final int
DEFAULTHMDCAPS

The struct member offsets.

public static final int
DEFAULTTRACKINGCAPS

The struct member offsets.

public static final int
DISPLAYREFRESHRATE

The struct member offsets.

public static final int
FIRMWAREMAJOR

The struct member offsets.

public static final int
FIRMWAREMINOR

The struct member offsets.

public static final int
MANUFACTURER

The struct member offsets.

public static final int
MAXEYEFOV

The struct member offsets.

public static final int
PRODUCTID

The struct member offsets.

public static final int
PRODUCTNAME

The struct member offsets.

public static final int
RESOLUTION

The struct member offsets.

public static final int
SERIALNUMBER

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

public static final int
VENDORID

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
OVRHmdDesc(long address, ByteBuffer container)

public
OVRHmdDesc(ByteBuffer container)

Creates a OVRHmdDesc instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
AvailableHmdCaps()

available ovrHmdCaps bits

public int
AvailableTrackingCaps()

available ovrTrackingCaps bits

public static OVRHmdDesc
calloc()

Returns a new OVRHmdDesc instance allocated with memCalloc.

public static OVRHmdDesc
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new OVRHmdDesc instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static OVRHmdDesc
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static OVRHmdDesc
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected OVRHmdDesc
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static OVRHmdDesc
create()

Returns a new OVRHmdDesc instance allocated with BufferUtils.

public static OVRHmdDesc
create(long address)

Returns a new OVRHmdDesc instance for the specified memory address.

public static OVRHmdDesc
createSafe(long address)

Like create, but returns null if address is NULL.

public OVRFovPort.Buffer
DefaultEyeFov()

the recommended optical FOV for the HMD

public OVRFovPort
DefaultEyeFov(int index)

the recommended optical FOV for the HMD

public int
DefaultHmdCaps()

default ovrHmdCaps bits

public int
DefaultTrackingCaps()

default ovrTrackingCaps bits

public float
DisplayRefreshRate()

refresh rate of the display in cycles per second at the time of HMD creation

public short
FirmwareMajor()

HMD firmware major version number

public short
FirmwareMinor()

HMD firmware minor version number

public static OVRHmdDesc
malloc()

Returns a new OVRHmdDesc instance allocated with memAlloc.

public static OVRHmdDesc
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new OVRHmdDesc instance allocated on the specified MemoryStack.

public static OVRHmdDesc
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static OVRHmdDesc
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public ByteBuffer
Manufacturer()

string describing the manufacturer.

public String
ManufacturerString()

string describing the manufacturer.

public OVRFovPort.Buffer
MaxEyeFov()

the maximum optical FOV for the HMD

public OVRFovPort
MaxEyeFov(int index)

the maximum optical FOV for the HMD

public static OVRFovPort.Buffer
nDefaultEyeFov(long struct)

Unsafe version of DefaultEyeFov.

public static OVRFovPort
nDefaultEyeFov(long struct, int index)

Unsafe version of DefaultEyeFov.

public static int
nDefaultHmdCaps(long struct)

Unsafe version of DefaultHmdCaps.

public static int
nDefaultTrackingCaps(long struct)

Unsafe version of DefaultTrackingCaps.

public static float
nDisplayRefreshRate(long struct)

Unsafe version of DisplayRefreshRate.

public static short
nFirmwareMajor(long struct)

Unsafe version of FirmwareMajor.

public static short
nFirmwareMinor(long struct)

Unsafe version of FirmwareMinor.

public static ByteBuffer
nManufacturer(long struct)

Unsafe version of Manufacturer.

public static String
nManufacturerString(long struct)

Unsafe version of ManufacturerString.

public static OVRFovPort.Buffer
nMaxEyeFov(long struct)

Unsafe version of MaxEyeFov.

public static OVRFovPort
nMaxEyeFov(long struct, int index)

Unsafe version of MaxEyeFov.

public static short
nProductId(long struct)

Unsafe version of ProductId.

public static ByteBuffer
nProductName(long struct)

Unsafe version of ProductName.

public static String
nProductNameString(long struct)

Unsafe version of ProductNameString.

public static OVRSizei
nResolution(long struct)

Unsafe version of Resolution.

public static ByteBuffer
nSerialNumber(long struct)

Unsafe version of SerialNumber.

public static String
nSerialNumberString(long struct)

Unsafe version of SerialNumberString.

public static int
nType(long struct)

Unsafe version of Type.

public static short
nVendorId(long struct)

Unsafe version of VendorId.

public short
ProductId()

HID Product ID of the device

public ByteBuffer
ProductName()

name string describing the product: "Oculus Rift DK1", etc.

public String
ProductNameString()

name string describing the product: "Oculus Rift DK1", etc.

public OVRSizei
Resolution()

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

public ByteBuffer
SerialNumber()

HMD serial number

public String
SerialNumberString()

HMD serial number

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
Type()

this HMD's type.

public short
VendorId()

HID Vendor ID of the device

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

AVAILABLEHMDCAPSback to summary
public static final int AVAILABLEHMDCAPS

The struct member offsets.

AVAILABLETRACKINGCAPSback to summary
public static final int AVAILABLETRACKINGCAPS

The struct member offsets.

DEFAULTEYEFOVback to summary
public static final int DEFAULTEYEFOV

The struct member offsets.

DEFAULTHMDCAPSback to summary
public static final int DEFAULTHMDCAPS

The struct member offsets.

DEFAULTTRACKINGCAPSback to summary
public static final int DEFAULTTRACKINGCAPS

The struct member offsets.

DISPLAYREFRESHRATEback to summary
public static final int DISPLAYREFRESHRATE

The struct member offsets.

FIRMWAREMAJORback to summary
public static final int FIRMWAREMAJOR

The struct member offsets.

FIRMWAREMINORback to summary
public static final int FIRMWAREMINOR

The struct member offsets.

MANUFACTURERback to summary
public static final int MANUFACTURER

The struct member offsets.

MAXEYEFOVback to summary
public static final int MAXEYEFOV

The struct member offsets.

PRODUCTIDback to summary
public static final int PRODUCTID

The struct member offsets.

PRODUCTNAMEback to summary
public static final int PRODUCTNAME

The struct member offsets.

RESOLUTIONback to summary
public static final int RESOLUTION

The struct member offsets.

SERIALNUMBERback to summary
public static final int SERIALNUMBER

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

VENDORIDback to summary
public static final int VENDORID

The struct member offsets.

Constructor Detail

OVRHmdDescback to summary
protected OVRHmdDesc(long address, ByteBuffer container)
OVRHmdDescback to summary
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 Detail

AvailableHmdCapsback to summary
public int AvailableHmdCaps()

available ovrHmdCaps bits

Annotations
@NativeType:unsigned int
AvailableTrackingCapsback to summary
public int AvailableTrackingCaps()

available ovrTrackingCaps bits

Annotations
@NativeType:unsigned int
callocback to summary
public static OVRHmdDesc calloc()

Returns a new OVRHmdDesc instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static OVRHmdDesc calloc(MemoryStack stack)

Returns a new OVRHmdDesc instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static OVRHmdDesc callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static OVRHmdDesc callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected OVRHmdDesc create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static OVRHmdDesc create()

Returns a new OVRHmdDesc instance allocated with BufferUtils.

createback to summary
public static OVRHmdDesc create(long address)

Returns a new OVRHmdDesc instance for the specified memory address.

createSafeback to summary
public static OVRHmdDesc createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
DefaultEyeFovback to summary
public OVRFovPort.Buffer DefaultEyeFov()

the recommended optical FOV for the HMD

Annotations
@NativeType:ovrFovPort[ovrEye_Count]
DefaultEyeFovback to summary
public OVRFovPort DefaultEyeFov(int index)

the recommended optical FOV for the HMD

Annotations
@NativeType:ovrFovPort
DefaultHmdCapsback to summary
public int DefaultHmdCaps()

default ovrHmdCaps bits

Annotations
@NativeType:unsigned int
DefaultTrackingCapsback to summary
public int DefaultTrackingCaps()

default ovrTrackingCaps bits

Annotations
@NativeType:unsigned int
DisplayRefreshRateback to summary
public float DisplayRefreshRate()

refresh rate of the display in cycles per second at the time of HMD creation

FirmwareMajorback to summary
public short FirmwareMajor()

HMD firmware major version number

FirmwareMinorback to summary
public short FirmwareMinor()

HMD firmware minor version number

mallocback to summary
public static OVRHmdDesc malloc()

Returns a new OVRHmdDesc instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static OVRHmdDesc malloc(MemoryStack stack)

Returns a new OVRHmdDesc instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static OVRHmdDesc mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static OVRHmdDesc mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
Manufacturerback to summary
public ByteBuffer Manufacturer()

string describing the manufacturer. Usually "Oculus".

Annotations
@NativeType:char[64]
ManufacturerStringback to summary
public String ManufacturerString()

string describing the manufacturer. Usually "Oculus".

Annotations
@NativeType:char[64]
MaxEyeFovback to summary
public OVRFovPort.Buffer MaxEyeFov()

the maximum optical FOV for the HMD

Annotations
@NativeType:ovrFovPort[ovrEye_Count]
MaxEyeFovback to summary
public OVRFovPort MaxEyeFov(int index)

the maximum optical FOV for the HMD

Annotations
@NativeType:ovrFovPort
nAvailableHmdCapsback to summary
public static int nAvailableHmdCaps(long struct)

Unsafe version of AvailableHmdCaps.

nAvailableTrackingCapsback to summary
public static int nAvailableTrackingCaps(long struct)

Unsafe version of AvailableTrackingCaps.

nDefaultEyeFovback to summary
public static OVRFovPort.Buffer nDefaultEyeFov(long struct)

Unsafe version of DefaultEyeFov.

nDefaultEyeFovback to summary
public static OVRFovPort nDefaultEyeFov(long struct, int index)

Unsafe version of DefaultEyeFov.

nDefaultHmdCapsback to summary
public static int nDefaultHmdCaps(long struct)

Unsafe version of DefaultHmdCaps.

nDefaultTrackingCapsback to summary
public static int nDefaultTrackingCaps(long struct)

Unsafe version of DefaultTrackingCaps.

nDisplayRefreshRateback to summary
public static float nDisplayRefreshRate(long struct)

Unsafe version of DisplayRefreshRate.

nFirmwareMajorback to summary
public static short nFirmwareMajor(long struct)

Unsafe version of FirmwareMajor.

nFirmwareMinorback to summary
public static short nFirmwareMinor(long struct)

Unsafe version of FirmwareMinor.

nManufacturerback to summary
public static ByteBuffer nManufacturer(long struct)

Unsafe version of Manufacturer.

nManufacturerStringback to summary
public static String nManufacturerString(long struct)

Unsafe version of ManufacturerString.

nMaxEyeFovback to summary
public static OVRFovPort.Buffer nMaxEyeFov(long struct)

Unsafe version of MaxEyeFov.

nMaxEyeFovback to summary
public static OVRFovPort nMaxEyeFov(long struct, int index)

Unsafe version of MaxEyeFov.

nProductIdback to summary
public static short nProductId(long struct)

Unsafe version of ProductId.

nProductNameback to summary
public static ByteBuffer nProductName(long struct)

Unsafe version of ProductName.

nProductNameStringback to summary
public static String nProductNameString(long struct)

Unsafe version of ProductNameString.

nResolutionback to summary
public static OVRSizei nResolution(long struct)

Unsafe version of Resolution.

nSerialNumberback to summary
public static ByteBuffer nSerialNumber(long struct)

Unsafe version of SerialNumber.

nSerialNumberStringback to summary
public static String nSerialNumberString(long struct)

Unsafe version of SerialNumberString.

nTypeback to summary
public static int nType(long struct)

Unsafe version of Type.

nVendorIdback to summary
public static short nVendorId(long struct)

Unsafe version of VendorId.

ProductIdback to summary
public short ProductId()

HID Product ID of the device

ProductNameback to summary
public ByteBuffer ProductName()

name string describing the product: "Oculus Rift DK1", etc.

Annotations
@NativeType:char[64]
ProductNameStringback to summary
public String ProductNameString()

name string describing the product: "Oculus Rift DK1", etc.

Annotations
@NativeType:char[64]
Resolutionback to summary
public OVRSizei Resolution()

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

Annotations
@NativeType:ovrSizei
SerialNumberback to summary
public ByteBuffer SerialNumber()

HMD serial number

Annotations
@NativeType:char[24]
SerialNumberStringback to summary
public String SerialNumberString()

HMD serial number

Annotations
@NativeType:char[24]
sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
Typeback to summary
public int Type()

this HMD's type. One of:

Hmd_NoneHmd_DK2Hmd_CBHmd_OtherHmd_E3_2015Hmd_ES06Hmd_ES09Hmd_ES11Hmd_CV1Hmd_RiftS
Hmd_QuestHmd_Quest2
Annotations
@NativeType:ovrHmdType
VendorIdback to summary
public short VendorId()

HID Vendor ID of the device