Safe Haskell	None
Language	Haskell2010

OpenXR.Core10.Device

Synopsis

getSystem :: forall io. MonadIO io => Instance -> SystemGetInfo -> io SystemId
getSystemProperties :: forall a io. (Extendss SystemProperties a, PokeChain a, PeekChain a, MonadIO io) => Instance -> SystemId -> io (SystemProperties a)
createSession :: forall a io. (Extendss SessionCreateInfo a, PokeChain a, MonadIO io) => Instance -> SessionCreateInfo a -> io Session
withSession :: forall a io r. (Extendss SessionCreateInfo a, PokeChain a, MonadIO io) => Instance -> SessionCreateInfo a -> (io Session -> (Session -> io ()) -> r) -> r
destroySession :: forall io. MonadIO io => Session -> io ()
enumerateEnvironmentBlendModes :: forall io. MonadIO io => Instance -> SystemId -> ViewConfigurationType -> io ("environmentBlendModes" ::: Vector EnvironmentBlendMode)
newtype SystemId = SystemId Word64
data SystemGetInfo = SystemGetInfo {
- formFactor :: FormFactor
}
data SystemProperties (es :: [Type]) = SystemProperties {
- next :: Chain es
- systemId :: SystemId
- vendorId :: Word32
- systemName :: ByteString
- graphicsProperties :: SystemGraphicsProperties
- trackingProperties :: SystemTrackingProperties
}
data SystemGraphicsProperties = SystemGraphicsProperties {
- maxSwapchainImageHeight :: Word32
- maxSwapchainImageWidth :: Word32
- maxLayerCount :: Word32
}
data SystemTrackingProperties = SystemTrackingProperties {
- orientationTracking :: Bool
- positionTracking :: Bool
}
data SessionCreateInfo (es :: [Type]) = SessionCreateInfo {
- next :: Chain es
- createFlags :: SessionCreateFlags
- systemId :: SystemId
}

Documentation

getSystem Source #

Arguments

:: forall io. MonadIO io
=> Instance	`instance` is the handle of the instance from which to get the information. `instance` must be a valid `Instance` handle
-> SystemGetInfo	`getInfo` is a pointer to an `SystemGetInfo` structure containing the application’s requests for a system. `getInfo` must be a pointer to a valid `SystemGetInfo` structure
-> io SystemId

xrGetSystem - Gets a system identifier

Parameter Descriptions

Description

To get an https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrSystemId, an application specifies its desired form factor to getSystem and gets the runtime’s https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrSystemId associated with that configuration.

If the form factor is supported but temporarily unavailable, getSystem must return ERROR_FORM_FACTOR_UNAVAILABLE. A runtime may return SUCCESS on a subsequent call for a form factor it previously returned ERROR_FORM_FACTOR_UNAVAILABLE. For example, connecting or warming up hardware might cause an unavailable form factor to become available.

Return Codes

Success

SUCCESS

Failure

Description

An application can call getSystemProperties to retrieve information about the system such as vendor ID, system name, and graphics and tracking properties.

Return Codes

Success

SUCCESS

Failure

Description

Creates a session using the provided createInfo and returns a handle to that session. This session is created in the SESSION_STATE_IDLE state, and a corresponding EventDataSessionStateChanged event to the SESSION_STATE_IDLE state must be generated as the first such event for the new session.

Return Codes

Success

SUCCESS

Failure

Description

Session handles are destroyed using destroySession. When an Session is destroyed, all handles that are children of that Session are also destroyed.

The application is responsible for ensuring that it has no calls using session in progress when the session is destroyed.

destroySession can be called when the session is in any session state.

Valid Usage (Implicit)

session must be a valid Session handle

Thread Safety

Access to session, and any child handles, must be externally synchronized

Return Codes

Success

SUCCESS

Failure

ERROR_HANDLE_INVALID

Description

Enumerates the set of environment blend modes that this runtime supports for a given view configuration of the system. Environment blend modes should be in order from highest to lowest runtime preference.

Runtimes must always return identical buffer contents from this enumeration for the given systemId and viewConfigurationType for the lifetime of the instance.

Valid Usage (Implicit)

instance must be a valid Instance handle

viewConfigurationType must be a valid ViewConfigurationType value
environmentBlendModeCountOutput must be a pointer to a uint32_t value
If environmentBlendModeCapacityInput is not 0, environmentBlendModes must be a pointer to an array of environmentBlendModeCapacityInput EnvironmentBlendMode values

