OpenXR.Core10.Instance

Documentation

getInstanceProcAddr

Arguments

:: forall io. MonadIO io

=> Instance

instance is the instance that the function pointer will be compatible with, or NULL for functions not dependent on any instance.

-> ("name" ::: ByteString)

name is the name of the function to obtain.

-> io PFN_xrVoidFunction

xrGetInstanceProcAddr - Gets a function pointer for an OpenXR function

Parameter Descriptions

Description

getInstanceProcAddr itself is obtained in a platform- and loader- specific manner. Typically, the loader library will export this function as a function symbol, so applications can link against the loader library, or load it dynamically and look up the symbol using platform-specific APIs. Loaders must export function symbols for all core OpenXR functions. Because of this, applications that use only the core OpenXR functions have no need to use getInstanceProcAddr.

Because an application can call getInstanceProcAddr before creating an instance, getInstanceProcAddr returns a valid function pointer when the instance parameter is XR_NULL_HANDLE and the name parameter is one of the following strings:

No Instance Required

• enumerateInstanceExtensionProperties

• enumerateApiLayerProperties
• createInstance

getInstanceProcAddr must return ERROR_HANDLE_INVALID if name is not one of the above strings and instance is XR_NULL_HANDLE. getInstanceProcAddr may return ERROR_HANDLE_INVALID if name is not one of the above strings and instance is invalid but not XR_NULL_HANDLE.

getInstanceProcAddr must return ERROR_FUNCTION_UNSUPPORTED if instance is a valid instance and the string specified in name is not the name of an OpenXR core or enabled extension function.

If name is the name of an extension function, then the result returned by getInstanceProcAddr will depend upon how the instance was created. If instance was created with the related extension’s name appearing in the InstanceCreateInfo::enabledExtensionNames array, then getInstanceProcAddr returns a valid function pointer. If the related extension’s name did not appear in the InstanceCreateInfo::enabledExtensionNames array during the creation of instance, then getInstanceProcAddr returns ERROR_FUNCTION_UNSUPPORTED. Because of this, function pointers returned by getInstanceProcAddr using one Instance may not be valid when used with objects related to a different Instance.

The returned function pointer is of type PFN_xrVoidFunction, and must be cast to the type of the function being queried.

The table below defines the various use cases for getInstanceProcAddr and return value (“fp” is “function pointer”) for each case.

instance parameter	name parameter	return value
*	NULL	undefined
invalid instance	*	undefined
NULL	enumerateInstanceExtensionProperties	fp
NULL	enumerateApiLayerProperties	fp
NULL	createInstance	fp
NULL	* (any name not covered above)	NULL
instance	core OpenXR function	fp1
instance	enabled extension function for instance	fp1
instance	* (any name not covered above)	NULL

xrGetInstanceProcAddr behavior

1

The returned function pointer must only be called with a handle (the first parameter) that is instance or a child of instance.

Valid Usage (Implicit)

• If instance is not XR_NULL_HANDLE, instance must be a valid Instance handle

• name must be a null-terminated UTF-8 string
• function must be a pointer to a PFN_xrVoidFunction value

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_OUT_OF_MEMORY
• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE

See Also

PFN_xrVoidFunction, Instance

enumerateApiLayerProperties :: forall io. MonadIO io => io ("properties" ::: Vector ApiLayerProperties)

xrEnumerateApiLayerProperties - Returns up to requested number of global layer properties

Parameter Descriptions

• propertyCapacityInput is the capacity of the properties array, or 0 to indicate a request to retrieve the required capacity.

• propertyCountOutput is a pointer to the count of properties written, or a pointer to the required capacity in the case that propertyCapacityInput is 0.
• properties is a pointer to an array of ApiLayerProperties structures, but can be NULL if propertyCapacityInput is 0.
• See the Buffer Size Parameters section for a detailed description of retrieving the required properties size.

Description

The list of available layers may change at any time due to actions outside of the OpenXR runtime, so two calls to enumerateApiLayerProperties with the same parameters may return different results, or retrieve different propertyCountOutput values or properties contents.

