Crate objc2_compositor_services 

Bindings to the CompositorServices framework

See Apple’s docs and the general docs on framework crates for more information.

Structs

CP_OBJECT_cp_layer_rendererlayer_renderer

An opaque type that provides the Metal types and timing information you need to draw your content.

CP_OBJECT_cp_layer_renderer_capabilitieslayer_renderer_capabilities

A type that stores the supported configurations for a layer.

CP_OBJECT_cp_layer_renderer_configurationlayer_renderer_configuration

An opaque type that stores the settings to apply to a Compositor layer renderer.

CP_OBJECT_cp_layer_renderer_propertieslayer_renderer_properties

An opaque type that describes the organization of the layer’s textures and the relationships between those textures and the views you use for drawing.

cp_axis_direction_conventioncp_types

Axis direction convention for defining the X/Y/Z directions.

cp_drawabledrawable

Apple’s documentation

cp_drawable_arraydrawable

Apple’s documentation

cp_drawable_render_contextdrawable_render_context

Apple’s documentation

cp_drawable_statedrawable

The state of ownership for the drawable.

cp_drawable_targetdrawable

The target where the drawable will be displayed/used.

cp_frameframe

Apple’s documentation

cp_frame_timingframe_timing

Apple’s documentation

cp_hover_effecttracking_area

Apple’s documentation

cp_layer_renderer_configuration_error_codecp_error and objc2-core-foundation

Errors that can occur during layer configuration.

cp_layer_renderer_layoutlayer_renderer_layout

Constants that specify the organization of the textures you use for drawing.

cp_layer_renderer_statelayer_renderer

The potential states of the layer renderer, which tell you how to proceed with drawing operations.

cp_supported_color_formats_optionslayer_renderer_capabilities

The options to provide when calling cp_layer_renderer_capabilities_supported_color_formats and cp_layer_renderer_capabilities_supported_color_formats_count

cp_supported_layouts_optionslayer_renderer_capabilities

The options to provide when calling cp_layer_renderer_capabilities_supported_layout and cp_layer_renderer_capabilities_supported_layouts_count

cp_texture_topologylayer_renderer_properties

Apple’s documentation

cp_timecp_types

A Mach absolute time clock value.

cp_tracking_areatracking_area

Apple’s documentation

cp_viewview

Apple’s documentation

cp_view_texture_mapview

Apple’s documentation

Statics

cp_layer_renderer_configuration_error_domain^⚠cp_error and objc2-core-foundation

The domain for errors that occur during layer renderer configuration.

cp_tracking_area_identifier_invalidtracking_area

Identifier reserved as invalid.

cp_tracking_area_render_value_invalidtracking_area

Value to be used in the tracking area texture, to indicate that there is no tracking area at a given pixel.

Functions

cp_drawable_add_mtl4_render_context^⚠Deprecateddrawable and drawable_render_context

cp_drawable_add_render_context^⚠Deprecateddrawable and drawable_render_context and objc2-metal

cp_drawable_add_tracking_area^⚠Deprecateddrawable and tracking_area

cp_drawable_array_get_count^⚠Deprecateddrawable

cp_drawable_array_get_drawable^⚠Deprecateddrawable

cp_drawable_encode_present^⚠Deprecateddrawable and objc2-metal

cp_drawable_get_color_texture^⚠Deprecateddrawable and objc2-metal

cp_drawable_get_depth_texture^⚠Deprecateddrawable and objc2-metal

cp_drawable_get_flipped_rasterization_rate_map^⚠Deprecateddrawable and objc2-metal

cp_drawable_get_frame_timing^⚠Deprecateddrawable and frame_timing

cp_drawable_get_presentation_frame_index^⚠Deprecatedcp_types and drawable

cp_drawable_get_rasterization_rate_map^⚠Deprecateddrawable and objc2-metal

cp_drawable_get_rasterization_rate_map_count^⚠Deprecateddrawable

cp_drawable_get_state^⚠Deprecateddrawable

cp_drawable_get_target^⚠Deprecateddrawable

cp_drawable_get_texture_count^⚠Deprecateddrawable

cp_drawable_get_tracking_areas_texture^⚠Deprecateddrawable and objc2-metal

cp_drawable_get_tracking_areas_texture_count^⚠Deprecateddrawable

cp_drawable_get_view^⚠Deprecateddrawable and view

cp_drawable_get_view_count^⚠Deprecateddrawable

cp_drawable_is_content_capture_protected^⚠Deprecateddrawable

cp_drawable_mtl4_encode_present^⚠Deprecateddrawable

cp_drawable_render_context_draw_mask_on_stencil_attachment^⚠Deprecateddrawable_render_context and objc2-metal

