OpenXR.Core10.FundamentalTypes

Documentation

boolToBool32 :: Bool -> Bool32

bool32ToBool :: Bool32 -> Bool

data Offset2Df

XrOffset2Df - Float offset in two dimensions

Member Descriptions

Description

This structure is used for component values that may be fractional (floating-point). If used to represent physical distances, values must be in meters.

See Also

Extent2Df, Rect2Df

Constructors

Offset2Df

Fields

• x :: Float

  x the floating-point offset in the x direction.

• y :: Float

  y the floating-point offset in the y direction.

Instances

Eq Offset2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

(==) :: Offset2Df -> Offset2Df -> Bool

(/=) :: Offset2Df -> Offset2Df -> Bool

Show Offset2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

showsPrec :: Int -> Offset2Df -> ShowS

show :: Offset2Df -> String

showList :: [Offset2Df] -> ShowS

Storable Offset2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

sizeOf :: Offset2Df -> Int

alignment :: Offset2Df -> Int

peekElemOff :: Ptr Offset2Df -> Int -> IO Offset2Df

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

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

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

peek :: Ptr Offset2Df -> IO Offset2Df

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

Zero Offset2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

zero :: Offset2Df

ToCStruct Offset2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

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

pokeCStruct :: Ptr Offset2Df -> Offset2Df -> IO b -> IO b

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

pokeZeroCStruct :: Ptr Offset2Df -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Offset2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

peekCStruct :: Ptr Offset2Df -> IO Offset2Df

data Extent2Df

XrExtent2Df - Extent in two dimensions

Member Descriptions

Description

This structure is used for component values that may be fractional (floating-point). If used to represent physical distances, values must be in meters.

The width and height value must be non-negative.

See Also

CompositionLayerQuad, Offset2Df, Rect2Df, getReferenceSpaceBoundsRect

Constructors

Extent2Df

Fields

• width :: Float

  width the floating-point width of the extent.

• height :: Float

  height the floating-point height of the extent.

Instances

Eq Extent2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

(==) :: Extent2Df -> Extent2Df -> Bool

(/=) :: Extent2Df -> Extent2Df -> Bool

Show Extent2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

showsPrec :: Int -> Extent2Df -> ShowS

show :: Extent2Df -> String

showList :: [Extent2Df] -> ShowS

Storable Extent2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

sizeOf :: Extent2Df -> Int

alignment :: Extent2Df -> Int

peekElemOff :: Ptr Extent2Df -> Int -> IO Extent2Df

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

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

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

peek :: Ptr Extent2Df -> IO Extent2Df

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

Zero Extent2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

zero :: Extent2Df

ToCStruct Extent2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

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

pokeCStruct :: Ptr Extent2Df -> Extent2Df -> IO b -> IO b

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

pokeZeroCStruct :: Ptr Extent2Df -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Extent2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

peekCStruct :: Ptr Extent2Df -> IO Extent2Df

data Rect2Df

XrRect2Df - Rect in two dimensions

Member Descriptions

Description

This structure is used for component values that may be fractional (floating-point).

See Also

Extent2Df, Offset2Df

Constructors

Rect2Df

Fields

• offset :: Offset2Df

  offset is the Offset2Df specifying the rectangle offset.

• extent :: Extent2Df

  extent is the Extent2Df specifying the rectangle extent.

Instances

Show Rect2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

showsPrec :: Int -> Rect2Df -> ShowS

show :: Rect2Df -> String

showList :: [Rect2Df] -> ShowS

Storable Rect2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

sizeOf :: Rect2Df -> Int

alignment :: Rect2Df -> Int

peekElemOff :: Ptr Rect2Df -> Int -> IO Rect2Df

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

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

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

peek :: Ptr Rect2Df -> IO Rect2Df

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

Zero Rect2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

zero :: Rect2Df

ToCStruct Rect2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

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

pokeCStruct :: Ptr Rect2Df -> Rect2Df -> IO b -> IO b

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

pokeZeroCStruct :: Ptr Rect2Df -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Rect2Df

Defined in OpenXR.Core10.FundamentalTypes

Methods

peekCStruct :: Ptr Rect2Df -> IO Rect2Df

data Offset2Di

XrOffset2Di - Offset in two dimensions

Member Descriptions

Description

This variant is for representing discrete values such as texels. For representing physical distances, the floating-point variant must be used instead.

See Also

Extent2Di, Rect2Di

Constructors

Offset2Di

Fields

• x :: Int32

  x the integer offset in the x direction.

• y :: Int32

  y the integer offset in the y direction.

Instances

Eq Offset2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

(==) :: Offset2Di -> Offset2Di -> Bool

(/=) :: Offset2Di -> Offset2Di -> Bool

Show Offset2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

