Struct Compositor 

pub struct Compositor(/* private fields */);

Factory for visuals, brushes, and window targets.

Implementations

impl Compositor

pub fn new() -> Result<Self>

Creates a compositor. A dispatcher queue must exist on the current thread.

use windows_composition::{Compositor, DispatcherQueueController};

let _queue = DispatcherQueueController::create_on_current_thread()?;
let compositor = Compositor::new()?;

pub fn create_desktop_window_target( &self, window: &Window, is_topmost: bool, ) -> Result<DesktopWindowTarget>

Creates a window target. Keep it alive while the visual tree is shown.

use windows_composition::{Compositor, DispatcherQueueController};
use windows_window::Window;

let window = Window::new("Composition").create()?;
let _queue = DispatcherQueueController::create_on_current_thread()?;
let compositor = Compositor::new()?;
let target = compositor.create_desktop_window_target(&window, false)?;

pub unsafe fn create_desktop_window_target_for_hwnd( &self, hwnd: *mut c_void, is_topmost: bool, ) -> Result<DesktopWindowTarget>

Creates a composition target for a raw window handle.

Safety

hwnd must be a valid, live window handle owned by the calling thread.

pub fn create_container_visual(&self) -> ContainerVisual

Creates an empty container visual that hosts a child visual tree.

pub fn create_sprite_visual(&self) -> SpriteVisual

Creates a sprite visual that paints itself with a brush.

pub fn create_color_brush(&self, color: Color) -> CompositionColorBrush

Creates a solid-color brush.

pub fn create_nine_grid_brush(&self) -> CompositionNineGridBrush

Creates a nine-grid brush.

pub fn create_shape_visual(&self) -> ShapeVisual

Creates a shape visual that renders composition shapes.

pub fn create_container_shape(&self) -> CompositionContainerShape

Creates an empty container shape that groups child shapes.

pub fn create_ellipse_geometry(&self) -> CompositionEllipseGeometry

Creates an ellipse geometry.

pub fn create_sprite_shape( &self, geometry: &CompositionEllipseGeometry, ) -> CompositionSpriteShape

Creates a sprite shape that fills the given geometry with a brush.

pub fn create_scoped_batch(&self, kind: BatchKind) -> CompositionScopedBatch

Creates a scoped batch that tracks the completion of the given kind of work.

pub fn create_vector3_key_frame_animation(&self) -> Vector3KeyFrameAnimation

Creates a Vector3 key-frame animation.

pub fn create_animation_group(&self) -> CompositionAnimationGroup

Creates an empty group whose animations start together.

pub fn create_scalar_key_frame_animation(&self) -> ScalarKeyFrameAnimation

Creates a scalar (f32) key-frame animation.

pub fn create_linear_easing_function(&self) -> CompositionEasingFunction

Creates a linear easing function.

pub fn create_cubic_bezier_easing_function( &self, control1: Vector2, control2: Vector2, ) -> CompositionEasingFunction

Creates a cubic-bezier easing function through the two control points (each in 0.0..=1.0), matching the CSS cubic-bezier() convention.

pub fn create_implicit_animation_collection( &self, ) -> ImplicitAnimationCollection

Creates an empty implicit-animation collection to attach to a visual with Visual::set_implicit_animations.

pub fn create_graphics_device( &self, rendering_device: &impl Interface, ) -> Result<CompositionGraphicsDevice>

Creates a composition graphics device backed by a Direct2D or DXGI device.

pub fn create_surface_brush( &self, surface: &CompositionDrawingSurface, ) -> CompositionSurfaceBrush

Creates a brush that paints a visual with a composition drawing surface.

Trait Implementations

impl Clone for Compositor

fn clone(&self) -> Compositor

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.