cp_drawable_render_context_end_encoding^⚠Deprecateddrawable_render_context and objc2-metal

cp_drawable_render_context_mtl4_draw_mask_on_stencil_attachment^⚠Deprecateddrawable_render_context and objc2-metal

cp_drawable_render_context_mtl4_end_encoding^⚠Deprecateddrawable_render_context and objc2-metal

cp_frame_end_submission^⚠Deprecatedframe

cp_frame_end_update^⚠Deprecatedframe

cp_frame_get_drawable_target_view_count^⚠Deprecateddrawable and frame

cp_frame_get_frame_index^⚠Deprecatedcp_types and frame

cp_frame_predict_timing^⚠Deprecatedframe and frame_timing

cp_frame_query_drawable^⚠Deprecateddrawable and frame

cp_frame_query_drawables^⚠Deprecateddrawable and frame

cp_frame_start_submission^⚠Deprecatedframe

cp_frame_start_update^⚠Deprecatedframe

cp_frame_timing_get_optimal_input_time^⚠Deprecatedcp_types and frame_timing

cp_frame_timing_get_presentation_time^⚠Deprecatedcp_types and frame_timing

cp_frame_timing_get_rendering_deadline^⚠Deprecatedcp_types and frame_timing

cp_frame_timing_get_trackable_anchor_time^⚠Deprecatedcp_types and frame_timing

cp_layer_renderer_capabilities_drawable_render_context_supported_stencil_format^⚠layer_renderer_capabilities and objc2-metal

Returns the stencil format at the specified index in the layer capabilities.

cp_layer_renderer_capabilities_drawable_render_context_supported_stencil_formats_count^⚠layer_renderer_capabilities

Returns the number of stencil formats the specified layer supports.

cp_layer_renderer_capabilities_get_default_render_quality^⚠cp_types and layer_renderer_capabilities

Returns default render quality for drawing on this platform.

cp_layer_renderer_capabilities_supported_color_format^⚠layer_renderer_capabilities and objc2-metal

Returns the color format at the specified index in the layer capabilities.

cp_layer_renderer_capabilities_supported_color_format_with_options^⚠layer_renderer_capabilities and objc2-metal

Returns the color format at the specified index in the layer capabilities.

cp_layer_renderer_capabilities_supported_color_formats_count^⚠layer_renderer_capabilities

Returns the number of color formats the specified layer supports.

cp_layer_renderer_capabilities_supported_color_formats_count_with_options^⚠layer_renderer_capabilities

Returns the number of color formats the specified layer supports.

cp_layer_renderer_capabilities_supported_depth_format^⚠layer_renderer_capabilities and objc2-metal

Returns the depth format at the specified index in the layer capabilities.

cp_layer_renderer_capabilities_supported_depth_formats_count^⚠layer_renderer_capabilities

Returns the number of depth formats the specified layer supports.

cp_layer_renderer_capabilities_supported_layout^⚠layer_renderer_capabilities and layer_renderer_layout

Returns the layout at the specified index in the layer capabilities.

cp_layer_renderer_capabilities_supported_layouts_count^⚠layer_renderer_capabilities

Returns the number of layouts the specified layer supports.

cp_layer_renderer_capabilities_supported_minimum_near_plane_distance^⚠layer_renderer_capabilities

Returns the minimum distance in meters to the near projection plane that the layer supports.

cp_layer_renderer_capabilities_supported_tracking_areas_format^⚠layer_renderer_capabilities and objc2-metal

Returns the tracking areas format at the specified index in the layer capabilities.

cp_layer_renderer_capabilities_supported_tracking_areas_formats_count^⚠layer_renderer_capabilities

Returns the number of tracking areas formats the specified layer supports.

cp_layer_renderer_capabilities_supports_foveation^⚠layer_renderer_capabilities

Returns a Boolean value that indicates whether the layer supports variable rasterization rates.

cp_layer_renderer_configuration_get_color_format^⚠layer_renderer_configuration and objc2-metal

Returns the pixel format to use for the layer’s color textures.

cp_layer_renderer_configuration_get_color_usage^⚠layer_renderer_configuration and objc2-metal

Returns the texture usage value to apply to the layer’s color textures.

cp_layer_renderer_configuration_get_depth_format^⚠layer_renderer_configuration and objc2-metal

Returns the pixel format to apply to the layer’s depth textures.

cp_layer_renderer_configuration_get_depth_usage^⚠layer_renderer_configuration and objc2-metal

Returns the texture usage value to apply to the layer’s depth textures.

cp_layer_renderer_configuration_get_drawable_render_context_raster_sample_count^⚠layer_renderer_configuration

