OpenXR.Extensions.XR_KHR_composition_layer_cube

Name

XR_KHR_composition_layer_cube - instance extension

Specification

See XR_KHR_composition_layer_cube in the main specification for complete information.

Registered Extension Number

7

Revision

8

Extension and Version Dependencies

• Requires OpenXR 1.0

See Also

CompositionLayerCubeKHR

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 CompositionLayerCubeKHR

XrCompositionLayerCubeKHR - Cube map layer composition info

Member Descriptions

Description

CompositionLayerCubeKHR contains the information needed to render a cube map when calling endFrame. CompositionLayerCubeKHR is an alias type for the base struct CompositionLayerBaseHeader used in FrameEndInfo.

Valid Usage (Implicit)

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

• type must be TYPE_COMPOSITION_LAYER_CUBE_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
• swapchain must be a valid Swapchain handle
• Both of space and swapchain must have been created, allocated, or retrieved from the same Session

See Also

CompositionLayerBaseHeader, CompositionLayerFlags, EyeVisibility, FrameEndInfo, Quaternionf, Space, StructureType, Swapchain, endFrame

Constructors

CompositionLayerCubeKHR

Fields

• layerFlags :: CompositionLayerFlags

  layerFlags is any flags to apply to this layer.

• space :: Ptr Space_T

  space is the Space in which the orientation of the cube layer is evaluated over time.

• eyeVisibility :: EyeVisibility
• swapchain :: Ptr Swapchain_T

  swapchain is the swapchain.

• imageArrayIndex :: Word32

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

• orientation :: Quaternionf

  orientation is the orientation of the environment map in the space.

Instances

Show CompositionLayerCubeKHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_cube

Methods

showsPrec :: Int -> CompositionLayerCubeKHR -> ShowS

show :: CompositionLayerCubeKHR -> String

showList :: [CompositionLayerCubeKHR] -> ShowS

Storable CompositionLayerCubeKHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_cube

Methods

sizeOf :: CompositionLayerCubeKHR -> Int

alignment :: CompositionLayerCubeKHR -> Int

peekElemOff :: Ptr CompositionLayerCubeKHR -> Int -> IO CompositionLayerCubeKHR

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

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

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

peek :: Ptr CompositionLayerCubeKHR -> IO CompositionLayerCubeKHR

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

Zero CompositionLayerCubeKHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_cube

Methods

zero :: CompositionLayerCubeKHR

ToCStruct CompositionLayerCubeKHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_cube

Methods

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

pokeCStruct :: Ptr CompositionLayerCubeKHR -> CompositionLayerCubeKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CompositionLayerCubeKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct CompositionLayerCubeKHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_cube

Methods

peekCStruct :: Ptr CompositionLayerCubeKHR -> IO CompositionLayerCubeKHR

IsCompositionLayer CompositionLayerCubeKHR

Defined in OpenXR.Extensions.XR_KHR_composition_layer_cube

Methods

toCompositionLayerBaseHeader :: CompositionLayerCubeKHR -> CompositionLayerBaseHeader '[]

type KHR_composition_layer_cube_SPEC_VERSION = 8

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

type KHR_COMPOSITION_LAYER_CUBE_EXTENSION_NAME = "XR_KHR_composition_layer_cube"

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