showsPrec :: Int -> Offset2Di -> ShowS

show :: Offset2Di -> String

showList :: [Offset2Di] -> ShowS

Storable Offset2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

sizeOf :: Offset2Di -> Int

alignment :: Offset2Di -> Int

peekElemOff :: Ptr Offset2Di -> Int -> IO Offset2Di

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

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

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

peek :: Ptr Offset2Di -> IO Offset2Di

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

Zero Offset2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

zero :: Offset2Di

ToCStruct Offset2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

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

pokeCStruct :: Ptr Offset2Di -> Offset2Di -> IO b -> IO b

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

pokeZeroCStruct :: Ptr Offset2Di -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Offset2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

peekCStruct :: Ptr Offset2Di -> IO Offset2Di

data Extent2Di

XrExtent2Di - Extent in two dimensions

Member Descriptions

Description

This variant is for representing discrete values such as texels. For representing physical distances, the floating-point variant must be used instead.

The width and height value must be non-negative.

See Also

Offset2Di, Rect2Di

Constructors

Extent2Di

Fields

• width :: Int32

  width the integer width of the extent.

• height :: Int32

  height the integer height of the extent.

Instances

Eq Extent2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

(==) :: Extent2Di -> Extent2Di -> Bool

(/=) :: Extent2Di -> Extent2Di -> Bool

Show Extent2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

showsPrec :: Int -> Extent2Di -> ShowS

show :: Extent2Di -> String

showList :: [Extent2Di] -> ShowS

Storable Extent2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

sizeOf :: Extent2Di -> Int

alignment :: Extent2Di -> Int

peekElemOff :: Ptr Extent2Di -> Int -> IO Extent2Di

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

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

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

peek :: Ptr Extent2Di -> IO Extent2Di

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

Zero Extent2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

zero :: Extent2Di

ToCStruct Extent2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

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

pokeCStruct :: Ptr Extent2Di -> Extent2Di -> IO b -> IO b

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

pokeZeroCStruct :: Ptr Extent2Di -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Extent2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

peekCStruct :: Ptr Extent2Di -> IO Extent2Di

data Rect2Di

XrRect2Di - Rect in two dimensions

Member Descriptions

Description

This variant is for representing discrete values such as texels. For representing physical distances, the floating-point variant must be used instead.

See Also

Extent2Di, Offset2Di, SwapchainSubImage

Constructors

Rect2Di

Fields

• offset :: Offset2Di

  offset is the Offset2Di specifying the integer rectangle offset.

• extent :: Extent2Di

  extent is the Extent2Di specifying the integer rectangle extent.

Instances

Show Rect2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

showsPrec :: Int -> Rect2Di -> ShowS

show :: Rect2Di -> String

showList :: [Rect2Di] -> ShowS

Storable Rect2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

sizeOf :: Rect2Di -> Int

alignment :: Rect2Di -> Int

peekElemOff :: Ptr Rect2Di -> Int -> IO Rect2Di

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

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

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

peek :: Ptr Rect2Di -> IO Rect2Di

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

Zero Rect2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

zero :: Rect2Di

ToCStruct Rect2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

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

pokeCStruct :: Ptr Rect2Di -> Rect2Di -> IO b -> IO b

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

pokeZeroCStruct :: Ptr Rect2Di -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Rect2Di

Defined in OpenXR.Core10.FundamentalTypes

Methods

peekCStruct :: Ptr Rect2Di -> IO Rect2Di

newtype Bool32

XrBool32 - Boolean value

Description

Boolean values used by OpenXR are of type https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrBool32 and are 32-bits wide as suggested by the name. The only valid values are the following:

Enumerant Descriptions

See Also

ActionStateBoolean, ActionStateFloat, ActionStatePose, ActionStateVector2f, EventDataMainSessionVisibilityChangedEXTX, EventDataReferenceSpaceChangePending, FrameState, HandJointLocationsEXT, HandMeshMSFT, SecondaryViewConfigurationStateMSFT, SystemEyeGazeInteractionPropertiesEXT, SystemHandTrackingMeshPropertiesMSFT, SystemHandTrackingPropertiesEXT, SystemTrackingProperties, ViewConfigurationProperties, xrSetInputDeviceActiveEXT, xrSetInputDeviceStateBoolEXT

Constructors

Bool32 Int32

Bundled Patterns

pattern FALSE :: Bool32

FALSE represents a false value.

pattern TRUE :: Bool32

TRUE represents a true value.

Instances

Eq Bool32

Defined in OpenXR.Core10.FundamentalTypes

Methods

(==) :: Bool32 -> Bool32 -> Bool

(/=) :: Bool32 -> Bool32 -> Bool

Ord Bool32

Defined in OpenXR.Core10.FundamentalTypes

Methods