Return Codes

Success

SUCCESS

Failure

Description

An https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrSystemId is an opaque atom used by the runtime to identify a system. The value NULL_SYSTEM_ID is considered an invalid system.

Description

The SystemGetInfo structure specifies attributes about a system as desired by an application.

Eq SystemId Source #
Instance details Defined in OpenXR.Core10.Device Methods (==) :: SystemId -> SystemId -> Bool # (/=) :: SystemId -> SystemId -> Bool #
Ord SystemId Source #
Instance details Defined in OpenXR.Core10.Device Methods compare :: SystemId -> SystemId -> Ordering # (<) :: SystemId -> SystemId -> Bool # (<=) :: SystemId -> SystemId -> Bool # (>) :: SystemId -> SystemId -> Bool # (>=) :: SystemId -> SystemId -> Bool # max :: SystemId -> SystemId -> SystemId # min :: SystemId -> SystemId -> SystemId #
Show SystemId Source #
Instance details Defined in OpenXR.Core10.Device Methods showsPrec :: Int -> SystemId -> ShowS # show :: SystemId -> String # showList :: [SystemId] -> ShowS #
Storable SystemId Source #
Instance details Defined in OpenXR.Core10.Device Methods sizeOf :: SystemId -> Int # alignment :: SystemId -> Int # peekElemOff :: Ptr SystemId -> Int -> IO SystemId # pokeElemOff :: Ptr SystemId -> Int -> SystemId -> IO () # peekByteOff :: Ptr b -> Int -> IO SystemId # pokeByteOff :: Ptr b -> Int -> SystemId -> IO () # peek :: Ptr SystemId -> IO SystemId # poke :: Ptr SystemId -> SystemId -> IO () #
Zero SystemId Source #
Instance details Defined in OpenXR.Core10.Device Methods zero :: SystemId #

Eq SystemGetInfo Source #
Instance details Defined in OpenXR.Core10.Device Methods (==) :: SystemGetInfo -> SystemGetInfo -> Bool # (/=) :: SystemGetInfo -> SystemGetInfo -> Bool #
Show SystemGetInfo Source #
Instance details Defined in OpenXR.Core10.Device Methods showsPrec :: Int -> SystemGetInfo -> ShowS # show :: SystemGetInfo -> String # showList :: [SystemGetInfo] -> ShowS #
Storable SystemGetInfo Source #
Instance details Defined in OpenXR.Core10.Device Methods sizeOf :: SystemGetInfo -> Int # alignment :: SystemGetInfo -> Int # peekElemOff :: Ptr SystemGetInfo -> Int -> IO SystemGetInfo # pokeElemOff :: Ptr SystemGetInfo -> Int -> SystemGetInfo -> IO () # peekByteOff :: Ptr b -> Int -> IO SystemGetInfo # pokeByteOff :: Ptr b -> Int -> SystemGetInfo -> IO () # peek :: Ptr SystemGetInfo -> IO SystemGetInfo # poke :: Ptr SystemGetInfo -> SystemGetInfo -> IO () #
Zero SystemGetInfo Source #
Instance details Defined in OpenXR.Core10.Device Methods zero :: SystemGetInfo #
ToCStruct SystemGetInfo Source #
Instance details Defined in OpenXR.Core10.Device Methods withCStruct :: SystemGetInfo -> (Ptr SystemGetInfo -> IO b) -> IO b # pokeCStruct :: Ptr SystemGetInfo -> SystemGetInfo -> IO b -> IO b # withZeroCStruct :: (Ptr SystemGetInfo -> IO b) -> IO b # pokeZeroCStruct :: Ptr SystemGetInfo -> IO b -> IO b # cStructSize :: Int # cStructAlignment :: Int #
FromCStruct SystemGetInfo Source #
Instance details Defined in OpenXR.Core10.Device Methods peekCStruct :: Ptr SystemGetInfo -> IO SystemGetInfo #

Extensible SystemProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods extensibleTypeName :: String Source # getNext :: forall (es :: [Type]). SystemProperties es -> Chain es Source # setNext :: forall (ds :: [Type]) (es :: [Type]). SystemProperties ds -> Chain es -> SystemProperties es Source # extends :: forall e b proxy. Typeable e => proxy e -> (Extends SystemProperties e => b) -> Maybe b Source #
Show (Chain es) => Show (SystemProperties es) Source #
Instance details Defined in OpenXR.Core10.Device Methods showsPrec :: Int -> SystemProperties es -> ShowS # show :: SystemProperties es -> String # showList :: [SystemProperties es] -> ShowS #
es ~ ('[] :: [Type]) => Zero (SystemProperties es) Source #
Instance details Defined in OpenXR.Core10.Device Methods zero :: SystemProperties es #
(Extendss SystemProperties es, PokeChain es) => ToCStruct (SystemProperties es) Source #
Instance details Defined in OpenXR.Core10.Device Methods withCStruct :: SystemProperties es -> (Ptr (SystemProperties es) -> IO b) -> IO b # pokeCStruct :: Ptr (SystemProperties es) -> SystemProperties es -> IO b -> IO b # withZeroCStruct :: (Ptr (SystemProperties es) -> IO b) -> IO b # pokeZeroCStruct :: Ptr (SystemProperties es) -> IO b -> IO b # cStructSize :: Int # cStructAlignment :: Int #
(Extendss SystemProperties es, PeekChain es) => FromCStruct (SystemProperties es) Source #
Instance details Defined in OpenXR.Core10.Device Methods peekCStruct :: Ptr (SystemProperties es) -> IO (SystemProperties es) #

Eq SystemGraphicsProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods (==) :: SystemGraphicsProperties -> SystemGraphicsProperties -> Bool # (/=) :: SystemGraphicsProperties -> SystemGraphicsProperties -> Bool #
Show SystemGraphicsProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods showsPrec :: Int -> SystemGraphicsProperties -> ShowS # show :: SystemGraphicsProperties -> String # showList :: [SystemGraphicsProperties] -> ShowS #
Storable SystemGraphicsProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods sizeOf :: SystemGraphicsProperties -> Int # alignment :: SystemGraphicsProperties -> Int # peekElemOff :: Ptr SystemGraphicsProperties -> Int -> IO SystemGraphicsProperties # pokeElemOff :: Ptr SystemGraphicsProperties -> Int -> SystemGraphicsProperties -> IO () # peekByteOff :: Ptr b -> Int -> IO SystemGraphicsProperties # pokeByteOff :: Ptr b -> Int -> SystemGraphicsProperties -> IO () # peek :: Ptr SystemGraphicsProperties -> IO SystemGraphicsProperties # poke :: Ptr SystemGraphicsProperties -> SystemGraphicsProperties -> IO () #
Zero SystemGraphicsProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods zero :: SystemGraphicsProperties #
ToCStruct SystemGraphicsProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods withCStruct :: SystemGraphicsProperties -> (Ptr SystemGraphicsProperties -> IO b) -> IO b # pokeCStruct :: Ptr SystemGraphicsProperties -> SystemGraphicsProperties -> IO b -> IO b # withZeroCStruct :: (Ptr SystemGraphicsProperties -> IO b) -> IO b # pokeZeroCStruct :: Ptr SystemGraphicsProperties -> IO b -> IO b # cStructSize :: Int # cStructAlignment :: Int #
FromCStruct SystemGraphicsProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods peekCStruct :: Ptr SystemGraphicsProperties -> IO SystemGraphicsProperties #

Eq SystemTrackingProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods (==) :: SystemTrackingProperties -> SystemTrackingProperties -> Bool # (/=) :: SystemTrackingProperties -> SystemTrackingProperties -> Bool #
Show SystemTrackingProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods showsPrec :: Int -> SystemTrackingProperties -> ShowS # show :: SystemTrackingProperties -> String # showList :: [SystemTrackingProperties] -> ShowS #
Storable SystemTrackingProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods sizeOf :: SystemTrackingProperties -> Int # alignment :: SystemTrackingProperties -> Int # peekElemOff :: Ptr SystemTrackingProperties -> Int -> IO SystemTrackingProperties # pokeElemOff :: Ptr SystemTrackingProperties -> Int -> SystemTrackingProperties -> IO () # peekByteOff :: Ptr b -> Int -> IO SystemTrackingProperties # pokeByteOff :: Ptr b -> Int -> SystemTrackingProperties -> IO () # peek :: Ptr SystemTrackingProperties -> IO SystemTrackingProperties # poke :: Ptr SystemTrackingProperties -> SystemTrackingProperties -> IO () #
Zero SystemTrackingProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods zero :: SystemTrackingProperties #
ToCStruct SystemTrackingProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods withCStruct :: SystemTrackingProperties -> (Ptr SystemTrackingProperties -> IO b) -> IO b # pokeCStruct :: Ptr SystemTrackingProperties -> SystemTrackingProperties -> IO b -> IO b # withZeroCStruct :: (Ptr SystemTrackingProperties -> IO b) -> IO b # pokeZeroCStruct :: Ptr SystemTrackingProperties -> IO b -> IO b # cStructSize :: Int # cStructAlignment :: Int #
FromCStruct SystemTrackingProperties Source #
Instance details Defined in OpenXR.Core10.Device Methods peekCStruct :: Ptr SystemTrackingProperties -> IO SystemTrackingProperties #

:: forall a io. (Extendss SystemProperties a, PokeChain a, PeekChain a, MonadIO io)
=> Instance	`instance` is the instance from which `systemId` was retrieved. `instance` must be a valid `Instance` handle
-> SystemId	`systemId` is the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrSystemId whose properties will be queried.
-> io (SystemProperties a)

:: forall a io. (Extendss SessionCreateInfo a, PokeChain a, MonadIO io)
=> Instance	`instance` is the instance from which `systemId` was retrieved. `instance` must be a valid `Instance` handle
-> SessionCreateInfo a	`createInfo` is a pointer to an `SessionCreateInfo` structure containing information about how to create the session. `createInfo` must be a pointer to a valid `SessionCreateInfo` structure
-> io Session

:: forall io. MonadIO io
=> Session	`session` is the session to destroy.
-> io ()

SystemGetInfo
Fields formFactor :: FormFactor `formFactor` is the `FormFactor` requested by the application. `formFactor` must be a valid `FormFactor` value

SystemTrackingProperties
Fields orientationTracking :: Bool `orientationTracking` is set to `TRUE` to indicate the system supports orientational tracking of the view pose(s), `FALSE` otherwise. positionTracking :: Bool `positionTracking` is set to `TRUE` to indicate the system supports positional tracking of the view pose(s), `FALSE` otherwise.

Extensible SessionCreateInfo Source #
Instance details Defined in OpenXR.Core10.Device Methods extensibleTypeName :: String Source # getNext :: forall (es :: [Type]). SessionCreateInfo es -> Chain es Source # setNext :: forall (ds :: [Type]) (es :: [Type]). SessionCreateInfo ds -> Chain es -> SessionCreateInfo es Source # extends :: forall e b proxy. Typeable e => proxy e -> (Extends SessionCreateInfo e => b) -> Maybe b Source #
Show (Chain es) => Show (SessionCreateInfo es) Source #
Instance details Defined in OpenXR.Core10.Device Methods showsPrec :: Int -> SessionCreateInfo es -> ShowS # show :: SessionCreateInfo es -> String # showList :: [SessionCreateInfo es] -> ShowS #
es ~ ('[] :: [Type]) => Zero (SessionCreateInfo es) Source #
Instance details Defined in OpenXR.Core10.Device Methods zero :: SessionCreateInfo es #
(Extendss SessionCreateInfo es, PokeChain es) => ToCStruct (SessionCreateInfo es) Source #
Instance details Defined in OpenXR.Core10.Device Methods withCStruct :: SessionCreateInfo es -> (Ptr (SessionCreateInfo es) -> IO b) -> IO b # pokeCStruct :: Ptr (SessionCreateInfo es) -> SessionCreateInfo es -> IO b -> IO b # withZeroCStruct :: (Ptr (SessionCreateInfo es) -> IO b) -> IO b # pokeZeroCStruct :: Ptr (SessionCreateInfo es) -> IO b -> IO b # cStructSize :: Int # cStructAlignment :: Int #
(Extendss SessionCreateInfo es, PeekChain es) => FromCStruct (SessionCreateInfo es) Source #
Instance details Defined in OpenXR.Core10.Device Methods peekCStruct :: Ptr (SessionCreateInfo es) -> IO (SessionCreateInfo es) #

Documentation

Parameter Descriptions

Description

Return Codes

See Also

Parameter Descriptions

Description

Return Codes

See Also

Parameter Descriptions

Description

Return Codes

See Also

Parameter Descriptions

Description

Valid Usage (Implicit)

Thread Safety

Return Codes

See Also

Parameter Descriptions

Description

Valid Usage (Implicit)

Return Codes

See Also

Description

See Also

Instances

Member Descriptions

Description

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Member Descriptions

See Also

Instances

Member Descriptions

See Also

Instances

Valid Usage (Implicit)

See Also

Instances