This website uses cookies to improve our services and deliver relevant ads.
By interacting with this site, you agree to this use. For more information, see our Cookies Policy

Enumerations

enum
ovrSuccessResult {
}
ovrResult isn't actually an enum type and the the success / failure types are not defined anywhere for GearVR VrApi.
enum
ovrErrorResult {
}
enum
ovrBooleanResult {
}
True or false.
enum
ovrEye {
}
One of the user's eyes.
enum
ovrStructureType {
}
Defines a layout for ovrInitParms, ovrModeParms, or ovrFrameParms.
enum
ovrDeviceType {
ovrDeviceType.VRAPI_DEVICE_TYPE_GEARVR_START = 0, ovrDeviceType.VRAPI_DEVICE_TYPE_NOTE4 = VRAPI_DEVICE_TYPE_GEARVR_START, ovrDeviceType.VRAPI_DEVICE_TYPE_NOTE5 = 1, ovrDeviceType.VRAPI_DEVICE_TYPE_S6 = 2, ovrDeviceType.VRAPI_DEVICE_TYPE_S7 = 3, ovrDeviceType.VRAPI_DEVICE_TYPE_NOTE7 = 4, ovrDeviceType.VRAPI_DEVICE_TYPE_S8 = 5, ovrDeviceType.VRAPI_DEVICE_TYPE_NOTE8 = 6, ovrDeviceType.VRAPI_DEVICE_TYPE_NOTE7_FE = 7, ovrDeviceType.VRAPI_DEVICE_TYPE_A5_2018 = 8, ovrDeviceType.VRAPI_DEVICE_TYPE_A7_2018 = 9, ovrDeviceType.VRAPI_DEVICE_TYPE_S9 = 10, ovrDeviceType.VRAPI_DEVICE_TYPE_S9_PLUS = 11, ovrDeviceType.VRAPI_DEVICE_TYPE_A8_STAR = 12, ovrDeviceType.VRAPI_DEVICE_TYPE_GEARVR_END = 63, ovrDeviceType.VRAPI_DEVICE_TYPE_OCULUSGO_START = 64, ovrDeviceType.VRAPI_DEVICE_TYPE_OCULUSGO = VRAPI_DEVICE_TYPE_OCULUSGO_START, ovrDeviceType.VRAPI_DEVICE_TYPE_MIVR_STANDALONE = VRAPI_DEVICE_TYPE_OCULUSGO_START + 1, ovrDeviceType.VRAPI_DEVICE_TYPE_OCULUSGO_END = 127, ovrDeviceType.VRAPI_DEVICE_TYPE_UNKNOWN = -1
}
A VR-capable device.
enum
ovrHeadsetType {
}
A headset, which typically includes optics and tracking hardware, but not necessarily the device itself.
enum
ovrDeviceRegion {
}
A geographic region authorized for certain hardware and content.
enum
ovrVideoDecoderLimit {
}
The maximum resolution and framerate supported by a video decoder.
enum
ovrSystemProperty {
ovrSystemProperty.VRAPI_SYS_PROP_DEVICE_TYPE = 0, ovrSystemProperty.VRAPI_SYS_PROP_MAX_FULLSPEED_FRAMEBUFFER_SAMPLES = 1, ovrSystemProperty.VRAPI_SYS_PROP_DISPLAY_PIXELS_WIDE = 2, ovrSystemProperty.VRAPI_SYS_PROP_DISPLAY_PIXELS_HIGH = 3, ovrSystemProperty.VRAPI_SYS_PROP_DISPLAY_REFRESH_RATE = 4, ovrSystemProperty.VRAPI_SYS_PROP_SUGGESTED_EYE_TEXTURE_WIDTH = 5, ovrSystemProperty.VRAPI_SYS_PROP_SUGGESTED_EYE_TEXTURE_HEIGHT = 6, ovrSystemProperty.VRAPI_SYS_PROP_SUGGESTED_EYE_FOV_DEGREES_X = 7, ovrSystemProperty.VRAPI_SYS_PROP_SUGGESTED_EYE_FOV_DEGREES_Y = 8, ovrSystemProperty.VRAPI_SYS_PROP_EXT_SDCARD_PATH = 9, ovrSystemProperty.VRAPI_SYS_PROP_DEVICE_REGION = 10, ovrSystemProperty.VRAPI_SYS_PROP_VIDEO_DECODER_LIMIT = 11, ovrSystemProperty.VRAPI_SYS_PROP_HEADSET_TYPE = 12, ovrSystemProperty.VRAPI_SYS_PROP_DOMINANT_HAND = 15, ovrSystemProperty.VRAPI_SYS_PROP_NUM_SUPPORTED_DISPLAY_REFRESH_RATES = 64, ovrSystemProperty.VRAPI_SYS_PROP_SUPPORTED_DISPLAY_REFRESH_RATES = 65, ovrSystemProperty.VRAPI_SYS_PROP_NUM_SUPPORTED_SWAPCHAIN_FORMATS = 66, ovrSystemProperty.VRAPI_SYS_PROP_SUPPORTED_SWAPCHAIN_FORMATS = 67, ovrSystemProperty.VRAPI_SYS_PROP_MULTIVIEW_AVAILABLE = 128, ovrSystemProperty.VRAPI_SYS_PROP_SRGB_LAYER_SOURCE_AVAILABLE = 129, ovrSystemProperty.VRAPI_SYS_PROP_FOVEATION_AVAILABLE = 130
}
System configuration properties.
enum
ovrProperty {
}
Configurable VrApi properties.
enum
ovrHandedness {
}
Specifies left or right handedness.
enum
ovrSystemStatus {
ovrSystemStatus.VRAPI_SYS_STATUS_DOCKED = 0, ovrSystemStatus.VRAPI_SYS_STATUS_MOUNTED = 1, ovrSystemStatus.VRAPI_SYS_STATUS_THROTTLED = 2, ovrSystemStatus.VRAPI_SYS_STATUS_RENDER_LATENCY_MILLISECONDS = 5, ovrSystemStatus.VRAPI_SYS_STATUS_TIMEWARP_LATENCY_MILLISECONDS = 6, ovrSystemStatus.VRAPI_SYS_STATUS_SCANOUT_LATENCY_MILLISECONDS = 7, ovrSystemStatus.VRAPI_SYS_STATUS_APP_FRAMES_PER_SECOND = 8, ovrSystemStatus.VRAPI_SYS_STATUS_SCREEN_TEARS_PER_SECOND = 9, ovrSystemStatus.VRAPI_SYS_STATUS_EARLY_FRAMES_PER_SECOND = 10, ovrSystemStatus.VRAPI_SYS_STATUS_STALE_FRAMES_PER_SECOND = 11, ovrSystemStatus.VRAPI_SYS_STATUS_RECENTER_COUNT = 13, ovrSystemStatus.VRAPI_SYS_STATUS_SYSTEM_UX_ACTIVE = 14, ovrSystemStatus.VRAPI_SYS_STATUS_FRONT_BUFFER_PROTECTED = 128, ovrSystemStatus.VRAPI_SYS_STATUS_FRONT_BUFFER_565 = 129, ovrSystemStatus.VRAPI_SYS_STATUS_FRONT_BUFFER_SRGB = 130
}
System status bits.
enum
ovrInitializeStatus {
}
Possible results of initialization.
enum
ovrGraphicsAPI {
ovrGraphicsAPI.VRAPI_GRAPHICS_API_TYPE_ES = 0x10000, ovrGraphicsAPI.VRAPI_GRAPHICS_API_OPENGL_ES_2 = ( VRAPI_GRAPHICS_API_TYPE_ES | 0x0200 ), ovrGraphicsAPI.VRAPI_GRAPHICS_API_OPENGL_ES_3 = ( VRAPI_GRAPHICS_API_TYPE_ES | 0x0300 ), ovrGraphicsAPI.VRAPI_GRAPHICS_API_TYPE_OPENGL = 0x20000, ovrGraphicsAPI.VRAPI_GRAPHICS_API_OPENGL_COMPAT = ( VRAPI_GRAPHICS_API_TYPE_OPENGL | 0x0100 ), ovrGraphicsAPI.VRAPI_GRAPHICS_API_OPENGL_CORE_3 = ( VRAPI_GRAPHICS_API_TYPE_OPENGL | 0x0300 ), ovrGraphicsAPI.VRAPI_GRAPHICS_API_OPENGL_CORE_4 = ( VRAPI_GRAPHICS_API_TYPE_OPENGL | 0x0400 ), ovrGraphicsAPI.VRAPI_GRAPHICS_API_TYPE_VULKAN = 0x40000, ovrGraphicsAPI.VRAPI_GRAPHICS_API_VULKAN_1 = ( VRAPI_GRAPHICS_API_TYPE_VULKAN | 0x0100 )
}
Supported graphics APIs.
enum
ovrModeFlags {
}
enum
ovrTrackingStatus {
}
Bit flags describing the current status of sensor tracking.
enum
ovrTrackingTransform {
}
Specifies a reference frame for motion tracking data.
enum
ovrTextureType {
}
A texture type, such as 2D, array, or cubemap.
enum
ovrTextureFormat {
}
A texture format.
enum
ovrDefaultTextureSwapChain {
}
Built-in convenience swapchains.
enum
ovrFrameFlags {
}
Per-frame configuration options.
enum
ovrFrameLayerFlags {
}
Per-frame configuration options that apply to a particular layer.
enum
ovrFrameLayerEye {
}
The user's eye (left or right) that can see a layer.
enum
ovrFrameLayerBlend {
}
Selects an operation for alpha blending two images.
enum
ovrFrameLayerType {
}
enum
ovrExtraLatencyMode {
}
Extra latency mode pipelines app CPU work a frame ahead of VR composition.
enum
@6 {
}
enum
ovrLayerType2 {
}
A layer type.
enum
ovrPerfThreadType {
}
Identifies a VR-related application thread.

