openxr.h File Reference

#include <stdint.h>
#include <stddef.h>

Include dependency graph for openxr.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	XrVector3f
struct	XrQuaternionf
struct	XrPosef
struct	XrFovf
struct	XrExtent2Di
struct	XrExtent2Df
struct	XrRect2Di
struct	XrOffset2Di
struct	XrApplicationInfo
struct	XrInstanceCreateInfo
struct	XrSystemGetInfo
struct	XrSessionCreateInfo
struct	XrSessionBeginInfo
struct	XrSwapchainCreateInfo
struct	XrSwapchainImageBaseHeader
struct	XrSwapchainImageCpuXeneva
struct	XrSwapchainImageAcquireInfo
struct	XrSwapchainImageWaitInfo
struct	XrSwapchainImageReleaseInfo
struct	XrReferenceSpaceCreateInfo
struct	XrView
struct	XrViewLocateInfo
struct	XrViewState
struct	XrSwapchainSubImage
struct	XrCompositionLayerBaseHeader
struct	XrCompositionLayerQuad
struct	XrFrameWaitInfo
struct	XrFrameState
struct	XrFrameBeginInfo
struct	XrFrameEndInfo

Macros
#define	XR_MAKE_VERSION(major, minor, patch)
#define	XR_CURRENT_API_VERSION   XR_MAKE_VERSION(1, 0, 34)
#define	XR_SUCCEEDED(r)   ((r) >= 0)
#define	XR_FAILED(r)   ((r) < 0)
#define	XR_NULL_HANDLE   0
#define	XR_NULL_SYSTEM_ID   0
#define	XR_INFINITE_DURATION   0x7fffffffffffffffLL

Typedefs
typedef uint64_t	XrInstance
typedef uint64_t	XrSession
typedef uint64_t	XrSpace
typedef uint64_t	XrSwapchain
typedef uint64_t	XrSystemId
typedef uint64_t	XrTime
typedef uint64_t	XrDuration
typedef uint32_t	XrBool32
typedef uint64_t	XrFlags64
typedef enum XrResult	XrResult
typedef enum XrStructureType	XrStructureType
typedef enum XrFormFactor	XrFormFactor
typedef enum XrViewConfigurationType	XrViewConfigurationType
typedef enum XrReferenceSpaceType	XrReferenceSpaceType
typedef enum XrSessionState	XrSessionState
typedef enum XrEnvironmentBlendMode	XrEnvironmentBlendMode
typedef enum XrSwapchainUsageFlagBits	XrSwapchainUsageFlagBits
typedef XrFlags64	XrSwapchainUsageFlags
typedef enum XrCompositionLayerFlagBits	XrCompositionLayerFlagBits
typedef XrFlags64	XrCompositionLayerFlags
typedef enum XrEyeVisibility	XrEyeVisibility
typedef struct XrVector3f	XrVector3f
typedef struct XrQuaternionf	XrQuaternionf
typedef struct XrPosef	XrPosef
typedef struct XrFovf	XrFovf
typedef struct XrExtent2Di	XrExtent2Di
typedef struct XrExtent2Df	XrExtent2Df
typedef struct XrRect2Di	XrRect2Di
typedef struct XrOffset2Di	XrOffset2Di
typedef struct XrApplicationInfo	XrApplicationInfo
typedef struct XrInstanceCreateInfo	XrInstanceCreateInfo
typedef struct XrSystemGetInfo	XrSystemGetInfo
typedef struct XrSessionCreateInfo	XrSessionCreateInfo
typedef struct XrSessionBeginInfo	XrSessionBeginInfo
typedef struct XrSwapchainCreateInfo	XrSwapchainCreateInfo
typedef struct XrSwapchainImageBaseHeader	XrSwapchainImageBaseHeader
typedef struct XrSwapchainImageCpuXeneva	XrSwapchainImageCpuXeneva
typedef struct XrSwapchainImageAcquireInfo	XrSwapchainImageAcquireInfo
typedef struct XrSwapchainImageWaitInfo	XrSwapchainImageWaitInfo
typedef struct XrSwapchainImageReleaseInfo	XrSwapchainImageReleaseInfo
typedef struct XrReferenceSpaceCreateInfo	XrReferenceSpaceCreateInfo
typedef struct XrView	XrView
typedef struct XrViewLocateInfo	XrViewLocateInfo
typedef struct XrViewState	XrViewState
typedef struct XrSwapchainSubImage	XrSwapchainSubImage
typedef struct XrCompositionLayerBaseHeader	XrCompositionLayerBaseHeader
typedef struct XrCompositionLayerQuad	XrCompositionLayerQuad
typedef struct XrFrameWaitInfo	XrFrameWaitInfo
typedef struct XrFrameState	XrFrameState
typedef struct XrFrameBeginInfo	XrFrameBeginInfo
typedef struct XrFrameEndInfo	XrFrameEndInfo