Once an instance has been created, the layers enabled for that instance will continue to be enabled and valid for the lifetime of that instance, even if some of them become unavailable for future instances.

Valid Usage (Implicit)

• propertyCountOutput must be a pointer to a uint32_t value

• If propertyCapacityInput is not 0, properties must be a pointer to an array of propertyCapacityInput ApiLayerProperties structures

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_MEMORY
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_SIZE_INSUFFICIENT

See Also

ApiLayerProperties

enumerateInstanceExtensionProperties :: forall io. MonadIO io => ("layerName" ::: Maybe ByteString) -> io ("properties" ::: Vector ExtensionProperties)

xrEnumerateInstanceExtensionProperties - Returns properties of available instance extensions

Parameter Descriptions

• layerName is either NULL or a pointer to a string naming the API layer to retrieve extensions from, as returned by enumerateApiLayerProperties.

• propertyCapacityInput is the capacity of the properties array, or 0 to indicate a request to retrieve the required capacity.
• propertyCountOutput is a pointer to the count of properties written, or a pointer to the required capacity in the case that propertyCapacityInput is 0.
• properties is a pointer to an array of ExtensionProperties structures, but can be NULL if propertyCapacityInput is 0.
• See the Buffer Size Parameters section for a detailed description of retrieving the required properties size.

Description

If properties is NULL, then the number of extensions properties available is returned in propertyCountOutput. Otherwise, propertyCountInput must point to a variable set by the user to the number of elements in the properties array. If propertyCountInput is less than the number of extension properties available, the contents of properties will be undefined. If propertyCountInput is smaller than the number of extensions available, the runtime must return the failure code ERROR_SIZE_INSUFFICIENT and the contents of properties are undefined.

Because the list of available layers may change externally between calls to enumerateInstanceExtensionProperties, two calls may retrieve different results if a layerName is available in one call but not in another. The extensions supported by a layer may also change between two calls, e.g. if the layer implementation is replaced by a different version between those calls.

Valid Usage (Implicit)

• If layerName is not NULL, layerName must be a null-terminated UTF-8 string

• propertyCountOutput must be a pointer to a uint32_t value
• If propertyCapacityInput is not 0, properties must be a pointer to an array of propertyCapacityInput ExtensionProperties structures

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_MEMORY
• ERROR_API_LAYER_NOT_PRESENT
• ERROR_RUNTIME_FAILURE
• ERROR_VALIDATION_FAILURE
• ERROR_SIZE_INSUFFICIENT

See Also

ExtensionProperties

createInstance

Arguments

:: forall a io. (Extendss InstanceCreateInfo a, PokeChain a, MonadIO io)

=> InstanceCreateInfo a

createInfo points to an instance of InstanceCreateInfo controlling creation of the instance.

createInfo must be a pointer to a valid InstanceCreateInfo structure

-> io Instance

xrCreateInstance - Creates an OpenXR Instance

Parameter Descriptions

Description

createInstance creates the Instance, then enables and initializes global API layers and extensions requested by the application. If an extension is provided by an API layer, both the API layer and extension must be specified at createInstance time. If a specified API layer cannot be found, no Instance will be created and the function will return ERROR_API_LAYER_NOT_PRESENT. Likewise, if a specified extension cannot be found, the call must return ERROR_EXTENSION_NOT_PRESENT and no Instance will be created. Additionally, some runtimes may limit the number of concurrent instances that may be in use. If the application attempts to create more instances than a runtime can simultaneously support, createInstance may return ERROR_LIMIT_REACHED.

If the ApplicationInfo::applicationName is the empty string the runtime must return ERROR_NAME_INVALID.

If the InstanceCreateInfo structure contains a platform-specific extension for a platform other than the target platform, ERROR_INITIALIZATION_FAILED may be returned. If a mandatory platform-specific extension is defined for the target platform but no matching extension struct is provided in InstanceCreateInfo the runtime must return ERROR_INITIALIZATION_FAILED.

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_INSTANCE_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_INITIALIZATION_FAILED
• ERROR_API_VERSION_UNSUPPORTED
• ERROR_API_LAYER_NOT_PRESENT
• ERROR_EXTENSION_NOT_PRESENT
• ERROR_VALIDATION_FAILURE
• ERROR_NAME_INVALID