Typedefs

const struct JNINativeInterface *
JNIEnv ( )
const struct JNIInvokeInterface *
JavaVM ( )
void *
jobject ( )
signed int
struct ovrMobile
VR context To allow multiple Android activities that live in the same address space to cooperatively use the VrApi, each activity needs to maintain its own separate contexts for a lot of the video related systems.
struct ovrTextureSwapChain

Functions

Enumeration Type Documentation

enum VrApi_Types.h.ovrSuccessResult
ovrResult isn't actually an enum type and the the success / failure types are not defined anywhere for GearVR VrApi.
Enumerator
ovrSuccess= 0
enum VrApi_Types.h.ovrErrorResult
Enumerator
ovrError_MemoryAllocationFailure= -1000
ovrError_NotInitialized= -1004
ovrError_InvalidParameter= -1005
ovrError_DeviceUnavailable= -1010
ovrError_InvalidOperation= -1015
ovrError_UnsupportedDeviceType= -1050
ovrError_NoDevice= -1051
ovrError_NotImplemented= -1052
ovrResult_EnumSize= 0x7fffffff
enum VrApi_Types.h.ovrBooleanResult
True or false.
Enumerator
VRAPI_FALSE= 0
VRAPI_TRUE= 1
enum VrApi_Types.h.ovrEye
One of the user's eyes.
Enumerator
VRAPI_EYE_LEFT= 0
VRAPI_EYE_RIGHT= 1
VRAPI_EYE_COUNT= 2
enum VrApi_Types.h.ovrStructureType
Defines a layout for ovrInitParms, ovrModeParms, or ovrFrameParms.
Enumerator
VRAPI_STRUCTURE_TYPE_INIT_PARMS= 1
VRAPI_STRUCTURE_TYPE_MODE_PARMS= 2
VRAPI_STRUCTURE_TYPE_FRAME_PARMS= 3
VRAPI_STRUCTURE_TYPE_MODE_PARMS_VULKAN= 5
enum VrApi_Types.h.ovrDeviceType
A VR-capable device.
Enumerator
VRAPI_DEVICE_TYPE_GEARVR_START= 0
VRAPI_DEVICE_TYPE_NOTE4= VRAPI_DEVICE_TYPE_GEARVR_START
VRAPI_DEVICE_TYPE_NOTE5= 1
VRAPI_DEVICE_TYPE_S6= 2
VRAPI_DEVICE_TYPE_S7= 3
VRAPI_DEVICE_TYPE_NOTE7= 4
VRAPI_DEVICE_TYPE_S8= 5
VRAPI_DEVICE_TYPE_NOTE8= 6
VRAPI_DEVICE_TYPE_NOTE7_FE= 7
VRAPI_DEVICE_TYPE_A5_2018= 8
VRAPI_DEVICE_TYPE_A7_2018= 9
VRAPI_DEVICE_TYPE_S9= 10
VRAPI_DEVICE_TYPE_S9_PLUS= 11
VRAPI_DEVICE_TYPE_A8_STAR= 12
VRAPI_DEVICE_TYPE_GEARVR_END= 63
VRAPI_DEVICE_TYPE_OCULUSGO_START= 64
VRAPI_DEVICE_TYPE_OCULUSGO= VRAPI_DEVICE_TYPE_OCULUSGO_START
VRAPI_DEVICE_TYPE_MIVR_STANDALONE= VRAPI_DEVICE_TYPE_OCULUSGO_START + 1
VRAPI_DEVICE_TYPE_OCULUSGO_END= 127
VRAPI_DEVICE_TYPE_UNKNOWN= -1
enum VrApi_Types.h.ovrHeadsetType
A headset, which typically includes optics and tracking hardware, but not necessarily the device itself.
Enumerator
VRAPI_HEADSET_TYPE_R320= 0
VRAPI_HEADSET_TYPE_R321= 1
VRAPI_HEADSET_TYPE_R322= 2
VRAPI_HEADSET_TYPE_R323= 3
VRAPI_HEADSET_TYPE_R324= 4
VRAPI_HEADSET_TYPE_R325= 5
VRAPI_HEADSET_TYPE_OCULUSGO= 64
VRAPI_HEADSET_TYPE_MIVR_STANDALONE= 65
VRAPI_HEADSET_TYPE_UNKNOWN= -1
enum VrApi_Types.h.ovrDeviceRegion
A geographic region authorized for certain hardware and content.
Enumerator
VRAPI_DEVICE_REGION_UNSPECIFIED= 0
VRAPI_DEVICE_REGION_JAPAN= 1
VRAPI_DEVICE_REGION_CHINA= 2
enum VrApi_Types.h.ovrVideoDecoderLimit
The maximum resolution and framerate supported by a video decoder.
Enumerator
VRAPI_VIDEO_DECODER_LIMIT_4K_30FPS= 0
VRAPI_VIDEO_DECODER_LIMIT_4K_60FPS= 1
enum VrApi_Types.h.ovrSystemProperty
System configuration properties.
Enumerator
VRAPI_SYS_PROP_DEVICE_TYPE= 0
VRAPI_SYS_PROP_MAX_FULLSPEED_FRAMEBUFFER_SAMPLES= 1
VRAPI_SYS_PROP_DISPLAY_PIXELS_WIDE
Physical width and height of the display in pixels.
VRAPI_SYS_PROP_DISPLAY_PIXELS_HIGH= 3
VRAPI_SYS_PROP_DISPLAY_REFRESH_RATE
Returns the refresh rate of the display in cycles per second.
VRAPI_SYS_PROP_SUGGESTED_EYE_TEXTURE_WIDTH
With a display resolution of 2560x1440, the pixels at the center of each eye cover about 0.06 degrees of visual arc.
VRAPI_SYS_PROP_SUGGESTED_EYE_TEXTURE_HEIGHT= 6
VRAPI_SYS_PROP_SUGGESTED_EYE_FOV_DEGREES_X
This is a product of the lens distortion and the screen size, but there is no truly correct answer.
VRAPI_SYS_PROP_SUGGESTED_EYE_FOV_DEGREES_Y= 8
VRAPI_SYS_PROP_EXT_SDCARD_PATH
Path to the external SD card.
VRAPI_SYS_PROP_DEVICE_REGION= 10
VRAPI_SYS_PROP_VIDEO_DECODER_LIMIT
Video decoder limit for the device.
VRAPI_SYS_PROP_HEADSET_TYPE= 12
VRAPI_SYS_PROP_DOMINANT_HAND
Returns an ovrHandedness enum indicating left or right hand.
VRAPI_SYS_PROP_NUM_SUPPORTED_DISPLAY_REFRESH_RATES
Returns the number of display refresh rates supported by the system.
VRAPI_SYS_PROP_SUPPORTED_DISPLAY_REFRESH_RATES
Returns an array of the supported display refresh rates.
VRAPI_SYS_PROP_NUM_SUPPORTED_SWAPCHAIN_FORMATS
Returns the number of swapchain texture formats supported by the system.
VRAPI_SYS_PROP_SUPPORTED_SWAPCHAIN_FORMATS
Returns an array of the supported swapchain formats.
VRAPI_SYS_PROP_MULTIVIEW_AVAILABLE
Returns VRAPI_TRUE if Multiview rendering support is available for this system, otherwise VRAPI_FALSE.
VRAPI_SYS_PROP_SRGB_LAYER_SOURCE_AVAILABLE
Returns VRAPI_TRUE if submission of SRGB Layers is supported for this system, otherwise VRAPI_FALSE.
VRAPI_SYS_PROP_FOVEATION_AVAILABLE
Returns VRAPI_TRUE if on-chip foveated rendering of swapchains is supported for this system, otherwise VRAPI_FALSE.
enum VrApi_Types.h.ovrProperty
Configurable VrApi properties.
Enumerator
VRAPI_FOVEATION_LEVEL= 15
VRAPI_REORIENT_HMD_ON_CONTROLLER_RECENTER= 17
VRAPI_LATCH_BACK_BUTTON_ENTIRE_FRAME= 18
VRAPI_BLOCK_REMOTE_BUTTONS_WHEN_NOT_EMULATING_HMT=19
VRAPI_EAT_NATIVE_GAMEPAD_EVENTS= 20
enum VrApi_Types.h.ovrHandedness
Specifies left or right handedness.
Enumerator
VRAPI_HAND_UNKNOWN= 0
VRAPI_HAND_LEFT= 1
VRAPI_HAND_RIGHT= 2
enum VrApi_Types.h.ovrSystemStatus
System status bits.
Enumerator
VRAPI_SYS_STATUS_DOCKED= 0
VRAPI_SYS_STATUS_MOUNTED= 1
VRAPI_SYS_STATUS_THROTTLED= 2
VRAPI_SYS_STATUS_RENDER_LATENCY_MILLISECONDS= 5
VRAPI_SYS_STATUS_TIMEWARP_LATENCY_MILLISECONDS= 6
VRAPI_SYS_STATUS_SCANOUT_LATENCY_MILLISECONDS= 7
VRAPI_SYS_STATUS_APP_FRAMES_PER_SECOND= 8
VRAPI_SYS_STATUS_SCREEN_TEARS_PER_SECOND= 9
VRAPI_SYS_STATUS_EARLY_FRAMES_PER_SECOND= 10
VRAPI_SYS_STATUS_STALE_FRAMES_PER_SECOND= 11
VRAPI_SYS_STATUS_RECENTER_COUNT= 13
VRAPI_SYS_STATUS_SYSTEM_UX_ACTIVE= 14
VRAPI_SYS_STATUS_FRONT_BUFFER_PROTECTED= 128
VRAPI_SYS_STATUS_FRONT_BUFFER_565= 129
VRAPI_SYS_STATUS_FRONT_BUFFER_SRGB= 130
enum VrApi_Types.h.ovrInitializeStatus
Possible results of initialization.
Enumerator
VRAPI_INITIALIZE_SUCCESS= 0
VRAPI_INITIALIZE_UNKNOWN_ERROR= -1
VRAPI_INITIALIZE_PERMISSIONS_ERROR= -2
VRAPI_INITIALIZE_ALREADY_INITIALIZED= -3
enum VrApi_Types.h.ovrGraphicsAPI
Supported graphics APIs.
Enumerator
VRAPI_GRAPHICS_API_TYPE_ES= 0x10000
VRAPI_GRAPHICS_API_OPENGL_ES_2= ( VRAPI_GRAPHICS_API_TYPE_ES | 0x0200 )
VRAPI_GRAPHICS_API_OPENGL_ES_3= ( VRAPI_GRAPHICS_API_TYPE_ES | 0x0300 )
VRAPI_GRAPHICS_API_TYPE_OPENGL= 0x20000
VRAPI_GRAPHICS_API_OPENGL_COMPAT= ( VRAPI_GRAPHICS_API_TYPE_OPENGL | 0x0100 )
VRAPI_GRAPHICS_API_OPENGL_CORE_3= ( VRAPI_GRAPHICS_API_TYPE_OPENGL | 0x0300 )
VRAPI_GRAPHICS_API_OPENGL_CORE_4= ( VRAPI_GRAPHICS_API_TYPE_OPENGL | 0x0400 )
VRAPI_GRAPHICS_API_TYPE_VULKAN= 0x40000
VRAPI_GRAPHICS_API_VULKAN_1= ( VRAPI_GRAPHICS_API_TYPE_VULKAN | 0x0100 )
enum VrApi_Types.h.ovrModeFlags
Enumerator
VRAPI_MODE_FLAG_ALLOW_POWER_SAVE
If set, warn and allow the app to continue at 30 FPS when throttling occurs.
VRAPI_MODE_FLAG_RESET_WINDOW_FULLSCREEN
When an application moves backwards on the activity stack, the activity window it returns to is no longer flagged as fullscreen.
VRAPI_MODE_FLAG_NATIVE_WINDOW
The WindowSurface passed in is an ANativeWindow.
VRAPI_MODE_FLAG_FRONT_BUFFER_PROTECTED
Create the front buffer in TrustZone memory to allow protected DRM content to be rendered to the front buffer.
VRAPI_MODE_FLAG_FRONT_BUFFER_565
Create a 16-bit 5:6:5 front buffer.
VRAPI_MODE_FLAG_FRONT_BUFFER_SRGB
Create a front buffer using the sRGB color space.
VRAPI_MODE_FLAG_CREATE_CONTEXT_NO_ERROR
If set, indicates the OpenGL ES Context was created with EGL_CONTEXT_OPENGL_NO_ERROR_KHR attribute.
enum VrApi_Types.h.ovrTrackingStatus
Bit flags describing the current status of sensor tracking.
Enumerator
VRAPI_TRACKING_STATUS_ORIENTATION_TRACKED= 1 << 0
VRAPI_TRACKING_STATUS_POSITION_TRACKED= 1 << 1
VRAPI_TRACKING_STATUS_HMD_CONNECTED= 1 << 7
enum VrApi_Types.h.ovrTrackingTransform
Specifies a reference frame for motion tracking data.
Enumerator
VRAPI_TRACKING_TRANSFORM_IDENTITY= 0
VRAPI_TRACKING_TRANSFORM_CURRENT= 1
VRAPI_TRACKING_TRANSFORM_SYSTEM_CENTER_EYE_LEVEL= 2
VRAPI_TRACKING_TRANSFORM_SYSTEM_CENTER_FLOOR_LEVEL= 3
enum VrApi_Types.h.ovrTextureType
A texture type, such as 2D, array, or cubemap.
Enumerator
VRAPI_TEXTURE_TYPE_2D= 0
VRAPI_TEXTURE_TYPE_2D_ARRAY= 2
VRAPI_TEXTURE_TYPE_CUBE= 3
VRAPI_TEXTURE_TYPE_MAX= 4
enum VrApi_Types.h.ovrTextureFormat
A texture format.
Enumerator
VRAPI_TEXTURE_FORMAT_NONE= 0
VRAPI_TEXTURE_FORMAT_565= 1
VRAPI_TEXTURE_FORMAT_5551= 2
VRAPI_TEXTURE_FORMAT_4444= 3
VRAPI_TEXTURE_FORMAT_8888= 4
VRAPI_TEXTURE_FORMAT_8888_sRGB= 5
VRAPI_TEXTURE_FORMAT_RGBA16F= 6
VRAPI_TEXTURE_FORMAT_DEPTH_16= 7
VRAPI_TEXTURE_FORMAT_DEPTH_24= 8
VRAPI_TEXTURE_FORMAT_DEPTH_24_STENCIL_8= 9
enum VrApi_Types.h.ovrDefaultTextureSwapChain
Built-in convenience swapchains.
Enumerator
VRAPI_DEFAULT_TEXTURE_SWAPCHAIN= 0x1
VRAPI_DEFAULT_TEXTURE_SWAPCHAIN_LOADING_ICON= 0x2
enum VrApi_Types.h.ovrFrameFlags
Per-frame configuration options.
Enumerator
VRAPI_FRAME_FLAG_FLUSH
Flush the warp swap pipeline so the images show up immediately.
VRAPI_FRAME_FLAG_FINAL
This is the final frame. Do not accept any more frames after this.
VRAPI_FRAME_FLAG_INHIBIT_VOLUME_LAYER
enum 1 << 3 used to be VRAPI_FRAME_FLAG_TIMEWARP_DEBUG_GRAPH_SHOW.
enum VrApi_Types.h.ovrFrameLayerFlags
Per-frame configuration options that apply to a particular layer.
Enumerator
VRAPI_FRAME_LAYER_FLAG_CHROMATIC_ABERRATION_CORRECTION
enum 1 << 0 used to be VRAPI_FRAME_LAYER_FLAG_WRITE_ALPHA.
VRAPI_FRAME_LAYER_FLAG_FIXED_TO_VIEW
Used for some HUDs, but generally considered bad practice.
VRAPI_FRAME_LAYER_FLAG_SPIN
Spin the layer - for loading icons.
VRAPI_FRAME_LAYER_FLAG_CLIP_TO_TEXTURE_RECT
Clip fragments outside the layer's TextureRect.
VRAPI_FRAME_LAYER_FLAG_INHIBIT_SRGB_FRAMEBUFFER
To get gamma correct sRGB filtering of the eye textures, the textures must be allocated with GL_SRGB8_ALPHA8 format and the window surface must be allocated with these attributes: EGL_GL_COLORSPACE_KHR, EGL_GL_COLORSPACE_SRGB_KHR.
enum VrApi_Types.h.ovrFrameLayerEye
The user's eye (left or right) that can see a layer.
Enumerator
VRAPI_FRAME_LAYER_EYE_LEFT= 0
VRAPI_FRAME_LAYER_EYE_RIGHT= 1
VRAPI_FRAME_LAYER_EYE_MAX= 2
enum VrApi_Types.h.ovrFrameLayerBlend
Selects an operation for alpha blending two images.
Enumerator
VRAPI_FRAME_LAYER_BLEND_ZERO= 0
VRAPI_FRAME_LAYER_BLEND_ONE= 1
VRAPI_FRAME_LAYER_BLEND_SRC_ALPHA= 2
VRAPI_FRAME_LAYER_BLEND_ONE_MINUS_SRC_ALPHA
enum 3 used to be VRAPI_FRAME_LAYER_BLEND_DST_ALPHA.
enum VrApi_Types.h.ovrFrameLayerType
Enumerator
VRAPI_FRAME_LAYER_TYPE_MAX= 4
enum VrApi_Types.h.ovrExtraLatencyMode
Extra latency mode pipelines app CPU work a frame ahead of VR composition.
Enumerator
VRAPI_EXTRA_LATENCY_MODE_OFF= 0
VRAPI_EXTRA_LATENCY_MODE_ON= 1
VRAPI_EXTRA_LATENCY_MODE_DYNAMIC= 2
enum VrApi_Types.h.@6
Enumerator
ovrMaxLayerCount= 16
enum VrApi_Types.h.ovrLayerType2
A layer type.
Enumerator
VRAPI_LAYER_TYPE_PROJECTION2= 1
VRAPI_LAYER_TYPE_CYLINDER2= 3
VRAPI_LAYER_TYPE_CUBE2= 4
VRAPI_LAYER_TYPE_EQUIRECT2= 5
VRAPI_LAYER_TYPE_LOADING_ICON2= 6
enum VrApi_Types.h.ovrPerfThreadType
Identifies a VR-related application thread.
Enumerator
VRAPI_PERF_THREAD_TYPE_MAIN= 0
VRAPI_PERF_THREAD_TYPE_RENDERER= 1

