OpenXR.Core10.OtherTypes

Documentation

data Vector4f

XrVector4f - Four-dimensional vector

Member Descriptions

Description

If used to represent physical distances, x, y, and z values must be in meters.

See Also

Posef, Quaternionf, Vector2f, Vector3f

Constructors

Vector4f

Fields

• x :: Float

  x is the x coordinate of the vector.

• y :: Float

  y is the y coordinate of the vector.

• z :: Float

  z is the z coordinate of the vector.

• w :: Float

  w is the w coordinate of the vector.

Instances

Eq Vector4f

Defined in OpenXR.Core10.OtherTypes

Methods

(==) :: Vector4f -> Vector4f -> Bool

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

Show Vector4f

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> Vector4f -> ShowS

show :: Vector4f -> String

showList :: [Vector4f] -> ShowS

Storable Vector4f

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: Vector4f -> Int

alignment :: Vector4f -> Int

peekElemOff :: Ptr Vector4f -> Int -> IO Vector4f

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

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

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

peek :: Ptr Vector4f -> IO Vector4f

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

Zero Vector4f

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: Vector4f

ToCStruct Vector4f

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr Vector4f -> Vector4f -> IO b -> IO b

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

pokeZeroCStruct :: Ptr Vector4f -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Vector4f

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr Vector4f -> IO Vector4f

data Color4f

XrColor4f - Color Vector

Member Descriptions

Description

Unless otherwise specified, colors are encoded as linear (not with sRGB nor other gamma compression) values with individual components being in the range of 0.0 through 1.0, and without the RGB components being premultiplied by the alpha component.

See Also

CompositionLayerColorScaleBiasKHR

Constructors

Color4f

Fields

• r :: Float

  r is the red component of the color.

• g :: Float

  g is the green component of the color.

• b :: Float

  b is the blue component of the color.

• a :: Float

  a is the alpha component of the color.

Instances

Eq Color4f

Defined in OpenXR.Core10.OtherTypes

Methods

(==) :: Color4f -> Color4f -> Bool

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

Show Color4f

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> Color4f -> ShowS

show :: Color4f -> String

showList :: [Color4f] -> ShowS

Storable Color4f

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: Color4f -> Int

alignment :: Color4f -> Int

peekElemOff :: Ptr Color4f -> Int -> IO Color4f

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

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

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

peek :: Ptr Color4f -> IO Color4f

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

Zero Color4f

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: Color4f

ToCStruct Color4f

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr Color4f -> Color4f -> IO b -> IO b

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

pokeZeroCStruct :: Ptr Color4f -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Color4f

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr Color4f -> IO Color4f

data Fovf

XrFovf - Field of view

Member Descriptions

Description

Angles to the right of the center and upwards from the center are positive, and angles to the left of the center and down from the center are negative. The total horizontal field of view is angleRight minus angleLeft, and the total vertical field of view is angleUp minus angleDown. For a symmetric FoV, angleRight and angleUp will have positive values, angleLeft will be -angleRight, and angleDown will be -angleUp.

The angles must be specified in radians, and must be between -π/2 and π/2 exclusively.

When angleLeft > angleRight, the content of the view must be flipped horizontally. When angleDown > angleUp, the content of the view must be flipped vertically.

See Also

CompositionLayerProjectionView, View, ViewConfigurationViewFovEPIC

Constructors

Fovf

Fields

• angleLeft :: Float

  angleLeft is the angle of the left side of the field of view. For a symmetric field of view this value is negative.

• angleRight :: Float

  angleRight is the angle of the right side of the field of view.

• angleUp :: Float

  angleUp is the angle of the top part of the field of view.

• angleDown :: Float

  angleDown is the angle of the bottom part of the field of view. For a symmetric field of view this value is negative.

Instances

Eq Fovf

Defined in OpenXR.Core10.OtherTypes

Methods

(==) :: Fovf -> Fovf -> Bool

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

Show Fovf

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> Fovf -> ShowS

show :: Fovf -> String

showList :: [Fovf] -> ShowS

Storable Fovf

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: Fovf -> Int

alignment :: Fovf -> Int

peekElemOff :: Ptr Fovf -> Int -> IO Fovf

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

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

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

peek :: Ptr Fovf -> IO Fovf

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

Zero Fovf

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: Fovf

ToCStruct Fovf

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr Fovf -> Fovf -> IO b -> IO b

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

pokeZeroCStruct :: Ptr Fovf -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Fovf

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr Fovf -> IO Fovf

data SwapchainSubImage

XrSwapchainSubImage - Composition layer data

Valid Usage (Implicit)

See Also

CompositionLayerCylinderKHR, CompositionLayerDepthInfoKHR, CompositionLayerEquirect2KHR, CompositionLayerEquirectKHR, CompositionLayerProjectionView, CompositionLayerQuad, FrameEndInfo, Rect2Di, Swapchain

Constructors

SwapchainSubImage

Fields

• swapchain :: Ptr Swapchain_T

  swapchain is the Swapchain to be displayed.

  swapchain must be a valid Swapchain handle

• imageRect :: Rect2Di

  imageRect is an Rect2Di representing the valid portion of the image to use, in pixels. It also implicitly defines the transform from normalized image coordinates into pixel coordinates. Note that the compositor may bleed in pixels from outside the bounds in some cases, for instance due to mipmapping.

