TechnologiesAR & Spatial

CompositorServices

iOSmacOStvOSwatchOSvisionOS

CompositorServices provides a Metal-based layer renderer and frame and drawable pipeline for drawing immersive stereoscopic content in visionOS spatial scenes. You drive rendering through a LayerRenderer, which manages the frame-and-drawable loop that delivers your Metal-drawn content to the compositor. Configure the renderer using types such as TextureTopology and AxisDirectionConvention, and handle setup failures through LayerRendererConfigurationError. The framework is available on visionOS and macOS.

Rendering 1

The layer renderer that manages the frame-and-drawable loop delivering your Metal content to the compositor.

  • Cl
    LayerRenderervisionOS 1.0+
    An opaque type that provides the Metal types and timing

Configuration 2

Types that describe how the renderer lays out and orients the textures it draws into.

  • St
    TextureTopologyvisionOS 1.0+
    An opaque type that specifies the configuration of one of the layer’s
  • En
    AxisDirectionConventionvisionOS 2.0+
    Axis direction convention for defining the X/Y/Z directions.

Errors 2

Values that report failures encountered while configuring the layer renderer.

  • En
    LayerRendererConfigurationErrormacOS 26.0+
    Errors that can occur during layer renderer configuration.
  • St
    __cp_layer_renderer_configuration_error_codevisionOS 1.0+
    A structure of error codes that identify failures encountered while configuring a layer renderer.

Structures 2

  • St
    CompositorLayervisionOS 1.0+
    An `ImmersiveSpaceContent` that renders content using a Compositor `LayerRenderer`.
  • St
    DefaultCompositorLayerConfigurationmacOS 26.0+

Protocols 1

  • Pr
    CompositorLayerConfigurationmacOS 26.0+

Type Aliases 4

  • Ty
    LayerFrameIndex
    A frame index in the layer’s timeline.
  • Ty
    CompositorFrameIndex
    The sequential index for a frame in the compositor’s timeline.
  • Ty
    cp_drawable_array_t
    An opaque type that contains the drawable types and other information
  • Ty
    cp_hover_effect_t
    An opaque type that describes a hover effect of the tracking area.

Extends 1

SpatialEventCollection
← AR & Spatial