Typedef Documentation

typedef const struct JNINativeInterface* JNIEnv ( )
typedef const struct JNIInvokeInterface* JavaVM ( )
typedef void* jobject ( )
typedef signed int ovrResult ( )
typedef struct ovrMobile ovrMobile ( )
VR context To allow multiple Android activities that live in the same address space to cooperatively use the VrApi, each activity needs to maintain its own separate contexts for a lot of the video related systems.
typedef struct ovrTextureSwapChain ovrTextureSwapChain ( )

Function Documentation

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrJava , 12 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrJava , 24 )
OVR_VRAPI_ASSERT_TYPE_SIZE ( ovrVector2f , 8 )
OVR_VRAPI_ASSERT_TYPE_SIZE ( ovrVector3f , 12 )
OVR_VRAPI_ASSERT_TYPE_SIZE ( ovrVector4f , 16 )
OVR_VRAPI_ASSERT_TYPE_SIZE ( ovrQuatf , 16 )
OVR_VRAPI_ASSERT_TYPE_SIZE ( ovrMatrix4f , 64 )
OVR_VRAPI_ASSERT_TYPE_SIZE ( ovrPosef , 28 )
OVR_VRAPI_ASSERT_TYPE_SIZE ( ovrRectf , 16 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrInitParms , 36 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrInitParms , 48 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrModeParms , 48 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrModeParms , 56 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrModeParmsVulkan , 56 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrModeParmsVulkan , 64 )
OVR_VRAPI_ASSERT_TYPE_SIZE ( ovrRigidBodyPosef , 96 )
OVR_VRAPI_ASSERT_TYPE_SIZE ( ovrTracking2 , 360 )
OVR_VRAPI_ASSERT_TYPE_SIZE ( ovrTracking , 104 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrFrameLayerTexture , 200 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrFrameLayerTexture , 208 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrFrameLayer , 432 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrFrameLayer , 448 )
OVR_VRAPI_ASSERT_TYPE_SIZE ( ovrPerformanceParms , 16 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrFrameParms , 1856 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrFrameParms , 1936 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrLayerHeader2 , 36 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrLayerHeader2 , 40 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrLayerProjection2 , 312 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrLayerProjection2 , 328 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrLayerCylinder2 , 440 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrLayerCylinder2 , 456 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrLayerCube2 , 232 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrLayerCube2 , 248 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrLayerEquirect2 , 376 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrLayerEquirect2 , 392 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrLayerLoadingIcon2 , 52 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrLayerLoadingIcon2 , 64 )
OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT ( ovrSubmitFrameDescription2 , 40 )
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT ( ovrSubmitFrameDescription2 , 48 )
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
79
80
81
82
83
84
85
87
88
89
90
91
92
93
95
96
97
98
99
100
101
103
104
105
106
107
108
109
111
112
113
114
115
116
117
119
120
121
122
123
124
125
126
128
129
130
131
132
133
134
135
136
137
139
140
141
142
143
144
146
147
148
149
150
151
152
153
154
155
156
158
159
160
161
162
163
164
165
166
167
168
169
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
221
222
223
224
225
226
227
229
230
231
232
233
234
236
237
238
239
241
242
244
253
254
266
267
272
273
275
276
277
278
279
280
282
283
285
287
288
290
294
295
298
301
302
305
306
307
309
310
311
312
313
314
315
316
317
318
320
321
322
323
324
325
326
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
362
363
364
365
366
367
368
369
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
407
408
411
412
423
424
426
427
432
433
435
436
438
439
444
445
446
448
449
450
451
453
454
460
461
462
463
466
467
471
472
475
476
477
478
479
480
482
483
484
485
489
490
491
492
493
494
499
500
501
502
503
504
506
507
508
509
510
511
512
513
514
515
516
517
518
519
521
522
523
524
525
526
527
529
530
532
533
534
535
538
539
540
541
542
543
544
545
546
547
549
550
552
553
554
555
558
559
560
561
562
564
565
566
567
568
569
570
571
572
573
574
575
576
578
579
580
581
582
583
584
585
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
604
605
606
607
608
609
610
611
612
613
614
615
617
618
619
620
621
625
627
628
630
632
634
636
637
639
641
642
643
644
646
647
649
651
653
655
657
658
673
674
675
676
677
679
680
681
682
683
684
685
687
688
689
690
691
694
695
696
698
699
700
701
702
704
705
706
707
708
709
710
711
712
713
714
717
718
723
724
726
727
729
730
735
736
739
740
741
742
748
749
752
753
754
755
756
757
759
760
762
763
765
766
767
769
770
772
773
775
776
777
779
780
781
782
783
784
786
787
789
790
791
793
794
795
796
797
798
800
801
802
803
804
805
807
808
809
811
812
816
817
822
823
825
826
835
836
840
841
843
844
846
847
848
849
850
851
852
853
854
855
856
857
858
859
861
862
863
864
865
866
867
868
869
871
872
873
874
875
876
877
878
879
883
884
885
886
887
888
890
891
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
925
926
928
929
930
931
932
933
935
936
937
938
945
946
947
948
949
950
951
979
980
982
983
984
985
986
987
988
989
990
992
993
994
995
996
997
998
999
1016
1017
1019
1020
1021
1022
1023
1024
1025
1027
1028
1029
1036
1037
1038
1039
1040
1041
1042
1045
1046
1048
1049
1050
1051
1052
1054
1055
1056
1057
1058
1059
1060
1061
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1094
1095
1096
1097
1098
1099
1100
/************************************************************************************

Filename    :   VrApi_Types.h
Content     :   Types for minimum necessary API for mobile VR
Created     :   April 30, 2015
Authors     :   J.M.P. van Waveren
Language    :   C99

Copyright   :   Copyright 2015 Oculus VR, LLC. All Rights reserved.

*************************************************************************************/
#ifndef OVR_VrApi_Types_h
#define OVR_VrApi_Types_h