• imageArrayIndex :: Word32

  imageArrayIndex is the image array index, with 0 meaning the first or only array element.

Instances

Show SwapchainSubImage

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> SwapchainSubImage -> ShowS

show :: SwapchainSubImage -> String

showList :: [SwapchainSubImage] -> ShowS

Storable SwapchainSubImage

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: SwapchainSubImage -> Int

alignment :: SwapchainSubImage -> Int

peekElemOff :: Ptr SwapchainSubImage -> Int -> IO SwapchainSubImage

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

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

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

peek :: Ptr SwapchainSubImage -> IO SwapchainSubImage

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

Zero SwapchainSubImage

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: SwapchainSubImage

ToCStruct SwapchainSubImage

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr SwapchainSubImage -> SwapchainSubImage -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SwapchainSubImage -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct SwapchainSubImage

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr SwapchainSubImage -> IO SwapchainSubImage

data CompositionLayerBaseHeader (es :: [Type])

XrCompositionLayerBaseHeader - Composition layer base header

Member Descriptions

Description

All composition layer structures begin with the elements described in the CompositionLayerBaseHeader. The CompositionLayerBaseHeader structure is not intended to be directly used, but forms a basis for defining current and future structures containing composition layer information. The FrameEndInfo structure contains an array of pointers to these polymorphic header structures. All composition layer type pointers must be type-castable as an CompositionLayerBaseHeader pointer.

Valid Usage (Implicit)

See Also

CompositionLayerFlags, FrameEndInfo, SecondaryViewConfigurationLayerInfoMSFT, Space, StructureType, SwapchainSubImage

Constructors

CompositionLayerBaseHeader

Fields

• type' :: StructureType

  type is the StructureType of this structure. This base structure itself has no associated StructureType value.

  type must be one of the following XrStructureType values: TYPE_COMPOSITION_LAYER_CUBE_KHR, TYPE_COMPOSITION_LAYER_CYLINDER_KHR, TYPE_COMPOSITION_LAYER_EQUIRECT2_KHR, TYPE_COMPOSITION_LAYER_EQUIRECT_KHR, TYPE_COMPOSITION_LAYER_PROJECTION, TYPE_COMPOSITION_LAYER_QUAD

• 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.

  next must be NULL or a valid pointer to the next structure in a structure chain. See also: CompositionLayerColorScaleBiasKHR

• layerFlags :: CompositionLayerFlags

  layerFlags is a bitmask of XrCompositionLayerFlagBits describing flags to apply to the layer.

  layerFlags must be 0 or a valid combination of XrCompositionLayerFlagBits values

• space :: Ptr Space_T

  space is the Space in which the layer will be kept stable over time.

  space must be a valid Space handle

Instances

Extensible CompositionLayerBaseHeader

Defined in OpenXR.Core10.OtherTypes

Methods

extensibleTypeName :: String

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

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

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

Show (Chain es) => Show (CompositionLayerBaseHeader es)

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> CompositionLayerBaseHeader es -> ShowS

show :: CompositionLayerBaseHeader es -> String

showList :: [CompositionLayerBaseHeader es] -> ShowS

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

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: CompositionLayerBaseHeader es

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

Defined in OpenXR.Core10.OtherTypes

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in OpenXR.Core10.OtherTypes

Methods

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