Enumerations
enum	XrResult {   XR_SUCCESS = 0 , XR_TIMEOUT_EXPIRED = 1 , XR_SESSION_LOSS_PENDING = 3 , XR_ERROR_VALIDATION_FAILURE = -1 ,   XR_ERROR_RUNTIME_FAILURE = -2 , XR_ERROR_HANDLE_INVALID = -12 , XR_ERROR_SESSION_NOT_RUNNING = -14 , XR_ERROR_SWAPCHAIN_RECT_INVALID = -24 ,   XR_ERROR_FEATURE_UNSUPPORTED = -41 }
enum	XrStructureType {   XR_TYPE_UNKNOWN = 0 , XR_TYPE_INSTANCE_CREATE_INFO = 1 , XR_TYPE_SYSTEM_GET_INFO = 4 , XR_TYPE_SESSION_CREATE_INFO = 5 ,   XR_TYPE_SWAPCHAIN_CREATE_INFO = 9 , XR_TYPE_REFERENCE_SPACE_CREATE_INFO = 24 , XR_TYPE_VIEW_LOCATE_INFO = 36 , XR_TYPE_VIEW = 37 ,   XR_TYPE_FRAME_WAIT_INFO = 44 , XR_TYPE_FRAME_STATE = 45 , XR_TYPE_FRAME_BEGIN_INFO = 46 , XR_TYPE_FRAME_END_INFO = 47 ,   XR_TYPE_SWAPCHAIN_IMAGE_ACQUIRE_INFO = 52 , XR_TYPE_SWAPCHAIN_IMAGE_WAIT_INFO = 53 , XR_TYPE_SWAPCHAIN_IMAGE_RELEASE_INFO = 54 , XR_TYPE_SESSION_BEGIN_INFO = 55 ,   XR_TYPE_COMPOSITION_LAYER_QUAD = 62 , XR_TYPE_VIEW_STATE = 89 , XR_TYPE_SWAPCHAIN_IMAGE_CPU_XENEVA = 1000000000 }
enum	XrFormFactor { XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY = 1 }
enum	XrViewConfigurationType { XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO = 2 }
enum	XrReferenceSpaceType { XR_REFERENCE_SPACE_TYPE_LOCAL = 1 }
enum	XrSessionState {   XR_SESSION_STATE_UNKNOWN = 0 , XR_SESSION_STATE_IDLE = 1 , XR_SESSION_STATE_READY = 2 , XR_SESSION_STATE_SYNCHRONIZED = 3 ,   XR_SESSION_STATE_VISIBLE = 4 , XR_SESSION_STATE_FOCUSED = 5 }
enum	XrEnvironmentBlendMode { XR_ENVIRONMENT_BLEND_MODE_OPAQUE = 1 }
enum	XrSwapchainUsageFlagBits { XR_SWAPCHAIN_USAGE_COLOR_ATTACHMENT_BIT = 0x00000001 , XR_SWAPCHAIN_USAGE_SAMPLED_BIT = 0x00000020 }
enum	XrCompositionLayerFlagBits { XR_COMPOSITION_LAYER_BLEND_TEXTURE_SOURCE_ALPHA_BIT = 0x00000001 }
enum	XrEyeVisibility { XR_EYE_VISIBILITY_BOTH = 0 , XR_EYE_VISIBILITY_LEFT = 1 , XR_EYE_VISIBILITY_RIGHT = 2 }