compare :: Bool32 -> Bool32 -> Ordering

(<) :: Bool32 -> Bool32 -> Bool

(<=) :: Bool32 -> Bool32 -> Bool

(>) :: Bool32 -> Bool32 -> Bool

(>=) :: Bool32 -> Bool32 -> Bool

max :: Bool32 -> Bool32 -> Bool32

min :: Bool32 -> Bool32 -> Bool32

Read Bool32

Defined in OpenXR.Core10.FundamentalTypes

Methods

readsPrec :: Int -> ReadS Bool32

readList :: ReadS [Bool32]

readPrec :: ReadPrec Bool32

readListPrec :: ReadPrec [Bool32]

Show Bool32

Defined in OpenXR.Core10.FundamentalTypes

Methods

showsPrec :: Int -> Bool32 -> ShowS

show :: Bool32 -> String

showList :: [Bool32] -> ShowS

Storable Bool32

Defined in OpenXR.Core10.FundamentalTypes

Methods

sizeOf :: Bool32 -> Int

alignment :: Bool32 -> Int

peekElemOff :: Ptr Bool32 -> Int -> IO Bool32

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

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

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

peek :: Ptr Bool32 -> IO Bool32

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

Zero Bool32

Defined in OpenXR.Core10.FundamentalTypes

Methods

zero :: Bool32

type Flags64 = Word64

XrFlags64 - OpenXR bitmasks

Description

Bitmasks are passed to many functions and structures to compactly represent options and are stored in memory defined by the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrFlags64 type. But the API does not use the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrFlags64 type directly. Instead, a Xr*Flags type is used which is an alias of the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrFlags64 type. The API also defines a set of constant bit definitions used to set the bitmasks.

See Also

CompositionLayerFlags, InstanceCreateFlags, SessionCreateFlags, SpaceLocationFlags, SwapchainCreateFlags, SwapchainUsageFlags, ViewStateFlags

type Time = Int64

XrTime - Basic type for time

Description

https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime is a base value type that represents time as a signed 64-bit integer, representing the monotonically-increasing count of nanoseconds that have elapsed since a runtime-chosen epoch. https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime always represents the time elasped since that constant epoch, rather than a duration or a time point relative to some moving epoch such as vsync time, etc. Durations are instead represented by https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrDuration.

A single runtime must use the same epoch for all simultaneous applications. Time must be represented the same regardless of multiple processors or threads present in the system.

The period precision of time reported by the runtime is runtime-dependent, and may change. One nanosecond is the finest possible period precision. A runtime may, for example, report time progression with only microsecond-level granularity.

Time must not be assumed to correspond to a system clock time.

Unless specified otherwise, zero or a negative value is not a valid https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, and related functions must return error ERROR_TIME_INVALID. Applications must not initialize such https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime fields to a zero value. Instead, applications should always assign https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime fields to the meaningful point in time they are choosing to reason about, such as a frame’s predicted display time, or an action’s last change time.

The behavior of a runtime is undefined when time overflows beyond the maximum positive value that can be represented by an https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime. Runtimes should choose an epoch that minimizes the chance of overflow. Runtimes should also choose an epoch that minimizes the chance of underflow below 0 for applications performing a reasonable amount of historical pose lookback. For example, if the runtime chooses an epoch relative to its startup time, it should push the epoch into the past by enough time to avoid applications performing reasonable pose lookback from reaching a negative https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime value.

An application cannot assume that the system’s clock and the runtime’s clock will maintain a constant relationship across frames and should avoid storing such an offset, as this may cause time drift. Applications should instead always use time interop functions to convert a relevant time point across the system’s clock and the runtime’s clock using extensions, for example, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_KHR_win32_convert_performance_counter_time or https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_KHR_convert_timespec_time.

See Also

ActionStateBoolean, ActionStateFloat, ActionStateVector2f, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrDuration, EventDataInstanceLossPending, EventDataReferenceSpaceChangePending, EventDataSessionStateChanged, EyeGazeSampleTimeEXT, FrameEndInfo, FrameState, HandJointsLocateInfoEXT, HandMeshUpdateInfoMSFT, HandMeshVertexBufferMSFT, SpatialAnchorCreateInfoMSFT, ViewLocateInfo, convertTimeToTimespecTimeKHR, convertTimeToWin32PerformanceCounterKHR, convertTimespecTimeToTimeKHR, convertWin32PerformanceCounterToTimeKHR, locateSpace

type Duration = Int64

XrDuration - Bounded range of time

Description

The difference between two timepoints is a duration, and thus the difference between two https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime values is an https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrDuration value.

Functions that refer to durations use https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrDuration as opposed to https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime.

See Also

FrameState, HapticVibration, SwapchainImageWaitInfo, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime