Safe Haskell	None
Language	Haskell2010

OpenXR.Extensions.XR_EXTX_overlay

Description

Name

XR_EXTX_overlay - instance extension

Specification

See XR_EXTX_overlay in the main specification for complete information.

Registered Extension Number

34

Revision

4

Extension and Version Dependencies

Requires OpenXR 1.0

Document Notes

For more information, see the OpenXR Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

data SessionCreateInfoOverlayEXTX = SessionCreateInfoOverlayEXTX {
- createFlags :: OverlaySessionCreateFlagsEXTX
- sessionLayersPlacement :: Word32
}
data EventDataMainSessionVisibilityChangedEXTX = EventDataMainSessionVisibilityChangedEXTX {
- visible :: Bool
- flags :: OverlayMainSessionFlagsEXTX
}
newtype OverlayMainSessionFlagsEXTX = OverlayMainSessionFlagsEXTX Flags64
newtype OverlaySessionCreateFlagsEXTX = OverlaySessionCreateFlagsEXTX Flags64
type EXTX_overlay_SPEC_VERSION = 4
pattern EXTX_overlay_SPEC_VERSION :: forall a. Integral a => a
type EXTX_OVERLAY_EXTENSION_NAME = "XR_EXTX_overlay"
pattern EXTX_OVERLAY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

data SessionCreateInfoOverlayEXTX Source #

XrSessionCreateInfoOverlayEXTX - Session creation extension struct providing overlay session parameters

Valid Usage (Implicit)

The @@ extension must be enabled prior to using SessionCreateInfoOverlayEXTX

type must be TYPE_SESSION_CREATE_INFO_OVERLAY_EXTX
next must be NULL or a valid pointer to the next structure in a structure chain
createFlags must be a valid combination of XrOverlaySessionCreateFlagBitsEXTX values
createFlags must not be 0

Members

Receiving the EventDataMainSessionVisibilityChangedEXTX event structure indicates that the main session has gained or lost visibility. This can occur in many cases, one typical example is when a user switches from one OpenXR application to another. See EventDataMainSessionVisibilityChangedEXTX for more information on the standard behavior. This structure contains additional information on the main session including flags which indicate additional state information of the main session. Currently, the only flag value supplied is XR_OVERLAY_MAIN_SESSION_ENABLED_COMPOSITION_LAYER_INFO_DEPTH_BIT_EXTX which indicates if the main session has enabled the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_KHR_composition_layer_depth extension.

Member Descriptions

type is the StructureType of this structure.

next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.
visible is an https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrBool32 which indicates if session is now visible or is not.
flags is 0 or one or more XrOverlayMainSessionFlagBitsEXTX which indicates various state information for the main session.

Valid Usage (Implicit)

The @@ extension must be enabled prior to using EventDataMainSessionVisibilityChangedEXTX

type must be TYPE_EVENT_DATA_MAIN_SESSION_VISIBILITY_CHANGED_EXTX
next must be NULL or a valid pointer to the next structure in a structure chain
flags must be a valid combination of XrOverlayMainSessionFlagBitsEXTX values
flags must not be 0

Eq OverlayMainSessionFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods (==) :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> Bool # (/=) :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> Bool #
Ord OverlayMainSessionFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods compare :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> Ordering # (<) :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> Bool # (<=) :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> Bool # (>) :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> Bool # (>=) :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> Bool # max :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX # min :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX #
Read OverlayMainSessionFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods readsPrec :: Int -> ReadS OverlayMainSessionFlagsEXTX # readList :: ReadS [OverlayMainSessionFlagsEXTX] # readPrec :: ReadPrec OverlayMainSessionFlagsEXTX # readListPrec :: ReadPrec [OverlayMainSessionFlagsEXTX] #
Show OverlayMainSessionFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods showsPrec :: Int -> OverlayMainSessionFlagsEXTX -> ShowS # show :: OverlayMainSessionFlagsEXTX -> String # showList :: [OverlayMainSessionFlagsEXTX] -> ShowS #
Storable OverlayMainSessionFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods sizeOf :: OverlayMainSessionFlagsEXTX -> Int # alignment :: OverlayMainSessionFlagsEXTX -> Int # peekElemOff :: Ptr OverlayMainSessionFlagsEXTX -> Int -> IO OverlayMainSessionFlagsEXTX # pokeElemOff :: Ptr OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX -> IO () # peekByteOff :: Ptr b -> Int -> IO OverlayMainSessionFlagsEXTX # pokeByteOff :: Ptr b -> Int -> OverlayMainSessionFlagsEXTX -> IO () # peek :: Ptr OverlayMainSessionFlagsEXTX -> IO OverlayMainSessionFlagsEXTX # poke :: Ptr OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> IO () #
Bits OverlayMainSessionFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods (.&.) :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX # (.\|.) :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX # xor :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX # complement :: OverlayMainSessionFlagsEXTX -> OverlayMainSessionFlagsEXTX # shift :: OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX # rotate :: OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX # zeroBits :: OverlayMainSessionFlagsEXTX # bit :: Int -> OverlayMainSessionFlagsEXTX # setBit :: OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX # clearBit :: OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX # complementBit :: OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX # testBit :: OverlayMainSessionFlagsEXTX -> Int -> Bool # bitSizeMaybe :: OverlayMainSessionFlagsEXTX -> Maybe Int # bitSize :: OverlayMainSessionFlagsEXTX -> Int # isSigned :: OverlayMainSessionFlagsEXTX -> Bool # shiftL :: OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX # unsafeShiftL :: OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX # shiftR :: OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX # unsafeShiftR :: OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX # rotateL :: OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX # rotateR :: OverlayMainSessionFlagsEXTX -> Int -> OverlayMainSessionFlagsEXTX # popCount :: OverlayMainSessionFlagsEXTX -> Int #
FiniteBits OverlayMainSessionFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods finiteBitSize :: OverlayMainSessionFlagsEXTX -> Int # countLeadingZeros :: OverlayMainSessionFlagsEXTX -> Int # countTrailingZeros :: OverlayMainSessionFlagsEXTX -> Int #
Zero OverlayMainSessionFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods zero :: OverlayMainSessionFlagsEXTX #