Functions
XrResult	xrCreateInstance (const XrInstanceCreateInfo *info, XrInstance *instance)
XrResult	xrDestroyInstance (XrInstance instance)
XrResult	xrGetSystem (XrInstance instance, const XrSystemGetInfo *info, XrSystemId *systemId)
XrResult	xrCreateSession (XrInstance instance, const XrSessionCreateInfo *info, XrSession *session)
XrResult	xrDestroySession (XrSession session)
XrResult	xrBeginSession (XrSession session, const XrSessionBeginInfo *info)
XrResult	xrEndSession (XrSession session)
XrResult	xrCreateReferenceSpace (XrSession session, const XrReferenceSpaceCreateInfo *info, XrSpace *space)
XrResult	xrDestroySpace (XrSpace space)
XrResult	xrCreateSwapchain (XrSession session, const XrSwapchainCreateInfo *info, XrSwapchain *swapchain)
XrResult	xrDestroySwapchain (XrSwapchain swapchain)
XrResult	xrEnumerateSwapchainImages (XrSwapchain swapchain, uint32_t count, uint32_t *written, XrSwapchainImageBaseHeader *images)
XrResult	xrAcquireSwapchainImage (XrSwapchain swapchain, const XrSwapchainImageAcquireInfo *info, uint32_t *index)
XrResult	xrWaitSwapchainImage (XrSwapchain swapchain, const XrSwapchainImageWaitInfo *info)
XrResult	xrReleaseSwapchainImage (XrSwapchain swapchain, const XrSwapchainImageReleaseInfo *info)
XrResult	xrWaitFrame (XrSession session, const XrFrameWaitInfo *info, XrFrameState *state)
XrResult	xrBeginFrame (XrSession session, const XrFrameBeginInfo *info)
XrResult	xrEndFrame (XrSession session, const XrFrameEndInfo *info)
XrResult	xrLocateViews (XrSession session, const XrViewLocateInfo *info, XrViewState *state, uint32_t viewCapacity, uint32_t *viewCount, XrView *views)
void	xrQemuSetScanout (uint32_t *pixels, int width, int height, int stride_pixels)
void	xrQemuSetCanvasSrc (const uint32_t *pixels, int stride_pixels, int shift_l, int shift_r)
void	xrQemuSetCanvasDamage (const XrRect2Di *rects, uint32_t count)

Macro Definition Documentation

XR_CURRENT_API_VERSION

#define XR_CURRENT_API_VERSION   XR_MAKE_VERSION(1, 0, 34)

XR_FAILED

#define XR_FAILED

(

r

)

((r) < 0)

XR_INFINITE_DURATION

#define XR_INFINITE_DURATION   0x7fffffffffffffffLL

XR_MAKE_VERSION

#define XR_MAKE_VERSION	(		major,
			minor,
			patch
	)

Value:

    ((((uint64_t)(major)&0xffffULL) << 48) | (((uint64_t)(minor)&0xffffULL) << 32) | \
     ((uint64_t)(patch)&0xffffffffULL))

XR_NULL_HANDLE

#define XR_NULL_HANDLE   0

XR_NULL_SYSTEM_ID

#define XR_NULL_SYSTEM_ID   0

XR_SUCCEEDED

#define XR_SUCCEEDED

(

r

)

((r) >= 0)

Typedef Documentation

XrApplicationInfo

typedef struct XrApplicationInfo XrApplicationInfo

XrBool32

typedef uint32_t XrBool32

XrCompositionLayerBaseHeader

typedef struct XrCompositionLayerBaseHeader XrCompositionLayerBaseHeader

XrCompositionLayerFlagBits

typedef enum XrCompositionLayerFlagBits XrCompositionLayerFlagBits

XrCompositionLayerFlags

typedef XrFlags64 XrCompositionLayerFlags

XrCompositionLayerQuad

typedef struct XrCompositionLayerQuad XrCompositionLayerQuad

XrDuration

typedef uint64_t XrDuration

XrEnvironmentBlendMode

typedef enum XrEnvironmentBlendMode XrEnvironmentBlendMode

XrExtent2Df

typedef struct XrExtent2Df XrExtent2Df

XrExtent2Di

typedef struct XrExtent2Di XrExtent2Di

XrEyeVisibility

typedef enum XrEyeVisibility XrEyeVisibility

XrFlags64

typedef uint64_t XrFlags64

XrFormFactor

typedef enum XrFormFactor XrFormFactor

XrFovf

typedef struct XrFovf XrFovf

XrFrameBeginInfo

typedef struct XrFrameBeginInfo XrFrameBeginInfo

XrFrameEndInfo

typedef struct XrFrameEndInfo XrFrameEndInfo

XrFrameState

typedef struct XrFrameState XrFrameState

XrFrameWaitInfo

typedef struct XrFrameWaitInfo XrFrameWaitInfo

XrInstance

typedef uint64_t XrInstance

XrInstanceCreateInfo

typedef struct XrInstanceCreateInfo XrInstanceCreateInfo

XrOffset2Di

typedef struct XrOffset2Di XrOffset2Di

XrPosef

typedef struct XrPosef XrPosef

XrQuaternionf

typedef struct XrQuaternionf XrQuaternionf

XrRect2Di

typedef struct XrRect2Di XrRect2Di

XrReferenceSpaceCreateInfo