See Also

Instance, InstanceCreateInfo

withInstance :: forall a io r. (Extendss InstanceCreateInfo a, PokeChain a, MonadIO io) => InstanceCreateInfo a -> (io Instance -> (Instance -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createInstance and destroyInstance

To ensure that destroyInstance is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

destroyInstance :: forall io. MonadIO io => Instance -> io ()

xrDestroyInstance - Destroy an instance of OpenXR

Parameters

The destroyInstance function is used to destroy an Instance.

Parameter Descriptions

• instance is the handle to the instance to destroy.

Instance handles are destroyed using destroyInstance. When an Instance is destroyed, all handles that are children of that Instance are also destroyed.

Valid Usage (Implicit)

• instance must be a valid Instance handle

Thread Safety

• Access to instance, and any child handles, must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID

See Also

Instance

resultToString

Arguments

:: forall io. MonadIO io

=> Instance

instance is the handle of the instance to ask for the string.

-> ("value" ::: Result)

value is the Result value to turn into a string.

-> io ("buffer" ::: ByteString)

xrResultToString - Converts an XrResult to a UTF-8 string

Parameter Descriptions

Description

Returns the text version of the provided Result value as a UTF-8 string.

In all cases the returned string must be one of:

Result String Return Values

• The literal string defined for the provide numeric value in the core spec or extension. (e.g. the value 0 results in the string SUCCESS)

• XR_UNKNOWN_SUCCESS_ concatenated with the positive result number expressed as a decimal number.
• XR_UNKNOWN_FAILURE_ concatenated with the negative result number expressed as a decimal number.

Valid Usage (Implicit)

• instance must be a valid Instance handle

• value must be a valid Result value
• buffer must be a character array of length MAX_RESULT_STRING_SIZE

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_VALIDATION_FAILURE

See Also

Instance, Result, structureTypeToString

structureTypeToString

Arguments

:: forall io. MonadIO io

=> Instance

instance is the handle of the instance to ask for the string.

-> ("value" ::: StructureType)

value is the StructureType value to turn into a string.

-> io ("buffer" ::: ByteString)

xrStructureTypeToString - Converts an XrStructureType to a UTF-8 string

Parameter Descriptions

Description

Returns the text version of the provided StructureType value as a UTF-8 string.

In all cases the returned string must be one of:

Structure Type String Return Values

• The literal string defined for the provide numeric value in the core spec or extension. (e.g. the value of TYPE_INSTANCE_CREATE_INFO results in the string TYPE_INSTANCE_CREATE_INFO)

• XR_UNKNOWN_STRUCTURE_TYPE_ concatenated with the structure type number expressed as a decimal number.

Valid Usage (Implicit)

• instance must be a valid Instance handle

• value must be a valid StructureType value
• buffer must be a character array of length MAX_STRUCTURE_NAME_SIZE

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_VALIDATION_FAILURE

See Also

Instance, StructureType, resultToString

getInstanceProperties

Arguments

:: forall io. MonadIO io

=> Instance

instance is a handle to an Instance previously created with createInstance.

instance must be a valid Instance handle

-> io InstanceProperties

xrGetInstanceProperties - Gets information about the instance

Parameter Descriptions

Description

The instanceProperties parameter must be filled out by the runtime in response to this call, with information as defined in InstanceProperties.

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_VALIDATION_FAILURE

See Also

Instance, InstanceProperties

pollEvent

Arguments

:: forall io. MonadIO io

=> Instance

instance is a valid Instance.

instance must be a valid Instance handle

-> io (Result, EventDataBuffer)

xrPollEvent - Polls for events

Parameters

pollEvent polls for the next event and returns an event if one is available. pollEvent returns immediately regardless of whether an event was available. The event (if present) is unilaterally removed from the queue if a valid Instance is provided. On return the eventData parameter is filled with the event’s data and the type field is changed to the event’s type. Runtimes may create valid next chains depending on enabled extensions, but they must guarantee that any such chains point only to objects which fit completely within the original EventDataBuffer pointed to by eventData.

Return Codes

Success

• SUCCESS
• EVENT_UNAVAILABLE

Failure

• ERROR_INSTANCE_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE

The runtime must discard queued events which contain destroyed or otherwise invalid handles.

Event	Description
EventDataEventsLost	event queue has overflowed and some events were lost
EventDataInstanceLossPending	application is about to lose the instance
EventDataInteractionProfileChanged	active input form factor for one or more top level user paths has changed
EventDataReferenceSpaceChangePending	runtime will begin operating with updated space bounds
EventDataSessionStateChanged	application has changed lifecycle state

Event Descriptions

See Also

EventDataBuffer, Instance

data ApiLayerProperties

XrApiLayerProperties - Structure specifying layer properties

Valid Usage (Implicit)

See Also

StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrVersion, enumerateApiLayerProperties

Constructors

ApiLayerProperties

Fields

• layerName :: ByteString

  layerName is a string specifying the name of the API layer. Use this name in the InstanceCreateInfo::enabledApiLayerNames array to enable this API layer for an instance.

• specVersion :: Version

  specVersion is the API version the API layer was written to, encoded as described in the API Version Numbers and Semantics section.

• layerVersion :: Word32

  layerVersion is the version of this API layer. It is an integer, increasing with backward compatible changes.

• description :: ByteString

  description is a string providing additional details that can be used by the application to identify the API layer.

Instances

Show ApiLayerProperties

Defined in OpenXR.Core10.Instance

Methods

showsPrec :: Int -> ApiLayerProperties -> ShowS

show :: ApiLayerProperties -> String

showList :: [ApiLayerProperties] -> ShowS

Storable ApiLayerProperties

Defined in OpenXR.Core10.Instance

Methods

sizeOf :: ApiLayerProperties -> Int

alignment :: ApiLayerProperties -> Int

peekElemOff :: Ptr ApiLayerProperties -> Int -> IO ApiLayerProperties

pokeElemOff :: Ptr ApiLayerProperties -> Int -> ApiLayerProperties -> IO ()

peekByteOff :: Ptr b -> Int -> IO ApiLayerProperties

pokeByteOff :: Ptr b -> Int -> ApiLayerProperties -> IO ()

peek :: Ptr ApiLayerProperties -> IO ApiLayerProperties

poke :: Ptr ApiLayerProperties -> ApiLayerProperties -> IO ()

Zero ApiLayerProperties

Defined in OpenXR.Core10.Instance

Methods

zero :: ApiLayerProperties

ToCStruct ApiLayerProperties

Defined in OpenXR.Core10.Instance

Methods

withCStruct :: ApiLayerProperties -> (Ptr ApiLayerProperties -> IO b) -> IO b

pokeCStruct :: Ptr ApiLayerProperties -> ApiLayerProperties -> IO b -> IO b

withZeroCStruct :: (Ptr ApiLayerProperties -> IO b) -> IO b

pokeZeroCStruct :: Ptr ApiLayerProperties -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ApiLayerProperties

Defined in OpenXR.Core10.Instance

Methods

peekCStruct :: Ptr ApiLayerProperties -> IO ApiLayerProperties

data ExtensionProperties

XrExtensionProperties - Returns properties of available instance extensions

Valid Usage (Implicit)

See Also

StructureType, enumerateInstanceExtensionProperties

Constructors

ExtensionProperties

Fields

• extensionName :: ByteString

  extensionName is a NULL terminated string specifying the name of the extension.

• extensionVersion :: Word32

  extensionVersion is the version of this extension. It is an integer, incremented with backward compatible changes.

Instances

Show ExtensionProperties

Defined in OpenXR.Core10.Instance

Methods

showsPrec :: Int -> ExtensionProperties -> ShowS

show :: ExtensionProperties -> String

showList :: [ExtensionProperties] -> ShowS

Storable ExtensionProperties

Defined in OpenXR.Core10.Instance

Methods

sizeOf :: ExtensionProperties -> Int

alignment :: ExtensionProperties -> Int

peekElemOff :: Ptr ExtensionProperties -> Int -> IO ExtensionProperties

pokeElemOff :: Ptr ExtensionProperties -> Int -> ExtensionProperties -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExtensionProperties

pokeByteOff :: Ptr b -> Int -> ExtensionProperties -> IO ()

peek :: Ptr ExtensionProperties -> IO ExtensionProperties

poke :: Ptr ExtensionProperties -> ExtensionProperties -> IO ()

Zero ExtensionProperties

Defined in OpenXR.Core10.Instance

Methods

zero :: ExtensionProperties

ToCStruct ExtensionProperties

Defined in OpenXR.Core10.Instance

Methods

withCStruct :: ExtensionProperties -> (Ptr ExtensionProperties -> IO b) -> IO b

pokeCStruct :: Ptr ExtensionProperties -> ExtensionProperties -> IO b -> IO b

withZeroCStruct :: (Ptr ExtensionProperties -> IO b) -> IO b

pokeZeroCStruct :: Ptr ExtensionProperties -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ExtensionProperties

Defined in OpenXR.Core10.Instance

Methods

peekCStruct :: Ptr ExtensionProperties -> IO ExtensionProperties

data ApplicationInfo

XrApplicationInfo - Structure specifying application info

Valid Usage (Implicit)

Note

When using the OpenXR API to implement a reusable engine that will be used by many applications, engineName should be set to a unique string that identifies the engine, and engineVersion should encode a representation of the engine’s version. This way, all applications that share this engine version will provide the same engineName and engineVersion to the runtime. The engine should then enable individual applications to choose their specific applicationName and applicationVersion, enabling one application to be distinguished from another application.

When using the OpenXR API to implement an individual application without a shared engine, the input engineName should be left empty and engineVersion should be set to 0. The applicationName should then be filled in with a unique string that identifies the app and the applicationVersion should encode a representation of the application’s version.

See Also

InstanceCreateInfo, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrVersion

Constructors

ApplicationInfo

Fields

• applicationName :: ByteString

  applicationName is a non-empty string containing the name of the application.

  applicationName must be a null-terminated UTF-8 string whose length is less than or equal to MAX_APPLICATION_NAME_SIZE

• applicationVersion :: Word32

  applicationVersion is an unsigned integer variable containing the developer-supplied version number of the application.

• engineName :: ByteString

  engineName is a string containing the name of the engine (if any) used to create the application. It may be empty to indicate no specified engine.

  engineName must be a null-terminated UTF-8 string whose length is less than or equal to MAX_ENGINE_NAME_SIZE

• engineVersion :: Word32

  engineVersion is an unsigned integer variable containing the developer-supplied version number of the engine used to create the application. May be zero to indicate no specified engine.

• apiVersion :: Version

  apiVersion is the version of this API against which the application will run, encoded as described in the API Version Numbers and Semantics section. If the runtime does not support the requested apiVersion it must return ERROR_API_VERSION_UNSUPPORTED.

Instances

Show ApplicationInfo

Defined in OpenXR.Core10.Instance

Methods

showsPrec :: Int -> ApplicationInfo -> ShowS

show :: ApplicationInfo -> String

showList :: [ApplicationInfo] -> ShowS

Storable ApplicationInfo

Defined in OpenXR.Core10.Instance

Methods

sizeOf :: ApplicationInfo -> Int

alignment :: ApplicationInfo -> Int

peekElemOff :: Ptr ApplicationInfo -> Int -> IO ApplicationInfo

pokeElemOff :: Ptr ApplicationInfo -> Int -> ApplicationInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO ApplicationInfo

pokeByteOff :: Ptr b -> Int -> ApplicationInfo -> IO ()

peek :: Ptr ApplicationInfo -> IO ApplicationInfo

poke :: Ptr ApplicationInfo -> ApplicationInfo -> IO ()

Zero ApplicationInfo

Defined in OpenXR.Core10.Instance

Methods

zero :: ApplicationInfo

ToCStruct ApplicationInfo

Defined in OpenXR.Core10.Instance

Methods

withCStruct :: ApplicationInfo -> (Ptr ApplicationInfo -> IO b) -> IO b

pokeCStruct :: Ptr ApplicationInfo -> ApplicationInfo -> IO b -> IO b

withZeroCStruct :: (Ptr ApplicationInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr ApplicationInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ApplicationInfo

Defined in OpenXR.Core10.Instance

Methods

peekCStruct :: Ptr ApplicationInfo -> IO ApplicationInfo

data InstanceCreateInfo (es :: [Type])

XrInstanceCreateInfo - Structure specifying params of a newly created instance

Valid Usage (Implicit)

• type must be TYPE_INSTANCE_CREATE_INFO

• next must be NULL or a valid pointer to the next structure in a structure chain. See also: DebugUtilsMessengerCreateInfoEXT, InstanceCreateInfoAndroidKHR
• createFlags must be 0
• applicationInfo must be a valid ApplicationInfo structure
• If enabledApiLayerCount is not 0, enabledApiLayerNames must be a pointer to an array of enabledApiLayerCount null-terminated UTF-8 strings
• If enabledExtensionCount is not 0, enabledExtensionNames must be a pointer to an array of enabledExtensionCount null-terminated UTF-8 strings

See Also

ApplicationInfo, InstanceCreateFlags, StructureType, createInstance

Constructors

InstanceCreateInfo

Fields

• next :: Chain es

  next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.

• createFlags :: InstanceCreateFlags

  createFlags is a bitmask of InstanceCreateFlags that identifies options that apply to the creation.

• applicationInfo :: ApplicationInfo

  applicationInfo is an instance of ApplicationInfo. This information helps runtimes recognize behavior inherent to classes of applications. ApplicationInfo is defined in detail below.

• enabledApiLayerNames :: Vector ByteString

  enabledApiLayerNames is a pointer to an array of enabledApiLayerCount strings containing the names of API layers to enable for the created instance. See the API Layers And Extensions section for further details.

• enabledExtensionNames :: Vector ByteString

  enabledExtensionNames is a pointer to an array of enabledExtensionCount strings containing the names of extensions to enable.

Instances

Extensible InstanceCreateInfo

Defined in OpenXR.Core10.Instance

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). InstanceCreateInfo es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). InstanceCreateInfo ds -> Chain es -> InstanceCreateInfo es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends InstanceCreateInfo e => b) -> Maybe b