#include <stdbool.h>
#include <stdint.h>
#include "VrApi_Config.h"// needed for VRAPI_EXPORT

//-----------------------------------------------------------------
// Java
//-----------------------------------------------------------------

#if defined( ANDROID )
#include <jni.h>
#elif defined( __cplusplus )
typedefstruct _JNIEnv JNIEnv;
typedefstruct _JavaVM JavaVM;
typedefclass _jobject * jobject;
#else
typedefconststruct JNINativeInterface * JNIEnv;
typedefconststruct JNIInvokeInterface * JavaVM;
typedefvoid * jobject;
#endif

typedefstruct
{
    JavaVM *    Vm;                 //< Java Virtual Machine
    JNIEnv *    Env;                //< Thread specific environment
    jobject     ActivityObject;     //< Java activity object
} ovrJava;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrJava, 12 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrJava, 24 );

//-----------------------------------------------------------------
// Basic Types
//-----------------------------------------------------------------

typedefsignedint ovrResult;

typedefenum ovrSuccessResult_
{
    ovrSuccess                      = 0,
} ovrSuccessResult;

typedefenum ovrErrorResult_
{
    ovrError_MemoryAllocationFailure    = -1000,
    ovrError_NotInitialized             = -1004,
    ovrError_InvalidParameter           = -1005,
    ovrError_DeviceUnavailable          = -1010,    //< device is not connected, or not connected as input device
    ovrError_InvalidOperation           = -1015,

// enums not in CAPI
    ovrError_UnsupportedDeviceType      = -1050,    //< specified device type isn't supported on GearVR
    ovrError_NoDevice                   = -1051,    //< specified device ID does not map to any current device
    ovrError_NotImplemented             = -1052,    //< executed an incomplete code path - this should not be possible in public releases.

    ovrResult_EnumSize                  = 0x7fffffff
} ovrErrorResult;