Returns the raster sample count to use in drawable’s render context.

cp_layer_renderer_configuration_get_drawable_render_context_stencil_format^⚠layer_renderer_configuration and objc2-metal

Returns the pixel format to use for the stencil texture in drawable’s render context.

cp_layer_renderer_configuration_get_foveation_enabled^⚠layer_renderer_configuration

Returns a Boolean value that indicates whether the layer supports variable rasterization rates.

cp_layer_renderer_configuration_get_generate_flipped_rasterization_rate_maps^⚠layer_renderer_configuration

Returns a Boolean value that indicates whether the layer provides flipped variable rasterization rate maps in addition to the regular maps.

cp_layer_renderer_configuration_get_layout^⚠layer_renderer_configuration and layer_renderer_layout

Returns the texture configuration for the drawable views in the layer.

cp_layer_renderer_configuration_get_max_render_quality^⚠cp_types and layer_renderer_configuration

Get max render quality the layer can use when drawing to the drawables.

cp_layer_renderer_configuration_get_supports_mtl4^⚠layer_renderer_configuration

Get whether the layer can use Metal4 when drawing to the drawables.

cp_layer_renderer_configuration_get_tracking_areas_format^⚠layer_renderer_configuration and objc2-metal

Returns the pixel format to apply to the layer’s tracking areas textures.

cp_layer_renderer_configuration_get_tracking_areas_usage^⚠layer_renderer_configuration and objc2-metal

Returns the texture usage value to apply to the layer’s tracking areas textures.

cp_layer_renderer_configuration_set_color_format^⚠layer_renderer_configuration and objc2-metal

Sets the pixel format for the layer’s color textures to the specified value.

cp_layer_renderer_configuration_set_color_usage^⚠layer_renderer_configuration and objc2-metal

Sets the texture usage for the layer’s color textures to the specified value.

cp_layer_renderer_configuration_set_depth_format^⚠layer_renderer_configuration and objc2-metal

Sets the pixel format for the layer’s depth textures to the specified value.

cp_layer_renderer_configuration_set_depth_usage^⚠layer_renderer_configuration and objc2-metal

Sets the texture usage for the layer’s depth textures to the specified value.

cp_layer_renderer_configuration_set_drawable_render_context_raster_sample_count^⚠layer_renderer_configuration

Sets the raster sample count for the drawable’s render context to the specified value.

cp_layer_renderer_configuration_set_drawable_render_context_stencil_format^⚠layer_renderer_configuration and objc2-metal

Sets the pixel format for the drawable’s render context stencil textures to the specified value.

cp_layer_renderer_configuration_set_foveation_enabled^⚠layer_renderer_configuration

Changes the setting that indicates whether the layer supports variable rasterization rates.

cp_layer_renderer_configuration_set_generate_flipped_rasterization_rate_maps^⚠layer_renderer_configuration

Changes the setting that indicates whether the layer provides flipped variable rasterization rate maps in addition to the regular maps.

cp_layer_renderer_configuration_set_layout^⚠layer_renderer_configuration and layer_renderer_layout

Changes the layout configuration for the drawable views in the layer.

cp_layer_renderer_configuration_set_max_render_quality^⚠cp_types and layer_renderer_configuration

Set max render quality the layer can use when drawing to the drawables.

cp_layer_renderer_configuration_set_supports_mtl4^⚠layer_renderer_configuration

Set whether the layer can use Metal4 when drawing to the drawables.

cp_layer_renderer_configuration_set_tracking_areas_format^⚠layer_renderer_configuration and objc2-metal

Sets the pixel format for the layer’s tracking areas textures to the specified value.

cp_layer_renderer_configuration_set_tracking_areas_usage^⚠layer_renderer_configuration and objc2-metal

Sets the texture usage for the layer’s tracking areas textures to the specified value.

cp_layer_renderer_get_configuration^⚠layer_renderer and layer_renderer_configuration

Returns the configuration details you used to create the specified layer.

cp_layer_renderer_get_device^⚠layer_renderer and objc2-metal

Returns the GPU interface that the layer uses for drawing operations.

cp_layer_renderer_get_minimum_frame_repeat_count^⚠layer_renderer

Return how many times a frame is repeated on display. This is typically used to build dynamic frame pacing.

cp_layer_renderer_get_mtl4_command_queue^⚠layer_renderer and objc2-metal

Returns the command queue that the layer uses for drawing operations.

cp_layer_renderer_get_properties^⚠layer_renderer and layer_renderer_properties

Returns the configured properties of the specified layer renderer.

cp_layer_renderer_get_render_quality^⚠cp_types and layer_renderer