typedef struct XrReferenceSpaceCreateInfo XrReferenceSpaceCreateInfo

XrReferenceSpaceType

typedef enum XrReferenceSpaceType XrReferenceSpaceType

XrResult

typedef enum XrResult XrResult

XrSession

typedef uint64_t XrSession

XrSessionBeginInfo

typedef struct XrSessionBeginInfo XrSessionBeginInfo

XrSessionCreateInfo

typedef struct XrSessionCreateInfo XrSessionCreateInfo

XrSessionState

typedef enum XrSessionState XrSessionState

XrSpace

typedef uint64_t XrSpace

XrStructureType

typedef enum XrStructureType XrStructureType

XrSwapchain

typedef uint64_t XrSwapchain

XrSwapchainCreateInfo

typedef struct XrSwapchainCreateInfo XrSwapchainCreateInfo

XrSwapchainImageAcquireInfo

typedef struct XrSwapchainImageAcquireInfo XrSwapchainImageAcquireInfo

XrSwapchainImageBaseHeader

typedef struct XrSwapchainImageBaseHeader XrSwapchainImageBaseHeader

XrSwapchainImageCpuXeneva

typedef struct XrSwapchainImageCpuXeneva XrSwapchainImageCpuXeneva

XrSwapchainImageReleaseInfo

typedef struct XrSwapchainImageReleaseInfo XrSwapchainImageReleaseInfo

XrSwapchainImageWaitInfo

typedef struct XrSwapchainImageWaitInfo XrSwapchainImageWaitInfo

XrSwapchainSubImage

typedef struct XrSwapchainSubImage XrSwapchainSubImage

XrSwapchainUsageFlagBits

typedef enum XrSwapchainUsageFlagBits XrSwapchainUsageFlagBits

XrSwapchainUsageFlags

typedef XrFlags64 XrSwapchainUsageFlags

XrSystemGetInfo

typedef struct XrSystemGetInfo XrSystemGetInfo

XrSystemId

typedef uint64_t XrSystemId

XrTime

typedef uint64_t XrTime

XrVector3f

typedef struct XrVector3f XrVector3f

XrView

typedef struct XrView XrView

XrViewConfigurationType

typedef enum XrViewConfigurationType XrViewConfigurationType

XrViewLocateInfo

typedef struct XrViewLocateInfo XrViewLocateInfo

XrViewState

typedef struct XrViewState XrViewState

Enumeration Type Documentation

XrCompositionLayerFlagBits

enum XrCompositionLayerFlagBits

Enumerator
XR_COMPOSITION_LAYER_BLEND_TEXTURE_SOURCE_ALPHA_BIT

XrEnvironmentBlendMode

enum XrEnvironmentBlendMode

Enumerator
XR_ENVIRONMENT_BLEND_MODE_OPAQUE

XrEyeVisibility

enum XrEyeVisibility

Enumerator
XR_EYE_VISIBILITY_BOTH
XR_EYE_VISIBILITY_LEFT
XR_EYE_VISIBILITY_RIGHT

XrFormFactor

enum XrFormFactor

Enumerator
XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY

XrReferenceSpaceType

enum XrReferenceSpaceType

Enumerator
XR_REFERENCE_SPACE_TYPE_LOCAL

XrResult

enum XrResult

Enumerator
XR_SUCCESS
XR_TIMEOUT_EXPIRED
XR_SESSION_LOSS_PENDING
XR_ERROR_VALIDATION_FAILURE
XR_ERROR_RUNTIME_FAILURE
XR_ERROR_HANDLE_INVALID
XR_ERROR_SESSION_NOT_RUNNING
XR_ERROR_SWAPCHAIN_RECT_INVALID
XR_ERROR_FEATURE_UNSUPPORTED

XrSessionState

enum XrSessionState

Enumerator
XR_SESSION_STATE_UNKNOWN
XR_SESSION_STATE_IDLE
XR_SESSION_STATE_READY
XR_SESSION_STATE_SYNCHRONIZED
XR_SESSION_STATE_VISIBLE
XR_SESSION_STATE_FOCUSED

XrStructureType

enum XrStructureType