Show (Chain es) => Show (InstanceCreateInfo es)

Defined in OpenXR.Core10.Instance

Methods

showsPrec :: Int -> InstanceCreateInfo es -> ShowS

show :: InstanceCreateInfo es -> String

showList :: [InstanceCreateInfo es] -> ShowS

es ~ ('[] :: [Type]) => Zero (InstanceCreateInfo es)

Defined in OpenXR.Core10.Instance

Methods

zero :: InstanceCreateInfo es

(Extendss InstanceCreateInfo es, PokeChain es) => ToCStruct (InstanceCreateInfo es)

Defined in OpenXR.Core10.Instance

Methods

withCStruct :: InstanceCreateInfo es -> (Ptr (InstanceCreateInfo es) -> IO b) -> IO b

pokeCStruct :: Ptr (InstanceCreateInfo es) -> InstanceCreateInfo es -> IO b -> IO b

withZeroCStruct :: (Ptr (InstanceCreateInfo es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (InstanceCreateInfo es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

(Extendss InstanceCreateInfo es, PeekChain es) => FromCStruct (InstanceCreateInfo es)

Defined in OpenXR.Core10.Instance

Methods

peekCStruct :: Ptr (InstanceCreateInfo es) -> IO (InstanceCreateInfo es)

data InstanceProperties

XrInstanceProperties - Contains information about the instance

Valid Usage (Implicit)

See Also

StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrVersion, getInstanceProperties

Constructors

InstanceProperties

Fields

• runtimeVersion :: Version

  runtimeVersion is the runtime’s version (not necessarily related to an OpenXR API version), expressed in the format of MAKE_VERSION.

• runtimeName :: ByteString

  runtimeName is the name of the runtime.

Instances

Show InstanceProperties

Defined in OpenXR.Core10.Instance

Methods

showsPrec :: Int -> InstanceProperties -> ShowS

show :: InstanceProperties -> String

showList :: [InstanceProperties] -> ShowS

Storable InstanceProperties

Defined in OpenXR.Core10.Instance

Methods

sizeOf :: InstanceProperties -> Int

alignment :: InstanceProperties -> Int

peekElemOff :: Ptr InstanceProperties -> Int -> IO InstanceProperties

pokeElemOff :: Ptr InstanceProperties -> Int -> InstanceProperties -> IO ()

peekByteOff :: Ptr b -> Int -> IO InstanceProperties

pokeByteOff :: Ptr b -> Int -> InstanceProperties -> IO ()

peek :: Ptr InstanceProperties -> IO InstanceProperties

poke :: Ptr InstanceProperties -> InstanceProperties -> IO ()

Zero InstanceProperties

Defined in OpenXR.Core10.Instance

Methods

zero :: InstanceProperties

ToCStruct InstanceProperties

Defined in OpenXR.Core10.Instance

Methods

withCStruct :: InstanceProperties -> (Ptr InstanceProperties -> IO b) -> IO b

pokeCStruct :: Ptr InstanceProperties -> InstanceProperties -> IO b -> IO b

withZeroCStruct :: (Ptr InstanceProperties -> IO b) -> IO b

pokeZeroCStruct :: Ptr InstanceProperties -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct InstanceProperties

Defined in OpenXR.Core10.Instance

Methods

peekCStruct :: Ptr InstanceProperties -> IO InstanceProperties

data EventDataBuffer

XrEventDataBuffer - Event buffer

Valid Usage (Implicit)

See Also

EventDataBaseHeader, StructureType, pollEvent

Constructors

EventDataBuffer

Fields

• varying :: ByteString

  varying is a fixed sized output buffer big enough to hold returned data elements for all specified event data types.

Instances

Show EventDataBuffer

Defined in OpenXR.Core10.Instance

Methods

showsPrec :: Int -> EventDataBuffer -> ShowS

show :: EventDataBuffer -> String

showList :: [EventDataBuffer] -> ShowS

Storable EventDataBuffer

Defined in OpenXR.Core10.Instance

Methods

sizeOf :: EventDataBuffer -> Int

alignment :: EventDataBuffer -> Int

peekElemOff :: Ptr EventDataBuffer -> Int -> IO EventDataBuffer

pokeElemOff :: Ptr EventDataBuffer -> Int -> EventDataBuffer -> IO ()

peekByteOff :: Ptr b -> Int -> IO EventDataBuffer

pokeByteOff :: Ptr b -> Int -> EventDataBuffer -> IO ()

peek :: Ptr EventDataBuffer -> IO EventDataBuffer

poke :: Ptr EventDataBuffer -> EventDataBuffer -> IO ()

Zero EventDataBuffer

Defined in OpenXR.Core10.Instance

Methods

zero :: EventDataBuffer

ToCStruct EventDataBuffer

Defined in OpenXR.Core10.Instance

Methods

withCStruct :: EventDataBuffer -> (Ptr EventDataBuffer -> IO b) -> IO b

pokeCStruct :: Ptr EventDataBuffer -> EventDataBuffer -> IO b -> IO b

withZeroCStruct :: (Ptr EventDataBuffer -> IO b) -> IO b

pokeZeroCStruct :: Ptr EventDataBuffer -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct EventDataBuffer

Defined in OpenXR.Core10.Instance

Methods

peekCStruct :: Ptr EventDataBuffer -> IO EventDataBuffer