Get the render quality to be used by the drawables.

cp_layer_renderer_get_state^⚠layer_renderer

Returns the layer’s current state, which indicates whether the layer is visible and ready for you to draw content.

cp_layer_renderer_properties_create_using_configuration^⚠layer_renderer_configuration and layer_renderer_properties and objc2-core-foundation

Creates a new opaque type to store layer-related properties.

cp_layer_renderer_properties_get_texture_topology^⚠layer_renderer_properties

Retrieves the texture topology at the specified index in the layer’s properties.

cp_layer_renderer_properties_get_texture_topology_count^⚠layer_renderer_properties

Returns the number of texture topologies available for you to inspect.

cp_layer_renderer_properties_get_tracking_areas_max_value^⚠layer_renderer_properties and tracking_area

Returns the max render value for tracking areas’ render values.

cp_layer_renderer_properties_get_view_count^⚠layer_renderer_properties

Returns the number of views that will need to be rendered.

cp_layer_renderer_query_next_frame^⚠frame and layer_renderer

Returns the next frame to use for drawing.

cp_layer_renderer_set_minimum_frame_repeat_count^⚠layer_renderer

Set the frame repeat count. This is typically used to build dynamic frame pacing.

cp_layer_renderer_set_render_quality^⚠cp_types and layer_renderer

Set the render quality to be used by the drawables.

cp_layer_renderer_wait_until_running^⚠layer_renderer

Stops further execution of your code until the layer renderer leaves the paused state.

cp_release^⚠cp_base

Decrement the reference count of the specified object.

cp_retain^⚠cp_base

Increments the reference count of the specified object.

cp_texture_topology_get_array_length^⚠Deprecatedlayer_renderer_properties

cp_texture_topology_get_texture_type^⚠Deprecatedlayer_renderer_properties and objc2-metal

cp_time_to_cf_time_interval^⚠Deprecatedcp_types and objc2-core-foundation

cp_time_wait_until^⚠Deprecatedcp_types

cp_tracking_area_add_automatic_hover_effect^⚠Deprecatedtracking_area

cp_tracking_area_get_identifier^⚠Deprecatedtracking_area

cp_tracking_area_get_render_value^⚠Deprecatedtracking_area

cp_view_get_view_texture_map^⚠Deprecatedview

cp_view_texture_map_get_slice_index^⚠Deprecatedview

cp_view_texture_map_get_texture_index^⚠Deprecatedview

cp_view_texture_map_get_viewport^⚠Deprecatedobjc2-metal and view

Type Aliases

cp_compositor_frame_index_tcp_types

The sequential index for a frame in the compositor’s timeline.

cp_drawable_array_tdrawable

An opaque type that contains the drawable types and other information you need to set up your render pipeline.

cp_drawable_render_context_tdrawable_render_context

An object that can render any effects associated with a drawable This is required for applications that want to render using the Progressive Immersion Style

cp_drawable_tdrawable

An opaque type that contains the textures and other information you need to set up your render pipeline.

cp_frame_tframe

An opaque type that provides access to the timing information and data types you need to render a single frame of content.

cp_frame_timing_tframe_timing

An opaque type that stores information about a frame’s encoding, rendering, and presentation deadlines.

cp_hover_effect_ttracking_area

An opaque type that describes a hover effect of the tracking area.

cp_layer_frame_index_tcp_types

A frame index in the layer’s timeline.

cp_layer_renderer_capabilities_tlayer_renderer_capabilities

A type that stores the supported configurations for a layer.

cp_layer_renderer_configuration_tlayer_renderer_configuration

An opaque type that stores the settings to apply to a Compositor layer renderer.

cp_layer_renderer_properties_tlayer_renderer_properties

An opaque type that describes the organization of the layer’s textures and the relationships between those textures and the views you use for drawing.

cp_layer_renderer_tlayer_renderer

An opaque type that provides the Metal types and timing information you need to draw your content.

cp_render_quality_tcp_types

Render quality controls the quality which drawing happens at.

cp_texture_topology_tlayer_renderer_properties

An opaque type that specifies the configuration of one of the layer’s drawable textures.

cp_time_tcp_types

A Mach absolute time clock value.

cp_tracking_area_identifiertracking_area

An identifier for the tracking area.

cp_tracking_area_render_valuetracking_area

A value used when rendering a tracking area.

cp_tracking_area_ttracking_area

An opaque type that describes a region of a view that interacts with the gaze/cursor.

cp_view_tview

An opaque type that manages the information for how to render content into the current frame.

cp_view_texture_map_tview

An opaque type that describes the relationship between a view and the underlying texture.