Enumerator
XR_TYPE_UNKNOWN
XR_TYPE_INSTANCE_CREATE_INFO
XR_TYPE_SYSTEM_GET_INFO
XR_TYPE_SESSION_CREATE_INFO
XR_TYPE_SWAPCHAIN_CREATE_INFO
XR_TYPE_REFERENCE_SPACE_CREATE_INFO
XR_TYPE_VIEW_LOCATE_INFO
XR_TYPE_VIEW
XR_TYPE_FRAME_WAIT_INFO
XR_TYPE_FRAME_STATE
XR_TYPE_FRAME_BEGIN_INFO
XR_TYPE_FRAME_END_INFO
XR_TYPE_SWAPCHAIN_IMAGE_ACQUIRE_INFO
XR_TYPE_SWAPCHAIN_IMAGE_WAIT_INFO
XR_TYPE_SWAPCHAIN_IMAGE_RELEASE_INFO
XR_TYPE_SESSION_BEGIN_INFO
XR_TYPE_COMPOSITION_LAYER_QUAD
XR_TYPE_VIEW_STATE
XR_TYPE_SWAPCHAIN_IMAGE_CPU_XENEVA

XrSwapchainUsageFlagBits

enum XrSwapchainUsageFlagBits

Enumerator
XR_SWAPCHAIN_USAGE_COLOR_ATTACHMENT_BIT
XR_SWAPCHAIN_USAGE_SAMPLED_BIT

XrViewConfigurationType

enum XrViewConfigurationType

Enumerator
XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO

Function Documentation

xrAcquireSwapchainImage()

XrResult xrAcquireSwapchainImage	(	XrSwapchain	swapchain,
		const XrSwapchainImageAcquireInfo *	info,
		uint32_t *	index
	)

xrBeginFrame()

XrResult xrBeginFrame	(	XrSession	session,
		const XrFrameBeginInfo *	info
	)

xrBeginSession()

XrResult xrBeginSession	(	XrSession	session,
		const XrSessionBeginInfo *	info
	)

xrCreateInstance()

XrResult xrCreateInstance	(	const XrInstanceCreateInfo *	info,
		XrInstance *	instance
	)

xrCreateReferenceSpace()

XrResult xrCreateReferenceSpace	(	XrSession	session,
		const XrReferenceSpaceCreateInfo *	info,
		XrSpace *	space
	)

xrCreateSession()

XrResult xrCreateSession	(	XrInstance	instance,
		const XrSessionCreateInfo *	info,
		XrSession *	session
	)

xrCreateSwapchain()

XrResult xrCreateSwapchain	(	XrSession	session,
		const XrSwapchainCreateInfo *	info,
		XrSwapchain *	swapchain
	)

xrDestroyInstance()

XrResult xrDestroyInstance

(

XrInstance

instance

)

xrDestroySession()

XrResult xrDestroySession

(

XrSession

session

)

xrDestroySpace()

XrResult xrDestroySpace

(

XrSpace

space

)

xrDestroySwapchain()

XrResult xrDestroySwapchain

(

XrSwapchain

swapchain

)

xrEndFrame()

XrResult xrEndFrame	(	XrSession	session,
		const XrFrameEndInfo *	info
	)

xrEndSession()

XrResult xrEndSession

(

XrSession

session

)

xrEnumerateSwapchainImages()

XrResult xrEnumerateSwapchainImages	(	XrSwapchain	swapchain,
		uint32_t	count,
		uint32_t *	written,
		XrSwapchainImageBaseHeader *	images
	)

xrGetSystem()

XrResult xrGetSystem	(	XrInstance	instance,
		const XrSystemGetInfo *	info,
		XrSystemId *	systemId
	)

xrLocateViews()

XrResult xrLocateViews	(	XrSession	session,
		const XrViewLocateInfo *	info,
		XrViewState *	state,
		uint32_t	viewCapacity,
		uint32_t *	viewCount,
		XrView *	views
	)

xrQemuSetCanvasDamage()

void xrQemuSetCanvasDamage	(	const XrRect2Di *	rects,
		uint32_t	count
	)

xrQemuSetCanvasSrc()

void xrQemuSetCanvasSrc	(	const uint32_t *	pixels,
		int	stride_pixels,
		int	shift_l,
		int	shift_r
	)

xrQemuSetScanout()

void xrQemuSetScanout	(	uint32_t *	pixels,
		int	width,
		int	height,
		int	stride_pixels
	)

xrReleaseSwapchainImage()

XrResult xrReleaseSwapchainImage	(	XrSwapchain	swapchain,
		const XrSwapchainImageReleaseInfo *	info
	)

xrWaitFrame()

XrResult xrWaitFrame	(	XrSession	session,
		const XrFrameWaitInfo *	info,
		XrFrameState *	state
	)

xrWaitSwapchainImage()

XrResult xrWaitSwapchainImage	(	XrSwapchain	swapchain,
		const XrSwapchainImageWaitInfo *	info
	)