typedefstruct ovrVector2f_
{
float x, y;
} ovrVector2f;

OVR_VRAPI_ASSERT_TYPE_SIZE( ovrVector2f, 8 );

typedefstruct ovrVector3f_
{
float x, y, z;
} ovrVector3f;

OVR_VRAPI_ASSERT_TYPE_SIZE( ovrVector3f, 12 );

typedefstruct ovrVector4f_
{
float x, y, z, w;
} ovrVector4f;

OVR_VRAPI_ASSERT_TYPE_SIZE( ovrVector4f, 16 );

typedefstruct ovrQuatf_
{
float x, y, z, w;
} ovrQuatf;

OVR_VRAPI_ASSERT_TYPE_SIZE( ovrQuatf, 16 );

typedefstruct ovrMatrix4f_
{
float M[4][4];
} ovrMatrix4f;

OVR_VRAPI_ASSERT_TYPE_SIZE( ovrMatrix4f, 64 );

typedefstruct ovrPosef_
{
    ovrQuatf    Orientation;
    ovrVector3f Position;
} ovrPosef;

OVR_VRAPI_ASSERT_TYPE_SIZE( ovrPosef, 28 );

typedefstruct ovrRectf_
{
float x;
float y;
float width;
float height;
} ovrRectf;

OVR_VRAPI_ASSERT_TYPE_SIZE( ovrRectf, 16 );

typedefenum
{
    VRAPI_FALSE = 0,
    VRAPI_TRUE  = 1
} ovrBooleanResult;

typedefenum
{
    VRAPI_EYE_LEFT  = 0,
    VRAPI_EYE_RIGHT = 1,
    VRAPI_EYE_COUNT = 2
} ovrEye;

//-----------------------------------------------------------------
// Structure Types
//-----------------------------------------------------------------

typedefenum
{
    VRAPI_STRUCTURE_TYPE_INIT_PARMS         = 1,
    VRAPI_STRUCTURE_TYPE_MODE_PARMS         = 2,
    VRAPI_STRUCTURE_TYPE_FRAME_PARMS        = 3,
    VRAPI_STRUCTURE_TYPE_MODE_PARMS_VULKAN  = 5,
} ovrStructureType;

//-----------------------------------------------------------------
// System Properties and Status
//-----------------------------------------------------------------

typedefenum
{
    VRAPI_DEVICE_TYPE_GEARVR_START          = 0,

    VRAPI_DEVICE_TYPE_NOTE4                 = VRAPI_DEVICE_TYPE_GEARVR_START,
    VRAPI_DEVICE_TYPE_NOTE5                 = 1,
    VRAPI_DEVICE_TYPE_S6                    = 2,
    VRAPI_DEVICE_TYPE_S7                    = 3,
    VRAPI_DEVICE_TYPE_NOTE7                 = 4,            //< No longer supported.
    VRAPI_DEVICE_TYPE_S8                    = 5,
    VRAPI_DEVICE_TYPE_NOTE8                 = 6,
    VRAPI_DEVICE_TYPE_NOTE7_FE              = 7,            //< Fan Edition
    VRAPI_DEVICE_TYPE_A5_2018               = 8,            //< A8
    VRAPI_DEVICE_TYPE_A7_2018               = 9,            //< A8 Plus
    VRAPI_DEVICE_TYPE_S9                    = 10,
    VRAPI_DEVICE_TYPE_S9_PLUS               = 11,
    VRAPI_DEVICE_TYPE_A8_STAR               = 12,           //< A8 Star

    VRAPI_DEVICE_TYPE_GEARVR_END            = 63,

// Standalone Devices
    VRAPI_DEVICE_TYPE_OCULUSGO_START        = 64,
    VRAPI_DEVICE_TYPE_OCULUSGO              = VRAPI_DEVICE_TYPE_OCULUSGO_START,
    VRAPI_DEVICE_TYPE_MIVR_STANDALONE       = VRAPI_DEVICE_TYPE_OCULUSGO_START + 1, //< China-only SKU
    VRAPI_DEVICE_TYPE_OCULUSGO_END          = 127,


    VRAPI_DEVICE_TYPE_UNKNOWN               = -1,
} ovrDeviceType;