Inheritable (CompositionLayerBaseHeader ('[] :: [Type]))

Defined in OpenXR.Core10.OtherTypes

Methods

peekSomeCChild :: Ptr (SomeChild (CompositionLayerBaseHeader '[])) -> IO (SomeChild (CompositionLayerBaseHeader '[]))

class ToCStruct a => IsCompositionLayer a where

Methods

toCompositionLayerBaseHeader :: a -> CompositionLayerBaseHeader '[]

Instances

IsCompositionLayer CompositionLayerQuad

Defined in OpenXR.Core10.OtherTypes

Methods

toCompositionLayerBaseHeader :: CompositionLayerQuad -> CompositionLayerBaseHeader '[]

IsCompositionLayer CompositionLayerProjection

Defined in OpenXR.Core10.OtherTypes

Methods

toCompositionLayerBaseHeader :: CompositionLayerProjection -> CompositionLayerBaseHeader '[]

IsCompositionLayer CompositionLayerCubeKHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_cube

Methods

toCompositionLayerBaseHeader :: CompositionLayerCubeKHR -> CompositionLayerBaseHeader '[]

IsCompositionLayer CompositionLayerCylinderKHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_cylinder

Methods

toCompositionLayerBaseHeader :: CompositionLayerCylinderKHR -> CompositionLayerBaseHeader '[]

IsCompositionLayer CompositionLayerEquirectKHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_equirect

Methods

toCompositionLayerBaseHeader :: CompositionLayerEquirectKHR -> CompositionLayerBaseHeader '[]

IsCompositionLayer CompositionLayerEquirect2KHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_equirect2

Methods

toCompositionLayerBaseHeader :: CompositionLayerEquirect2KHR -> CompositionLayerBaseHeader '[]

data CompositionLayerProjectionView (es :: [Type])

XrCompositionLayerProjectionView - Projection layer element

Member Descriptions

Description

The count and order of view poses submitted with CompositionLayerProjection must be the same order as that returned by locateViews. The CompositionLayerProjectionView::pose and CompositionLayerProjectionView::fov should almost always derive from View::pose and View::fov as found in the locateViews::views array. However, applications may submit an CompositionLayerProjectionView which has a different view or FOV than that from locateViews. In this case, the runtime will map the view and FOV to the system display appropriately. In the case that two submitted views within a single layer overlap, they must be composited in view array order.

Valid Usage (Implicit)

See Also

CompositionLayerProjection, Fovf, Posef, StructureType, SwapchainSubImage

Constructors

CompositionLayerProjectionView

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.

  next must be NULL or a valid pointer to the next structure in a structure chain. See also: CompositionLayerDepthInfoKHR

• pose :: Posef

  pose is an Posef defining the location and orientation of this projection element in the space of the corresponding CompositionLayerProjectionView.

• fov :: Fovf

  fov is the Fovf for this projection element.

• subImage :: SwapchainSubImage

  subImage is the image layer SwapchainSubImage to use.

  subImage must be a valid SwapchainSubImage structure

Instances

Extensible CompositionLayerProjectionView

Defined in OpenXR.Core10.OtherTypes

Methods

extensibleTypeName :: String

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

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

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

Show (Chain es) => Show (CompositionLayerProjectionView es)

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> CompositionLayerProjectionView es -> ShowS

show :: CompositionLayerProjectionView es -> String

showList :: [CompositionLayerProjectionView es] -> ShowS

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

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: CompositionLayerProjectionView es

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

Defined in OpenXR.Core10.OtherTypes

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

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

Defined in OpenXR.Core10.OtherTypes

Methods

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

data CompositionLayerProjection

XrCompositionLayerProjection - Composition layer for projection

Member Descriptions

Description

Note

Because a runtime may reproject the layer over time, a projection layer should specify an Space in which to maximize stability of the layer content. For example, a projection layer containing world-locked content should use an Space which is also world-locked, such as the LOCAL or STAGE reference spaces. In the case that the projection layer should be head-locked, such as a heads up display, the VIEW reference space would provide the highest quality layer reprojection.

Valid Usage (Implicit)

• type must be TYPE_COMPOSITION_LAYER_PROJECTION

• next must be NULL or a valid pointer to the next structure in a structure chain
• layerFlags must be 0 or a valid combination of XrCompositionLayerFlagBits values
• space must be a valid Space handle
• views must be a pointer to an array of viewCount valid CompositionLayerProjectionView structures
• The viewCount parameter must be greater than 0

See Also

CompositionLayerBaseHeader, CompositionLayerFlags, CompositionLayerProjectionView, Space, StructureType, SwapchainSubImage

Constructors

CompositionLayerProjection

Fields

• layerFlags :: CompositionLayerFlags

  layerFlags is a bitmask of XrCompositionLayerFlagBits describing flags to apply to the layer.

• space :: Ptr Space_T

  space is the Space in which the pose of each CompositionLayerProjectionView is evaluated over time by the compositor.

• views :: Vector (SomeStruct CompositionLayerProjectionView)

  views is the array of type CompositionLayerProjectionView containing each projection layer view.

Instances

Show CompositionLayerProjection

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> CompositionLayerProjection -> ShowS

show :: CompositionLayerProjection -> String

showList :: [CompositionLayerProjection] -> ShowS

Zero CompositionLayerProjection

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: CompositionLayerProjection

ToCStruct CompositionLayerProjection

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr CompositionLayerProjection -> CompositionLayerProjection -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CompositionLayerProjection -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct CompositionLayerProjection

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr CompositionLayerProjection -> IO CompositionLayerProjection

IsCompositionLayer CompositionLayerProjection

Defined in OpenXR.Core10.OtherTypes

Methods

toCompositionLayerBaseHeader :: CompositionLayerProjection -> CompositionLayerBaseHeader '[]

data CompositionLayerQuad

XrCompositionLayerQuad - Quad composition layer

Member Descriptions

Description

The CompositionLayerQuad layer is useful for user interface elements or 2D content rendered into the virtual world. The layer’s SwapchainSubImage::swapchain image is applied to a quad in the virtual world space. Only front face of the quad surface is visible; the back face is not visible and must not be drawn by the runtime. A quad layer has no thickness; it is a two-dimensional object positioned and oriented in 3D space. The position of a quad refers to the center of the quad within the given Space. The orientation of the quad refers to the orientation of the normal vector from the front face. The size of a quad refers to the quad’s size in the x-y plane of the given Space’s coordinate system. A quad with a position of {0,0,0}, rotation of {0,0,0,1} (no rotation), and a size of {1,1} refers to a 1 meter x 1 meter quad centered at {0,0,0} with its front face normal vector coinciding with the +z axis.

Valid Usage (Implicit)

See Also

CompositionLayerBaseHeader, CompositionLayerFlags, Extent2Df, EyeVisibility, Posef, Space, StructureType, SwapchainSubImage

Constructors

CompositionLayerQuad

Fields

• layerFlags :: CompositionLayerFlags

  layerFlags is a bitmask of XrCompositionLayerFlagBits describing flags to apply to the layer.

  layerFlags must be 0 or a valid combination of XrCompositionLayerFlagBits values

• space :: Ptr Space_T

  space is the Space in which the pose of the quad layer is evaluated over time.

  space must be a valid Space handle

• eyeVisibility :: EyeVisibility

  eyeVisibility is the EyeVisibility for this layer.

  eyeVisibility must be a valid EyeVisibility value

• subImage :: SwapchainSubImage

  subImage is the image layer SwapchainSubImage to use.

  subImage must be a valid SwapchainSubImage structure

• pose :: Posef

  pose is an Posef defining the position and orientation of the quad in the reference frame of the space.

• size :: Extent2Df

  size is the width and height of the quad in meters.

Instances

Show CompositionLayerQuad

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> CompositionLayerQuad -> ShowS

show :: CompositionLayerQuad -> String

showList :: [CompositionLayerQuad] -> ShowS

Storable CompositionLayerQuad

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: CompositionLayerQuad -> Int

alignment :: CompositionLayerQuad -> Int

peekElemOff :: Ptr CompositionLayerQuad -> Int -> IO CompositionLayerQuad

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

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

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

peek :: Ptr CompositionLayerQuad -> IO CompositionLayerQuad

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

Zero CompositionLayerQuad

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: CompositionLayerQuad

ToCStruct CompositionLayerQuad

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr CompositionLayerQuad -> CompositionLayerQuad -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CompositionLayerQuad -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct CompositionLayerQuad

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr CompositionLayerQuad -> IO CompositionLayerQuad

IsCompositionLayer CompositionLayerQuad

Defined in OpenXR.Core10.OtherTypes

Methods

toCompositionLayerBaseHeader :: CompositionLayerQuad -> CompositionLayerBaseHeader '[]

data HapticVibration

XrHapticVibration - Base header for haptic feedback

Member Descriptions

Description

The HapticVibration is used in calls to applyHapticFeedback that trigger vibration output actions.

The duration, and frequency parameters may be clamped to implementation-dependent ranges.

Valid Usage (Implicit)

See Also

https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrDuration, HapticBaseHeader, StructureType, applyHapticFeedback

Constructors

HapticVibration

Fields

• duration :: Duration

  duration is the number of nanoseconds the vibration should last. If MIN_HAPTIC_DURATION is specified, the runtime must produce a short haptics pulse of minimal supported duration for the haptic device.

• frequency :: Float

  frequency is the frequency of the vibration in Hz. If FREQUENCY_UNSPECIFIED is specified, it is left to the runtime to decide the optimal frequency value to use.

• amplitude :: Float

  amplitude is the amplitude of the vibration between 0.0 and 1.0.

Instances

Eq HapticVibration

Defined in OpenXR.Core10.OtherTypes

Methods

(==) :: HapticVibration -> HapticVibration -> Bool

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

Show HapticVibration

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> HapticVibration -> ShowS

show :: HapticVibration -> String

showList :: [HapticVibration] -> ShowS

Storable HapticVibration

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: HapticVibration -> Int

alignment :: HapticVibration -> Int

peekElemOff :: Ptr HapticVibration -> Int -> IO HapticVibration

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

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

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

peek :: Ptr HapticVibration -> IO HapticVibration

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

Zero HapticVibration

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: HapticVibration

ToCStruct HapticVibration

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr HapticVibration -> HapticVibration -> IO b -> IO b

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

pokeZeroCStruct :: Ptr HapticVibration -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct HapticVibration

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr HapticVibration -> IO HapticVibration

IsHaptic HapticVibration

Defined in OpenXR.Core10.OtherTypes

Methods

toHapticBaseHeader :: HapticVibration -> HapticBaseHeader

data EventDataBaseHeader

XrEventDataBaseHeader - Base header for an event

Parameter Descriptions

Description

The EventDataBaseHeader is a generic structure used to identify the common event data elements.

Upon receipt, the EventDataBaseHeader pointer should be type-cast to a pointer of the appropriate event data based on the type parameter.

Valid Usage (Implicit)

See Also

StructureType, pollEvent

Constructors

EventDataBaseHeader

Fields

• type' :: StructureType

  type is the StructureType of this structure. This base structure itself has no associated StructureType value.

  type must be one of the following XrStructureType values: TYPE_EVENT_DATA_DISPLAY_REFRESH_RATE_CHANGED_FB, TYPE_EVENT_DATA_EVENTS_LOST, TYPE_EVENT_DATA_INSTANCE_LOSS_PENDING, TYPE_EVENT_DATA_INTERACTION_PROFILE_CHANGED, TYPE_EVENT_DATA_MAIN_SESSION_VISIBILITY_CHANGED_EXTX, TYPE_EVENT_DATA_PERF_SETTINGS_EXT, TYPE_EVENT_DATA_REFERENCE_SPACE_CHANGE_PENDING, TYPE_EVENT_DATA_SESSION_STATE_CHANGED, TYPE_EVENT_DATA_VISIBILITY_MASK_CHANGED_KHR

Instances

Eq EventDataBaseHeader

Defined in OpenXR.Core10.OtherTypes

Methods

(==) :: EventDataBaseHeader -> EventDataBaseHeader -> Bool

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

Show EventDataBaseHeader

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> EventDataBaseHeader -> ShowS

show :: EventDataBaseHeader -> String

showList :: [EventDataBaseHeader] -> ShowS

Storable EventDataBaseHeader

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: EventDataBaseHeader -> Int

alignment :: EventDataBaseHeader -> Int

peekElemOff :: Ptr EventDataBaseHeader -> Int -> IO EventDataBaseHeader

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

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

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

peek :: Ptr EventDataBaseHeader -> IO EventDataBaseHeader

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

Zero EventDataBaseHeader

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: EventDataBaseHeader

ToCStruct EventDataBaseHeader

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr EventDataBaseHeader -> EventDataBaseHeader -> IO b -> IO b

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

pokeZeroCStruct :: Ptr EventDataBaseHeader -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct EventDataBaseHeader

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr EventDataBaseHeader -> IO EventDataBaseHeader

Inheritable EventDataBaseHeader

Defined in OpenXR.Core10.OtherTypes

Methods

peekSomeCChild :: Ptr (SomeChild EventDataBaseHeader) -> IO (SomeChild EventDataBaseHeader)

class ToCStruct a => IsEventData a where

Methods

toEventDataBaseHeader :: a -> EventDataBaseHeader

Instances

IsEventData EventDataSessionStateChanged

Defined in OpenXR.Core10.OtherTypes

Methods

toEventDataBaseHeader :: EventDataSessionStateChanged -> EventDataBaseHeader

IsEventData EventDataReferenceSpaceChangePending

Defined in OpenXR.Core10.OtherTypes

Methods

toEventDataBaseHeader :: EventDataReferenceSpaceChangePending -> EventDataBaseHeader

IsEventData EventDataInteractionProfileChanged

Defined in OpenXR.Core10.OtherTypes

Methods

toEventDataBaseHeader :: EventDataInteractionProfileChanged -> EventDataBaseHeader

IsEventData EventDataInstanceLossPending

Defined in OpenXR.Core10.OtherTypes

Methods

toEventDataBaseHeader :: EventDataInstanceLossPending -> EventDataBaseHeader

IsEventData EventDataEventsLost

Defined in OpenXR.Core10.OtherTypes

Methods

toEventDataBaseHeader :: EventDataEventsLost -> EventDataBaseHeader

IsEventData EventDataMainSessionVisibilityChangedEXTX

Defined in OpenXR.Extensions.XR_EXTX_overlay

Methods

toEventDataBaseHeader :: EventDataMainSessionVisibilityChangedEXTX -> EventDataBaseHeader

IsEventData EventDataPerfSettingsEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

toEventDataBaseHeader :: EventDataPerfSettingsEXT -> EventDataBaseHeader

IsEventData EventDataDisplayRefreshRateChangedFB

Defined in OpenXR.Extensions.XR_FB_display_refresh_rate

Methods

toEventDataBaseHeader :: EventDataDisplayRefreshRateChangedFB -> EventDataBaseHeader

IsEventData EventDataVisibilityMaskChangedKHR

Defined in OpenXR.Extensions.XR_KHR_visibility_mask

Methods

toEventDataBaseHeader :: EventDataVisibilityMaskChangedKHR -> EventDataBaseHeader

data EventDataEventsLost

XrEventDataEventsLost - Event indicating events were lost

Member Descriptions

Description

Receiving the EventDataEventsLost event structure indicates that the event queue overflowed and some events were removed at the position within the queue at which this event was found.

Valid Usage (Implicit)

See Also

EventDataBaseHeader, StructureType, pollEvent

Constructors

EventDataEventsLost

Fields

• lostEventCount :: Word32

  lostEventCount is the number of events which have overflowed since the last call to pollEvent.

Instances

Eq EventDataEventsLost

Defined in OpenXR.Core10.OtherTypes

Methods

(==) :: EventDataEventsLost -> EventDataEventsLost -> Bool

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

Show EventDataEventsLost

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> EventDataEventsLost -> ShowS

show :: EventDataEventsLost -> String

showList :: [EventDataEventsLost] -> ShowS

Storable EventDataEventsLost

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: EventDataEventsLost -> Int

alignment :: EventDataEventsLost -> Int

peekElemOff :: Ptr EventDataEventsLost -> Int -> IO EventDataEventsLost

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

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

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

peek :: Ptr EventDataEventsLost -> IO EventDataEventsLost

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

Zero EventDataEventsLost

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: EventDataEventsLost

ToCStruct EventDataEventsLost

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr EventDataEventsLost -> EventDataEventsLost -> IO b -> IO b

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

pokeZeroCStruct :: Ptr EventDataEventsLost -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct EventDataEventsLost

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr EventDataEventsLost -> IO EventDataEventsLost

IsEventData EventDataEventsLost

Defined in OpenXR.Core10.OtherTypes

Methods

toEventDataBaseHeader :: EventDataEventsLost -> EventDataBaseHeader

data EventDataInstanceLossPending

XrEventDataInstanceLossPending - Event indicating instance loss will occur

Members

Receiving the EventDataInstanceLossPending event structure indicates that the application is about to lose the indicated Instance at the indicated lossTime in the future. The application should call destroyInstance and relinquish any instance-specific resources. This typically occurs to make way for a replacement of the underlying runtime, such as via a software update.

Description

After the application has destroyed all of its instances and their children and waited past the specified time, it may then re-try createInstance in a loop waiting for whatever maintenance the runtime is performing to complete. The runtime will return ERROR_INSTANCE_LOST from createInstance as long as it is unable to create the instance. Once the runtime has returned and is able to continue, it must resume returning SUCCESS from createInstance if valid data is passed in.

Valid Usage (Implicit)

See Also

EventDataBaseHeader, StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, pollEvent

Constructors

EventDataInstanceLossPending

Fields

• lossTime :: Time

  lossTime is the absolute time at which the indicated instance will be considered lost and become unusable.

Instances

Eq EventDataInstanceLossPending

Defined in OpenXR.Core10.OtherTypes

Methods

(==) :: EventDataInstanceLossPending -> EventDataInstanceLossPending -> Bool

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

Show EventDataInstanceLossPending

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> EventDataInstanceLossPending -> ShowS

show :: EventDataInstanceLossPending -> String

showList :: [EventDataInstanceLossPending] -> ShowS

Storable EventDataInstanceLossPending

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: EventDataInstanceLossPending -> Int

alignment :: EventDataInstanceLossPending -> Int

peekElemOff :: Ptr EventDataInstanceLossPending -> Int -> IO EventDataInstanceLossPending

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

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

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

peek :: Ptr EventDataInstanceLossPending -> IO EventDataInstanceLossPending

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

Zero EventDataInstanceLossPending

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: EventDataInstanceLossPending

ToCStruct EventDataInstanceLossPending

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr EventDataInstanceLossPending -> EventDataInstanceLossPending -> IO b -> IO b

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

pokeZeroCStruct :: Ptr EventDataInstanceLossPending -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct EventDataInstanceLossPending

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr EventDataInstanceLossPending -> IO EventDataInstanceLossPending

IsEventData EventDataInstanceLossPending

Defined in OpenXR.Core10.OtherTypes

Methods

toEventDataBaseHeader :: EventDataInstanceLossPending -> EventDataBaseHeader

data EventDataSessionStateChanged

XrEventDataSessionStateChanged - Event indicating session state changed

Member Descriptions

Description

Receiving the EventDataSessionStateChanged event structure indicates that the application has changed lifecycle state.

Valid Usage (Implicit)

See Also

EventDataBaseHeader, Session, SessionState, StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, pollEvent

Constructors

EventDataSessionStateChanged

Fields

• session :: Ptr Session_T

  session is the Session which has changed state.

  session must be a valid Session handle

• state :: SessionState

  state is the current SessionState of the session.

  state must be a valid SessionState value

• time :: Time

  time is an https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime which indicates the time of the state change.

Instances

Eq EventDataSessionStateChanged

Defined in OpenXR.Core10.OtherTypes

Methods

(==) :: EventDataSessionStateChanged -> EventDataSessionStateChanged -> Bool

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

Show EventDataSessionStateChanged

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> EventDataSessionStateChanged -> ShowS

show :: EventDataSessionStateChanged -> String

showList :: [EventDataSessionStateChanged] -> ShowS

Storable EventDataSessionStateChanged

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: EventDataSessionStateChanged -> Int

alignment :: EventDataSessionStateChanged -> Int

peekElemOff :: Ptr EventDataSessionStateChanged -> Int -> IO EventDataSessionStateChanged

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

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

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

peek :: Ptr EventDataSessionStateChanged -> IO EventDataSessionStateChanged

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

Zero EventDataSessionStateChanged

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: EventDataSessionStateChanged

ToCStruct EventDataSessionStateChanged

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr EventDataSessionStateChanged -> EventDataSessionStateChanged -> IO b -> IO b

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

pokeZeroCStruct :: Ptr EventDataSessionStateChanged -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct EventDataSessionStateChanged

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr EventDataSessionStateChanged -> IO EventDataSessionStateChanged

IsEventData EventDataSessionStateChanged

Defined in OpenXR.Core10.OtherTypes

Methods

toEventDataBaseHeader :: EventDataSessionStateChanged -> EventDataBaseHeader

data EventDataReferenceSpaceChangePending

XrEventDataReferenceSpaceChangePending - Notifies the application that a reference space is changing

Valid Usage (Implicit)

See Also

REFERENCE_SPACE_TYPE_STAGE, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrBool32, Posef, ReferenceSpaceType, Session, StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, createReferenceSpace

Constructors

EventDataReferenceSpaceChangePending

Fields

• session :: Ptr Session_T

  session is the Session for which the reference space is changing.

  session must be a valid Session handle

• referenceSpaceType :: ReferenceSpaceType

  referenceSpaceType is the ReferenceSpaceType that is changing.

  referenceSpaceType must be a valid ReferenceSpaceType value

• changeTime :: Time

  changeTime is the target https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime after which locateSpace or locateViews will return values that respect this change.

• poseValid :: Bool

  poseValid is true if the runtime can determine the pose of the new space in the previous space before the change.

• poseInPreviousSpace :: Posef

  poseInPreviousSpace is an Posef defining the position and orientation of the new reference space’s natural origin within the natural reference frame of its previous space.

Instances

Show EventDataReferenceSpaceChangePending

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> EventDataReferenceSpaceChangePending -> ShowS

show :: EventDataReferenceSpaceChangePending -> String

showList :: [EventDataReferenceSpaceChangePending] -> ShowS

Storable EventDataReferenceSpaceChangePending

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: EventDataReferenceSpaceChangePending -> Int

alignment :: EventDataReferenceSpaceChangePending -> Int

peekElemOff :: Ptr EventDataReferenceSpaceChangePending -> Int -> IO EventDataReferenceSpaceChangePending

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

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

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

peek :: Ptr EventDataReferenceSpaceChangePending -> IO EventDataReferenceSpaceChangePending

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

Zero EventDataReferenceSpaceChangePending

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: EventDataReferenceSpaceChangePending

ToCStruct EventDataReferenceSpaceChangePending

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr EventDataReferenceSpaceChangePending -> EventDataReferenceSpaceChangePending -> IO b -> IO b

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

pokeZeroCStruct :: Ptr EventDataReferenceSpaceChangePending -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct EventDataReferenceSpaceChangePending

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr EventDataReferenceSpaceChangePending -> IO EventDataReferenceSpaceChangePending

IsEventData EventDataReferenceSpaceChangePending

Defined in OpenXR.Core10.OtherTypes

Methods

toEventDataBaseHeader :: EventDataReferenceSpaceChangePending -> EventDataBaseHeader

data EventDataInteractionProfileChanged

XrEventDataInteractionProfileChanged - Notifies the application than the active interaction profile has changed

Member Descriptions

Description

The EventDataInteractionProfileChanged event is sent to the application to notify it that the active input form factor for one or more top level user paths has changed. This event must only be sent for interaction profiles that the application indicated its support for via suggestInteractionProfileBindings. This event must only be sent for running sessions.

The application can call getCurrentInteractionProfile if it wants to change its own behavior based on the active hardware.

Valid Usage (Implicit)

See Also

Session, StructureType, getCurrentInteractionProfile, suggestInteractionProfileBindings

Constructors

EventDataInteractionProfileChanged

Fields

• session :: Ptr Session_T

  session is the Session for which at least one of the interaction profiles for a top level path has changed.

  session must be a valid Session handle

Instances

Eq EventDataInteractionProfileChanged

Defined in OpenXR.Core10.OtherTypes

Methods

(==) :: EventDataInteractionProfileChanged -> EventDataInteractionProfileChanged -> Bool

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

Show EventDataInteractionProfileChanged

Defined in OpenXR.Core10.OtherTypes

Methods

showsPrec :: Int -> EventDataInteractionProfileChanged -> ShowS

show :: EventDataInteractionProfileChanged -> String

showList :: [EventDataInteractionProfileChanged] -> ShowS

Storable EventDataInteractionProfileChanged

Defined in OpenXR.Core10.OtherTypes

Methods

sizeOf :: EventDataInteractionProfileChanged -> Int

alignment :: EventDataInteractionProfileChanged -> Int

peekElemOff :: Ptr EventDataInteractionProfileChanged -> Int -> IO EventDataInteractionProfileChanged

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

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

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

peek :: Ptr EventDataInteractionProfileChanged -> IO EventDataInteractionProfileChanged

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

Zero EventDataInteractionProfileChanged

Defined in OpenXR.Core10.OtherTypes

Methods

zero :: EventDataInteractionProfileChanged

ToCStruct EventDataInteractionProfileChanged

Defined in OpenXR.Core10.OtherTypes

Methods

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

pokeCStruct :: Ptr EventDataInteractionProfileChanged -> EventDataInteractionProfileChanged -> IO b -> IO b

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

pokeZeroCStruct :: Ptr EventDataInteractionProfileChanged -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct EventDataInteractionProfileChanged

Defined in OpenXR.Core10.OtherTypes

Methods

peekCStruct :: Ptr EventDataInteractionProfileChanged -> IO EventDataInteractionProfileChanged

IsEventData EventDataInteractionProfileChanged

Defined in OpenXR.Core10.OtherTypes

Methods

toEventDataBaseHeader :: EventDataInteractionProfileChanged -> EventDataBaseHeader

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 BaseInStructure

XrBaseInStructure - Convenience type for iterating (read only)

Member Descriptions

Description

BaseInStructure can be used to facilitate iterating through a read-only structure pointer chain.

See Also

BaseInStructure, BaseOutStructure, StructureType

Constructors

BaseInStructure

Fields

• type' :: StructureType

  type is the StructureType of this structure. This base structure itself has no associated StructureType value.

• next :: Ptr BaseInStructure

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

Instances

Eq BaseInStructure

Defined in OpenXR.CStruct.Extends

Methods

(==) :: BaseInStructure -> BaseInStructure -> Bool

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

Show BaseInStructure

Defined in OpenXR.CStruct.Extends

Methods

showsPrec :: Int -> BaseInStructure -> ShowS

show :: BaseInStructure -> String

showList :: [BaseInStructure] -> ShowS

Storable BaseInStructure

Defined in OpenXR.CStruct.Extends

Methods

sizeOf :: BaseInStructure -> Int

alignment :: BaseInStructure -> Int

peekElemOff :: Ptr BaseInStructure -> Int -> IO BaseInStructure

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

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

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

peek :: Ptr BaseInStructure -> IO BaseInStructure

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

Zero BaseInStructure

Defined in OpenXR.CStruct.Extends

Methods

zero :: BaseInStructure

ToCStruct BaseInStructure

Defined in OpenXR.CStruct.Extends

Methods

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

pokeCStruct :: Ptr BaseInStructure -> BaseInStructure -> IO b -> IO b

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

pokeZeroCStruct :: Ptr BaseInStructure -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct BaseInStructure

Defined in OpenXR.CStruct.Extends

Methods

peekCStruct :: Ptr BaseInStructure -> IO BaseInStructure

data BaseOutStructure

XrBaseOutStructure - Convenience type for iterating (mutable)

Member Descriptions

Description

BaseOutStructure can be used to facilitate iterating through a structure pointer chain that returns data back to the application.

See Also

BaseInStructure, BaseOutStructure, StructureType

Constructors

BaseOutStructure

Fields

• type' :: StructureType

  type is the StructureType of this structure. This base structure itself has no associated StructureType value.

• next :: Ptr BaseOutStructure

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

Instances

Eq BaseOutStructure

Defined in OpenXR.CStruct.Extends

Methods

(==) :: BaseOutStructure -> BaseOutStructure -> Bool

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

Show BaseOutStructure

Defined in OpenXR.CStruct.Extends

Methods

showsPrec :: Int -> BaseOutStructure -> ShowS

show :: BaseOutStructure -> String

showList :: [BaseOutStructure] -> ShowS

Storable BaseOutStructure

Defined in OpenXR.CStruct.Extends

Methods

sizeOf :: BaseOutStructure -> Int

alignment :: BaseOutStructure -> Int

peekElemOff :: Ptr BaseOutStructure -> Int -> IO BaseOutStructure

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

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

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

peek :: Ptr BaseOutStructure -> IO BaseOutStructure

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

Zero BaseOutStructure

Defined in OpenXR.CStruct.Extends

Methods

zero :: BaseOutStructure

ToCStruct BaseOutStructure

Defined in OpenXR.CStruct.Extends

Methods

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

pokeCStruct :: Ptr BaseOutStructure -> BaseOutStructure -> IO b -> IO b

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

pokeZeroCStruct :: Ptr BaseOutStructure -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct BaseOutStructure

Defined in OpenXR.CStruct.Extends

Methods

peekCStruct :: Ptr BaseOutStructure -> IO BaseOutStructure

newtype ObjectType

XrObjectType - Specify an enumeration to track object handle types

Description

The ObjectType enumeration defines values, each of which corresponds to a specific OpenXR handle type. These values can be used to associate debug information with a particular type of object through one or more extensions.

The following table defines ObjectType and OpenXR Handle relationships:

ObjectType	OpenXR Handle Type
OBJECT_TYPE_UNKNOWN	Unknown/Undefined Handle
OBJECT_TYPE_INSTANCE	Instance
OBJECT_TYPE_SESSION	Session
OBJECT_TYPE_SWAPCHAIN	Swapchain
OBJECT_TYPE_SPACE	Space
OBJECT_TYPE_ACTION_SET	ActionSet
OBJECT_TYPE_ACTION	Action

See Also

DebugUtilsObjectNameInfoEXT

Constructors

ObjectType Int32

Bundled Patterns

pattern OBJECT_TYPE_UNKNOWN :: ObjectType

pattern OBJECT_TYPE_DEBUG_UTILS_MESSENGER_EXT :: ObjectType

pattern OBJECT_TYPE_INSTANCE :: ObjectType

pattern OBJECT_TYPE_SESSION :: ObjectType

pattern OBJECT_TYPE_SWAPCHAIN :: ObjectType

pattern OBJECT_TYPE_SPACE :: ObjectType

pattern OBJECT_TYPE_ACTION_SET :: ObjectType

pattern OBJECT_TYPE_ACTION :: ObjectType

pattern OBJECT_TYPE_HAND_TRACKER_EXT :: ObjectType

pattern OBJECT_TYPE_SPATIAL_ANCHOR_MSFT :: ObjectType

Instances

Eq ObjectType

Defined in OpenXR.Core10.Enums.ObjectType

Methods

(==) :: ObjectType -> ObjectType -> Bool

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

Ord ObjectType

Defined in OpenXR.Core10.Enums.ObjectType

Methods

compare :: ObjectType -> ObjectType -> Ordering

(<) :: ObjectType -> ObjectType -> Bool

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

(>) :: ObjectType -> ObjectType -> Bool

(>=) :: ObjectType -> ObjectType -> Bool

max :: ObjectType -> ObjectType -> ObjectType

min :: ObjectType -> ObjectType -> ObjectType

Read ObjectType

Defined in OpenXR.Core10.Enums.ObjectType

Methods

readsPrec :: Int -> ReadS ObjectType

readList :: ReadS [ObjectType]

readPrec :: ReadPrec ObjectType

readListPrec :: ReadPrec [ObjectType]

Show ObjectType

Defined in OpenXR.Core10.Enums.ObjectType

Methods

showsPrec :: Int -> ObjectType -> ShowS

show :: ObjectType -> String

showList :: [ObjectType] -> ShowS

Storable ObjectType

Defined in OpenXR.Core10.Enums.ObjectType

Methods

sizeOf :: ObjectType -> Int

alignment :: ObjectType -> Int

peekElemOff :: Ptr ObjectType -> Int -> IO ObjectType

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

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

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

peek :: Ptr ObjectType -> IO ObjectType

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

Zero ObjectType

Defined in OpenXR.Core10.Enums.ObjectType

Methods

zero :: ObjectType