newtype OverlaySessionCreateFlagsEXTX Source #

XrOverlaySessionCreateFlagsEXTX - XrOverlaySessionCreateFlagsEXTX

Eq OverlaySessionCreateFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods (==) :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> Bool # (/=) :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> Bool #
Ord OverlaySessionCreateFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods compare :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> Ordering # (<) :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> Bool # (<=) :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> Bool # (>) :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> Bool # (>=) :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> Bool # max :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX # min :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX #
Read OverlaySessionCreateFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods readsPrec :: Int -> ReadS OverlaySessionCreateFlagsEXTX # readList :: ReadS [OverlaySessionCreateFlagsEXTX] # readPrec :: ReadPrec OverlaySessionCreateFlagsEXTX # readListPrec :: ReadPrec [OverlaySessionCreateFlagsEXTX] #
Show OverlaySessionCreateFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods showsPrec :: Int -> OverlaySessionCreateFlagsEXTX -> ShowS # show :: OverlaySessionCreateFlagsEXTX -> String # showList :: [OverlaySessionCreateFlagsEXTX] -> ShowS #
Storable OverlaySessionCreateFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods sizeOf :: OverlaySessionCreateFlagsEXTX -> Int # alignment :: OverlaySessionCreateFlagsEXTX -> Int # peekElemOff :: Ptr OverlaySessionCreateFlagsEXTX -> Int -> IO OverlaySessionCreateFlagsEXTX # pokeElemOff :: Ptr OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX -> IO () # peekByteOff :: Ptr b -> Int -> IO OverlaySessionCreateFlagsEXTX # pokeByteOff :: Ptr b -> Int -> OverlaySessionCreateFlagsEXTX -> IO () # peek :: Ptr OverlaySessionCreateFlagsEXTX -> IO OverlaySessionCreateFlagsEXTX # poke :: Ptr OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> IO () #
Bits OverlaySessionCreateFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods (.&.) :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX # (.\|.) :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX # xor :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX # complement :: OverlaySessionCreateFlagsEXTX -> OverlaySessionCreateFlagsEXTX # shift :: OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX # rotate :: OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX # zeroBits :: OverlaySessionCreateFlagsEXTX # bit :: Int -> OverlaySessionCreateFlagsEXTX # setBit :: OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX # clearBit :: OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX # complementBit :: OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX # testBit :: OverlaySessionCreateFlagsEXTX -> Int -> Bool # bitSizeMaybe :: OverlaySessionCreateFlagsEXTX -> Maybe Int # bitSize :: OverlaySessionCreateFlagsEXTX -> Int # isSigned :: OverlaySessionCreateFlagsEXTX -> Bool # shiftL :: OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX # unsafeShiftL :: OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX # shiftR :: OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX # unsafeShiftR :: OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX # rotateL :: OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX # rotateR :: OverlaySessionCreateFlagsEXTX -> Int -> OverlaySessionCreateFlagsEXTX # popCount :: OverlaySessionCreateFlagsEXTX -> Int #
FiniteBits OverlaySessionCreateFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods finiteBitSize :: OverlaySessionCreateFlagsEXTX -> Int # countLeadingZeros :: OverlaySessionCreateFlagsEXTX -> Int # countTrailingZeros :: OverlaySessionCreateFlagsEXTX -> Int #
Zero OverlaySessionCreateFlagsEXTX Source #
Instance details Defined in OpenXR.Extensions.XR_EXTX_overlay Methods zero :: OverlaySessionCreateFlagsEXTX #

type EXTX_overlay_SPEC_VERSION = 4 Source #

pattern EXTX_overlay_SPEC_VERSION :: forall a. Integral a => a Source #

type EXTX_OVERLAY_EXTENSION_NAME = "XR_EXTX_overlay" Source #

pattern EXTX_OVERLAY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #

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

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

Name

Specification

Registered Extension Number

Revision

Extension and Version Dependencies

See Also

Document Notes

Documentation

Valid Usage (Implicit)

See Also

Instances

Members

Member Descriptions

Valid Usage (Implicit)

See Also

Instances

See Also

Instances

See Also

Instances

SessionCreateInfoOverlayEXTX
Fields createFlags :: OverlaySessionCreateFlagsEXTX `createFlags` is `0` or one or more XrOverlaySessionCreateFlagBitsEXTX which indicate various characteristics desired for the overlay session. sessionLayersPlacement :: Word32 `sessionLayersPlacement` is a value indicating the desired placement of the session’s composition layers in terms of other sessions.

EventDataMainSessionVisibilityChangedEXTX
Fields visible :: Bool flags :: OverlayMainSessionFlagsEXTX