typedefenum
{
    VRAPI_HEADSET_TYPE_R320                 = 0,            //< Note4 Innovator
    VRAPI_HEADSET_TYPE_R321                 = 1,            //< S6 Innovator
    VRAPI_HEADSET_TYPE_R322                 = 2,            //< Commercial 1
    VRAPI_HEADSET_TYPE_R323                 = 3,            //< Commercial 2 (USB Type C)
    VRAPI_HEADSET_TYPE_R324                 = 4,            //< Commercial 3 (USB Type C)
    VRAPI_HEADSET_TYPE_R325                 = 5,            //< Commercial 4 2017 (USB Type C)

// Standalone Headsets
    VRAPI_HEADSET_TYPE_OCULUSGO             = 64,           //< Oculus Go
    VRAPI_HEADSET_TYPE_MIVR_STANDALONE      = 65,           //< China-only SKU


    VRAPI_HEADSET_TYPE_UNKNOWN              = -1,
} ovrHeadsetType;


typedefenum
{
    VRAPI_DEVICE_REGION_UNSPECIFIED = 0,
    VRAPI_DEVICE_REGION_JAPAN       = 1,
    VRAPI_DEVICE_REGION_CHINA       = 2,
} ovrDeviceRegion;

typedefenum
{
    VRAPI_VIDEO_DECODER_LIMIT_4K_30FPS  = 0,
    VRAPI_VIDEO_DECODER_LIMIT_4K_60FPS  = 1,
} ovrVideoDecoderLimit;

typedefenum
{
    VRAPI_SYS_PROP_DEVICE_TYPE                              = 0,
    VRAPI_SYS_PROP_MAX_FULLSPEED_FRAMEBUFFER_SAMPLES        = 1,
    VRAPI_SYS_PROP_DISPLAY_PIXELS_WIDE                      = 2,
    VRAPI_SYS_PROP_DISPLAY_PIXELS_HIGH                      = 3,
    VRAPI_SYS_PROP_DISPLAY_REFRESH_RATE                     = 4,
    VRAPI_SYS_PROP_SUGGESTED_EYE_TEXTURE_WIDTH              = 5,
    VRAPI_SYS_PROP_SUGGESTED_EYE_TEXTURE_HEIGHT             = 6,
    VRAPI_SYS_PROP_SUGGESTED_EYE_FOV_DEGREES_X              = 7,
    VRAPI_SYS_PROP_SUGGESTED_EYE_FOV_DEGREES_Y              = 8,
    VRAPI_SYS_PROP_EXT_SDCARD_PATH                          = 9,
    VRAPI_SYS_PROP_DEVICE_REGION                            = 10,
    VRAPI_SYS_PROP_VIDEO_DECODER_LIMIT                      = 11,
    VRAPI_SYS_PROP_HEADSET_TYPE                             = 12,

// enum 13 used to be VRAPI_SYS_PROP_BACK_BUTTON_SHORTPRESS_TIME
// enum 14 used to be VRAPI_SYS_PROP_BACK_BUTTON_DOUBLETAP_TIME

    VRAPI_SYS_PROP_DOMINANT_HAND                            = 15,

    VRAPI_SYS_PROP_NUM_SUPPORTED_DISPLAY_REFRESH_RATES      = 64,
    VRAPI_SYS_PROP_SUPPORTED_DISPLAY_REFRESH_RATES          = 65,

    VRAPI_SYS_PROP_NUM_SUPPORTED_SWAPCHAIN_FORMATS          = 66,
    VRAPI_SYS_PROP_SUPPORTED_SWAPCHAIN_FORMATS              = 67,

    VRAPI_SYS_PROP_MULTIVIEW_AVAILABLE                      = 128,
    VRAPI_SYS_PROP_SRGB_LAYER_SOURCE_AVAILABLE              = 129,

    VRAPI_SYS_PROP_FOVEATION_AVAILABLE                      = 130,
} ovrSystemProperty;

typedefenum
{
    VRAPI_FOVEATION_LEVEL               = 15,       //< Used by apps that want to control swapchain foveation levels
    VRAPI_REORIENT_HMD_ON_CONTROLLER_RECENTER   = 17,       //< Used to determine if a controller recenter should also reorient the headset.
    VRAPI_LATCH_BACK_BUTTON_ENTIRE_FRAME        = 18,       //< Used to determine if the 'short press' back button should lasts an entire frame.
    VRAPI_BLOCK_REMOTE_BUTTONS_WHEN_NOT_EMULATING_HMT   =19,    // < Used to not send the remote back button java events to the apps >
    VRAPI_EAT_NATIVE_GAMEPAD_EVENTS     = 20,       //< Used to tell the runtime not to eat gamepad events.  If this is false on a native app, the app must be listening for the events.
} ovrProperty;


typedefenum
{
    VRAPI_HAND_UNKNOWN  = 0,
    VRAPI_HAND_LEFT     = 1,
    VRAPI_HAND_RIGHT    = 2
} ovrHandedness;

typedefenum
{
    VRAPI_SYS_STATUS_DOCKED                         = 0,    //< Device is docked.
    VRAPI_SYS_STATUS_MOUNTED                        = 1,    //< Device is mounted.
    VRAPI_SYS_STATUS_THROTTLED                      = 2,    //< Device is in powersave mode.

// enum  3 used to be VRAPI_SYS_STATUS_THROTTLED2.

// enum  4 used to be VRAPI_SYS_STATUS_THROTTLED_WARNING_LEVEL.

    VRAPI_SYS_STATUS_RENDER_LATENCY_MILLISECONDS    = 5,    //< Average time between render tracking sample and scanout.
    VRAPI_SYS_STATUS_TIMEWARP_LATENCY_MILLISECONDS  = 6,    //< Average time between timewarp tracking sample and scanout.
    VRAPI_SYS_STATUS_SCANOUT_LATENCY_MILLISECONDS   = 7,    //< Average time between Vsync and scanout.
    VRAPI_SYS_STATUS_APP_FRAMES_PER_SECOND          = 8,    //< Number of frames per second delivered through vrapi_SubmitFrame.
    VRAPI_SYS_STATUS_SCREEN_TEARS_PER_SECOND        = 9,    //< Number of screen tears per second (per eye).
    VRAPI_SYS_STATUS_EARLY_FRAMES_PER_SECOND        = 10,   //< Number of frames per second delivered a whole display refresh early.
    VRAPI_SYS_STATUS_STALE_FRAMES_PER_SECOND        = 11,   //< Number of frames per second delivered late.

// enum 12 used to be VRAPI_SYS_STATUS_HEADPHONES_PLUGGED_IN

    VRAPI_SYS_STATUS_RECENTER_COUNT                 = 13,   //< Returns the current HMD recenter count. Defaults to 0.
    VRAPI_SYS_STATUS_SYSTEM_UX_ACTIVE               = 14,   //< Returns VRAPI_TRUE if a system UX layer is active

    VRAPI_SYS_STATUS_FRONT_BUFFER_PROTECTED         = 128,  //< VRAPI_TRUE if the front buffer is allocated in TrustZone memory.
    VRAPI_SYS_STATUS_FRONT_BUFFER_565               = 129,  //< VRAPI_TRUE if the front buffer is 16-bit 5:6:5
    VRAPI_SYS_STATUS_FRONT_BUFFER_SRGB              = 130,  //< VRAPI_TRUE if the front buffer uses the sRGB color space.

} ovrSystemStatus;

//-----------------------------------------------------------------
// Initialization
//-----------------------------------------------------------------

typedefenum
{
    VRAPI_INITIALIZE_SUCCESS                =  0,
    VRAPI_INITIALIZE_UNKNOWN_ERROR          = -1,
    VRAPI_INITIALIZE_PERMISSIONS_ERROR      = -2,
    VRAPI_INITIALIZE_ALREADY_INITIALIZED    = -3
} ovrInitializeStatus;

