Struct CompositingRenderer 

pub struct CompositingRenderer { /* private fields */ }

A renderer that utilizes a Compositor to render the visual tree.

Implementations

impl CompositingRenderer

pub fn new( root: &Rc<dyn IPresentationSource>, compositor: &Rc<Compositor>, surfaces: RenderSurfaces, ) -> Rc<CompositingRenderer>

Creates the renderer of the tree hosted by root. surfaces returns the platform surfaces to render to.

The renderer refers to its presentation source weakly: the source owns its renderer.

pub fn with_weak_root( root: Weak<dyn IPresentationSource>, compositor: &Rc<Compositor>, surfaces: RenderSurfaces, ) -> Rc<CompositingRenderer>

Like new, for a presentation source that is still being constructed.

pub fn composition_target(&self) -> &Rc<CompositionTarget>

The composition target the renderer draws the tree to.

pub fn compositor_handle(&self) -> &Rc<Compositor>

The compositor of the renderer.

pub fn set_root(&self, root: Option<Ref<Visual>>)

Sets the visual whose composition visual is the root of the composition target; None detaches the tree.

pub fn set_transparency_level(&self, level: CompositionTransparencyLevel)

Sets the transparency level the composition target renders with.

pub fn set_platform_specific_scene_info( &self, info: Option<Arc<dyn Any + Send + Sync>>, )

Sets the platform-specific scene info passed to the render target.

pub fn hit_tester(&self) -> Option<Rc<dyn IHitTester>>

The renderer as the hit tester of its scene.

pub fn as_any(&self) -> &dyn Any

pub fn trigger_scene_invalidated_for_unit_tests(&self, rect: Rect)

pub fn has_pending_update_for_unit_tests(&self, visual: &Visual) -> bool

Whether the renderer holds visual for its next update pass. For tests only.

pub fn is_disposed(&self) -> bool

Trait Implementations

impl IHitTester for CompositingRenderer

fn hit_test( &self, p: Point, root: &Visual, filter: Option<&dyn Fn(&Visual) -> bool>, ) -> Vec<Ref<Visual>>

Hit tests a location to find the visuals at the specified point, topmost first.

fn hit_test_geometry( &self, geometry: &Geometry, root: &Visual, filter: Option<&dyn Fn(&Visual) -> bool>, ) -> Vec<GeometryHitTestResult>

Hit tests a geometry to find the visuals intersecting a region, topmost first.

fn hit_test_first( &self, p: Point, root: &Visual, filter: Option<&dyn Fn(&Visual) -> bool>, ) -> Option<Ref<Visual>>

Hit tests a location to find the first (topmost) visual at the specified point.

fn hit_test_first_geometry( &self, geometry: &Geometry, root: &Visual, filter: Option<&dyn Fn(&Visual) -> bool>, ) -> Option<GeometryHitTestResult>

Hit tests a geometry to find the first (topmost) visual intersecting a region.

impl IRenderer for CompositingRenderer

fn diagnostics(&self) -> Rc<RendererDiagnostics>

A value controlling the renderer’s diagnostics.

fn scene_invalidated( &self, handler: Rc<dyn Fn(&SceneInvalidatedEventArgs)>, ) -> Rc<dyn IDisposable>

Subscribes to the notification raised when a portion of the scene has been invalidated.

fn add_dirty(&self, visual: &Visual)

Mark a visual as dirty and needing re-rendering.

fn recalculate_children(&self, visual: &Visual)

Informs the renderer that the z-ordering of a visual’s children has changed.

fn resized(&self, _size: Size)

Called when a resize notification is received by the control being rendered.

fn paint(&self, _rect: Rect)

Called when a paint notification is received by the control being rendered.

fn start(&self)

Starts the renderer.

fn stop(&self)

Stops the renderer.

fn try_get_render_interface_feature( &self, feature_type: TypeId, ) -> LocalFuture<Option<RenderInterfaceFeature>>

Attempts to query for a feature from the platform render interface: a future awaited on the thread of the renderer, which completes with the feature or None (see Compositor::try_get_render_interface_feature: asynchronous because the render interface may live on the render thread). The feature is an object of the server side: what is handed out lends it inside the compositor lock.

fn compositor(&self) -> Option<Rc<Compositor>>

The compositor of the renderer, if it renders through one (upstream: the IRendererWithCompositor interface).

fn dispose(&self)

Releases the renderer’s resources.