OpenXR.Extensions.XR_KHR_composition_layer_equirect2

Name

XR_KHR_composition_layer_equirect2 - instance extension

Specification

See XR_KHR_composition_layer_equirect2 in the main specification for complete information.

Registered Extension Number

92

Revision

1

Extension and Version Dependencies

• Requires OpenXR 1.0

See Also

CompositionLayerEquirect2KHR

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.

Documentation

data CompositionLayerEquirect2KHR

XrCompositionLayerEquirect2KHR - Equirectangular layer composition info

Member Descriptions

Description

CompositionLayerEquirect2KHR contains the information needed to render an equirectangular image onto a sphere when calling endFrame. CompositionLayerEquirect2KHR is an alias type for the base struct CompositionLayerBaseHeader used in FrameEndInfo.

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using CompositionLayerEquirect2KHR

• type must be TYPE_COMPOSITION_LAYER_EQUIRECT2_KHR
• 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
• eyeVisibility must be a valid EyeVisibility value
• subImage must be a valid SwapchainSubImage structure

See Also

CompositionLayerBaseHeader, CompositionLayerFlags, EyeVisibility, FrameEndInfo, Posef, Space, StructureType, SwapchainSubImage, endFrame

Constructors

CompositionLayerEquirect2KHR

Fields

• layerFlags :: CompositionLayerFlags

  layerFlags specifies options for the layer.

• space :: Ptr Space_T

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

• eyeVisibility :: EyeVisibility
• subImage :: SwapchainSubImage

  subImage identifies the image SwapchainSubImage to use.

• pose :: Posef

  pose is an Posef defining the position and orientation of the center point of the sphere onto which the equirect image data is mapped, relative to the reference frame of the space.

• radius :: Float

  radius is the non-negative radius of the sphere onto which the equirect image data is mapped. Values of zero or floating point positive infinity are treated as an infinite sphere.

• centralHorizontalAngle :: Float

  centralHorizontalAngle defines the visible horizontal angle of the sphere, based at 0 radians, in the range of [0, 2π]. It grows symmetrically around the 0 radian angle.

• upperVerticalAngle :: Float

  upperVerticalAngle defines the upper vertical angle of the visible portion of the sphere, in the range of [-π/2, π/2].

• lowerVerticalAngle :: Float

  lowerVerticalAngle defines the lower vertical angle of the visible portion of the sphere, in the range of [-π/2, π/2].

Instances

Show CompositionLayerEquirect2KHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_equirect2

Methods

showsPrec :: Int -> CompositionLayerEquirect2KHR -> ShowS

show :: CompositionLayerEquirect2KHR -> String

showList :: [CompositionLayerEquirect2KHR] -> ShowS

Storable CompositionLayerEquirect2KHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_equirect2

Methods

sizeOf :: CompositionLayerEquirect2KHR -> Int

alignment :: CompositionLayerEquirect2KHR -> Int

peekElemOff :: Ptr CompositionLayerEquirect2KHR -> Int -> IO CompositionLayerEquirect2KHR

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

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

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

peek :: Ptr CompositionLayerEquirect2KHR -> IO CompositionLayerEquirect2KHR

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

Zero CompositionLayerEquirect2KHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_equirect2

Methods

zero :: CompositionLayerEquirect2KHR

ToCStruct CompositionLayerEquirect2KHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_equirect2

Methods

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

pokeCStruct :: Ptr CompositionLayerEquirect2KHR -> CompositionLayerEquirect2KHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CompositionLayerEquirect2KHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct CompositionLayerEquirect2KHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_equirect2

Methods

peekCStruct :: Ptr CompositionLayerEquirect2KHR -> IO CompositionLayerEquirect2KHR

IsCompositionLayer CompositionLayerEquirect2KHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_equirect2

Methods

toCompositionLayerBaseHeader :: CompositionLayerEquirect2KHR -> CompositionLayerBaseHeader '[]

type KHR_composition_layer_equirect2_SPEC_VERSION = 1

pattern KHR_composition_layer_equirect2_SPEC_VERSION :: forall a. Integral a => a

type KHR_COMPOSITION_LAYER_EQUIRECT2_EXTENSION_NAME = "XR_KHR_composition_layer_equirect2"

pattern KHR_COMPOSITION_LAYER_EQUIRECT2_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a