typedefenum
{
    VRAPI_GRAPHICS_API_TYPE_ES       = 0x10000,
    VRAPI_GRAPHICS_API_OPENGL_ES_2   = ( VRAPI_GRAPHICS_API_TYPE_ES | 0x0200 ),     //< OpenGL ES 2.x context
    VRAPI_GRAPHICS_API_OPENGL_ES_3   = ( VRAPI_GRAPHICS_API_TYPE_ES | 0x0300 ),     //< OpenGL ES 3.x context

    VRAPI_GRAPHICS_API_TYPE_OPENGL   = 0x20000,
    VRAPI_GRAPHICS_API_OPENGL_COMPAT = ( VRAPI_GRAPHICS_API_TYPE_OPENGL | 0x0100 ), //< OpenGL Compatibility Profile
    VRAPI_GRAPHICS_API_OPENGL_CORE_3 = ( VRAPI_GRAPHICS_API_TYPE_OPENGL | 0x0300 ), //< OpenGL Core Profile 3.x
    VRAPI_GRAPHICS_API_OPENGL_CORE_4 = ( VRAPI_GRAPHICS_API_TYPE_OPENGL | 0x0400 ), //< OpenGL Core Profile 4.x

    VRAPI_GRAPHICS_API_TYPE_VULKAN   = 0x40000,
    VRAPI_GRAPHICS_API_VULKAN_1      = ( VRAPI_GRAPHICS_API_TYPE_VULKAN | 0x0100 ), //< Vulkan 1.x
} ovrGraphicsAPI;

typedefstruct
{
    ovrStructureType    Type;
int                 ProductVersion;
int                 MajorVersion;
int                 MinorVersion;
int                 PatchVersion;
    ovrGraphicsAPI      GraphicsAPI;
    ovrJava             Java;
} ovrInitParms;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrInitParms, 36 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrInitParms, 48 );


//-----------------------------------------------------------------
// VR Mode
//-----------------------------------------------------------------

typedefenum
{
    VRAPI_MODE_FLAG_ALLOW_POWER_SAVE            = 0x000000FF,

    VRAPI_MODE_FLAG_RESET_WINDOW_FULLSCREEN     = 0x0000FF00,

    VRAPI_MODE_FLAG_NATIVE_WINDOW               = 0x00010000,

    VRAPI_MODE_FLAG_FRONT_BUFFER_PROTECTED      = 0x00020000,

    VRAPI_MODE_FLAG_FRONT_BUFFER_565            = 0x00040000,

    VRAPI_MODE_FLAG_FRONT_BUFFER_SRGB           = 0x00080000,

    VRAPI_MODE_FLAG_CREATE_CONTEXT_NO_ERROR     = 0x00100000
} ovrModeFlags;

typedefstruct
{
    ovrStructureType    Type;

unsignedint        Flags;

    ovrJava             Java;

    OVR_VRAPI_PADDING_32_BIT( 4 );

unsignedlonglong  Display;

unsignedlonglong  WindowSurface;

unsignedlonglong  ShareContext;
} ovrModeParms;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrModeParms, 48 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrModeParms, 56 );

typedefstruct
{
    ovrModeParms        ModeParms;

unsignedlonglong  SynchronizationQueue;
} ovrModeParmsVulkan;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrModeParmsVulkan, 56 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrModeParmsVulkan, 64 );

typedefstruct ovrMobile ovrMobile;

//-----------------------------------------------------------------
// Tracking
//-----------------------------------------------------------------

typedefstruct ovrRigidBodyPosef_
{
    ovrPosef        Pose;
    ovrVector3f     AngularVelocity;
    ovrVector3f     LinearVelocity;
    ovrVector3f     AngularAcceleration;
    ovrVector3f     LinearAcceleration;
    OVR_VRAPI_PADDING( 4 );
double          TimeInSeconds;          //< Absolute time of this pose.
double          PredictionInSeconds;    //< Seconds this pose was predicted ahead.
} ovrRigidBodyPosef;

OVR_VRAPI_ASSERT_TYPE_SIZE( ovrRigidBodyPosef, 96 );

typedefenum
{
    VRAPI_TRACKING_STATUS_ORIENTATION_TRACKED   = 1 << 0,   //< Orientation is currently tracked.
    VRAPI_TRACKING_STATUS_POSITION_TRACKED      = 1 << 1,   //< Position is currently tracked.
    VRAPI_TRACKING_STATUS_HMD_CONNECTED         = 1 << 7    //< HMD is available & connected.
} ovrTrackingStatus;

typedefstruct ovrTracking2_
{
unsignedint        Status;

    OVR_VRAPI_PADDING( 4 );

    ovrRigidBodyPosef   HeadPose;
struct
    {
        ovrMatrix4f         ProjectionMatrix;
        ovrMatrix4f         ViewMatrix;
    } Eye[ VRAPI_EYE_COUNT ];
} ovrTracking2;

OVR_VRAPI_ASSERT_TYPE_SIZE( ovrTracking2, 360 );

typedefstruct ovrTracking_
{
unsignedint        Status;

    OVR_VRAPI_PADDING( 4 );

    ovrRigidBodyPosef   HeadPose;
} ovrTracking;

OVR_VRAPI_ASSERT_TYPE_SIZE( ovrTracking, 104 );

typedefenum
{
    VRAPI_TRACKING_TRANSFORM_IDENTITY                   = 0,
    VRAPI_TRACKING_TRANSFORM_CURRENT                    = 1,
    VRAPI_TRACKING_TRANSFORM_SYSTEM_CENTER_EYE_LEVEL    = 2,
    VRAPI_TRACKING_TRANSFORM_SYSTEM_CENTER_FLOOR_LEVEL  = 3,
} ovrTrackingTransform;


//-----------------------------------------------------------------
// Texture Swap Chain
//-----------------------------------------------------------------

typedefenum
{
    VRAPI_TEXTURE_TYPE_2D           = 0,    //< 2D textures.
    VRAPI_TEXTURE_TYPE_2D_ARRAY     = 2,    //< Texture array.
    VRAPI_TEXTURE_TYPE_CUBE         = 3,    //< Cube maps.
    VRAPI_TEXTURE_TYPE_MAX          = 4,
} ovrTextureType;

typedefenum
{
    VRAPI_TEXTURE_FORMAT_NONE               = 0,
    VRAPI_TEXTURE_FORMAT_565                = 1,
    VRAPI_TEXTURE_FORMAT_5551               = 2,
    VRAPI_TEXTURE_FORMAT_4444               = 3,
    VRAPI_TEXTURE_FORMAT_8888               = 4,
    VRAPI_TEXTURE_FORMAT_8888_sRGB          = 5,
    VRAPI_TEXTURE_FORMAT_RGBA16F            = 6,
    VRAPI_TEXTURE_FORMAT_DEPTH_16           = 7,
    VRAPI_TEXTURE_FORMAT_DEPTH_24           = 8,
    VRAPI_TEXTURE_FORMAT_DEPTH_24_STENCIL_8 = 9,

} ovrTextureFormat;

typedefenum
{
    VRAPI_DEFAULT_TEXTURE_SWAPCHAIN                 = 0x1,
    VRAPI_DEFAULT_TEXTURE_SWAPCHAIN_LOADING_ICON    = 0x2
} ovrDefaultTextureSwapChain;

typedefstruct ovrTextureSwapChain ovrTextureSwapChain;

//-----------------------------------------------------------------
// Frame Submission
//-----------------------------------------------------------------

typedefenum
{
// enum 1 << 0 used to be VRAPI_FRAME_FLAG_INHIBIT_SRGB_FRAMEBUFFER. See per-layer
// flag VRAPI_FRAME_LAYER_FLAG_INHIBIT_SRGB_FRAMEBUFFER.

    VRAPI_FRAME_FLAG_FLUSH                                                      = 1 << 1,
    VRAPI_FRAME_FLAG_FINAL                                                      = 1 << 2,




    VRAPI_FRAME_FLAG_INHIBIT_VOLUME_LAYER                                       = 1 << 6,




} ovrFrameFlags;

typedefenum
{

    VRAPI_FRAME_LAYER_FLAG_CHROMATIC_ABERRATION_CORRECTION                      = 1 << 1,
    VRAPI_FRAME_LAYER_FLAG_FIXED_TO_VIEW                                        = 1 << 2,
    VRAPI_FRAME_LAYER_FLAG_SPIN                                                 = 1 << 3,
    VRAPI_FRAME_LAYER_FLAG_CLIP_TO_TEXTURE_RECT                                 = 1 << 4,

    VRAPI_FRAME_LAYER_FLAG_INHIBIT_SRGB_FRAMEBUFFER                             = 1 << 8,


} ovrFrameLayerFlags;

typedefenum
{
    VRAPI_FRAME_LAYER_EYE_LEFT      = 0,
    VRAPI_FRAME_LAYER_EYE_RIGHT     = 1,
    VRAPI_FRAME_LAYER_EYE_MAX       = 2
} ovrFrameLayerEye;

typedefenum
{
    VRAPI_FRAME_LAYER_BLEND_ZERO                    = 0,
    VRAPI_FRAME_LAYER_BLEND_ONE                     = 1,
    VRAPI_FRAME_LAYER_BLEND_SRC_ALPHA               = 2,
    VRAPI_FRAME_LAYER_BLEND_ONE_MINUS_SRC_ALPHA     = 5
} ovrFrameLayerBlend;

typedefenum
{
    VRAPI_FRAME_LAYER_TYPE_MAX  = 4
} ovrFrameLayerType;

typedefenum
{
    VRAPI_EXTRA_LATENCY_MODE_OFF        = 0,
    VRAPI_EXTRA_LATENCY_MODE_ON         = 1,
    VRAPI_EXTRA_LATENCY_MODE_DYNAMIC    = 2
} ovrExtraLatencyMode;

//-------------------------------------
// Legacy monolithic FrameParm submission structures.
//-------------------------------------

typedefstruct
{
    ovrTextureSwapChain *   ColorTextureSwapChain;

    ovrTextureSwapChain *   DepthTextureSwapChain;

int                     TextureSwapChainIndex;

    ovrMatrix4f             TexCoordsFromTanAngles;

    ovrRectf                TextureRect;

    OVR_VRAPI_PADDING( 4 );

    ovrRigidBodyPosef       HeadPose;

unsignedlonglong      CompletionFence;
} ovrFrameLayerTexture;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrFrameLayerTexture, 200 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrFrameLayerTexture, 208 );

typedefstruct
{
    ovrFrameLayerTexture    Textures[VRAPI_FRAME_LAYER_EYE_MAX];

float                   SpinSpeed;  //< Radians/Second
float                   SpinScale;

float                   ColorScale;

    OVR_VRAPI_PADDING( 4 );

    ovrFrameLayerBlend      SrcBlend;
    ovrFrameLayerBlend      DstBlend;

int                     Flags;
} ovrFrameLayer;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrFrameLayer, 432 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrFrameLayer, 448 );

typedefstruct
{
int                     CpuLevel;
int                     GpuLevel;

int                     MainThreadTid;
int                     RenderThreadTid;
} ovrPerformanceParms;

OVR_VRAPI_ASSERT_TYPE_SIZE( ovrPerformanceParms, 16 );

typedefstruct
{
    ovrStructureType        Type;

    OVR_VRAPI_PADDING( 4 );

    ovrFrameLayer           Layers[VRAPI_FRAME_LAYER_TYPE_MAX];
int                     LayerCount;

int                     Flags;

longlong               FrameIndex;

int                     SwapInterval;

    ovrExtraLatencyMode     ExtraLatencyMode;

    ovrMatrix4f             ExternalVelocity;

    jobject                 SurfaceTextureObject_DEPRECATED;

    ovrPerformanceParms     PerformanceParms;

    ovrJava                 Java;
} ovrFrameParms;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrFrameParms, 1856 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrFrameParms, 1936 );

//-------------------------------------
// New Style Flexible Layer List structures.
//-------------------------------------
enum
{
    ovrMaxLayerCount = 16
};

typedefenum ovrLayerType2_
{
    VRAPI_LAYER_TYPE_PROJECTION2            = 1,
    VRAPI_LAYER_TYPE_CYLINDER2              = 3,
    VRAPI_LAYER_TYPE_CUBE2                  = 4,
    VRAPI_LAYER_TYPE_EQUIRECT2              = 5,
    VRAPI_LAYER_TYPE_LOADING_ICON2          = 6,
} ovrLayerType2;

typedefstruct ovrLayerHeader2_
{
    ovrLayerType2       Type;
    uint32_t            Flags;

    ovrVector4f         ColorScale;
    ovrFrameLayerBlend  SrcBlend;
    ovrFrameLayerBlend  DstBlend;

    jobject             SurfaceTextureObject_DEPRECATED;
} ovrLayerHeader2;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrLayerHeader2, 36 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrLayerHeader2, 40 );

typedefstruct
{
    ovrLayerHeader2         Header;

    ovrRigidBodyPosef       HeadPose;

struct
    {
        ovrTextureSwapChain * ColorSwapChain;
int                 SwapChainIndex;
        ovrMatrix4f         TexCoordsFromTanAngles;
        ovrRectf            TextureRect;
    } Textures[VRAPI_FRAME_LAYER_EYE_MAX];
} ovrLayerProjection2;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrLayerProjection2, 312 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrLayerProjection2, 328 );

typedefstruct
{
    ovrLayerHeader2         Header;

    ovrRigidBodyPosef       HeadPose;

struct
    {
        ovrTextureSwapChain * ColorSwapChain;
int                 SwapChainIndex;
        ovrMatrix4f         TexCoordsFromTanAngles;
        ovrRectf            TextureRect;
        ovrMatrix4f         TextureMatrix;
    } Textures[VRAPI_FRAME_LAYER_EYE_MAX];
} ovrLayerCylinder2;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrLayerCylinder2, 440 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrLayerCylinder2, 456 );

typedefstruct
{
    ovrLayerHeader2         Header;

    ovrRigidBodyPosef       HeadPose;
    ovrMatrix4f             TexCoordsFromTanAngles;

    ovrVector3f             Offset;

struct
    {
        ovrTextureSwapChain * ColorSwapChain;
int                 SwapChainIndex;
    } Textures[VRAPI_FRAME_LAYER_EYE_MAX];
} ovrLayerCube2;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrLayerCube2, 232 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrLayerCube2, 248 );

typedefstruct
{
    ovrLayerHeader2         Header;

    ovrRigidBodyPosef       HeadPose;
    ovrMatrix4f             TexCoordsFromTanAngles;

struct
    {
        ovrTextureSwapChain * ColorSwapChain;
int                 SwapChainIndex;
        ovrRectf            TextureRect;
        ovrMatrix4f         TextureMatrix;
    } Textures[VRAPI_FRAME_LAYER_EYE_MAX];
} ovrLayerEquirect2;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrLayerEquirect2, 376 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrLayerEquirect2, 392 );

typedefstruct
{
    ovrLayerHeader2         Header;

float                   SpinSpeed;              //< radians per second
float                   SpinScale;

    ovrTextureSwapChain *   ColorSwapChain;
int                     SwapChainIndex;
} ovrLayerLoadingIcon2;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrLayerLoadingIcon2, 52 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrLayerLoadingIcon2, 64 );


typedefunion
{
    ovrLayerHeader2         Header;
    ovrLayerProjection2     Projection;
    ovrLayerCylinder2       Cylinder;
    ovrLayerCube2           Cube;
    ovrLayerEquirect2       Equirect;
    ovrLayerLoadingIcon2    LoadingIcon;
} ovrLayer_Union2;

typedefstruct ovrSubmitFrameDescription2_
{
    uint32_t            Flags;
    uint32_t            SwapInterval;
    uint64_t            FrameIndex;
double              DisplayTime;
unsignedlonglong  CompletionFence;
    uint32_t            LayerCount;
const ovrLayerHeader2 * const * Layers;
} ovrSubmitFrameDescription2;

OVR_VRAPI_ASSERT_TYPE_SIZE_32_BIT( ovrSubmitFrameDescription2, 40 );
OVR_VRAPI_ASSERT_TYPE_SIZE_64_BIT( ovrSubmitFrameDescription2, 48 );

//-----------------------------------------------------------------
// Performance
//-----------------------------------------------------------------

typedefenum
{
    VRAPI_PERF_THREAD_TYPE_MAIN         = 0,
    VRAPI_PERF_THREAD_TYPE_RENDERER     = 1,
} ovrPerfThreadType;

#endif  // OVR_VrApi_Types_h
The documentation for this file was generated from the following file: Include/VrApi_Types.h