Struct CompositionBrush 

pub struct CompositionBrush { /* private fields */ }

A brush of the composition API.

Implementations

impl CompositionBrush

pub fn brush_props(&self) -> &CompositionBrushProps

The generated properties of CompositionBrush.

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

pub fn object(&self) -> &CompositionObject

The embedded CompositionObject.

pub fn server(&self) -> ServerObjectId

The id of the server-side brush.

pub fn is_disposed(&self) -> bool

pub fn type_name(&self) -> &'static str

The name of the concrete class, for messages.

pub fn to_rc(&self) -> Rc<CompositionBrush>

The handle of the brush, from a reference to it (an IBrush seen as a CompositionBrush through IBrush::as_composition_brush).

pub fn as_brush(&self) -> Rc<dyn IBrush>

The brush as an IBrush handle.

pub fn implicit_animations(&self) -> Option<Rc<ImplicitAnimationCollection>>

The collection of implicit animations attached to this object.

pub fn set_implicit_animations( &self, value: Option<Rc<ImplicitAnimationCollection>>, )

pub fn opacity(&self) -> f64

pub fn set_opacity(&self, value: f64)

pub fn transform_origin(&self) -> RelativePoint

pub fn set_transform_origin(&self, value: RelativePoint)

pub fn transform(&self) -> Option<Rc<dyn ITransform>>

pub fn set_transform(&self, value: Option<Rc<dyn ITransform>>)

Sets the transform. What the server receives is the form a transform takes on a compositor (GetServer): an immutable transform as it is, a mutable one as a copy of its current value.

pub fn relative_transform(&self) -> Option<Rc<dyn ITransform>>

pub fn set_relative_transform(&self, value: Option<Rc<dyn ITransform>>)

Sets the relative transform; see set_transform.

Trait Implementations

impl AsCompositionObject for CompositionBrush

fn as_composition_object(&self) -> &CompositionObject

The embedded CompositionObject.

fn composition_type_name(&self) -> &'static str

The name of the class of the object, for messages.

fn as_property_set(self: Rc<Self>) -> Option<Rc<CompositionPropertySet>>

The object as a property set, if it is one (the is CompositionPropertySet test of upstream).

impl CompositionBrushHooks for CompositionBrush

InitializeDefaultsExtra activates the server object: done when the server object is created (see the constructors of the server brushes).

fn initialize_defaults_extra(&self)

fn validate_opacity_change(&self, _old_value: f64, _new_value: f64)

fn on_opacity_changed(&self)

fn on_opacity_changing(&self)

fn validate_transform_origin_change( &self, _old_value: RelativePoint, _new_value: RelativePoint, )

fn on_transform_origin_changed(&self)

fn on_transform_origin_changing(&self)

fn validate_transform_change( &self, _old_value: &Option<BatchResource<dyn ITransform>>, _new_value: &Option<BatchResource<dyn ITransform>>, )

fn on_transform_changed(&self)

fn on_transform_changing(&self)

fn validate_relative_transform_change( &self, _old_value: &Option<BatchResource<dyn ITransform>>, _new_value: &Option<BatchResource<dyn ITransform>>, )

fn on_relative_transform_changed(&self)

fn on_relative_transform_changing(&self)

impl CompositionConicGradientBrushHooks for CompositionBrush

fn base_serialize_changes_core(&self, writer: &mut BatchStreamWriter<'_>)

base.SerializeChangesCore(writer): serializes the changes of the hand-written base class CompositionGradientBrush.

fn initialize_defaults_extra(&self)

fn validate_angle_change(&self, _old_value: f64, _new_value: f64)

fn on_angle_changed(&self)

fn on_angle_changing(&self)

fn validate_center_change( &self, _old_value: RelativePoint, _new_value: RelativePoint, )

fn on_center_changed(&self)

fn on_center_changing(&self)

fn validate_anchor_point_change(&self, _old_value: Vector, _new_value: Vector)

fn on_anchor_point_changed(&self)

fn on_anchor_point_changing(&self)

fn validate_center_point_change(&self, _old_value: Vector, _new_value: Vector)

fn on_center_point_changed(&self)

fn on_center_point_changing(&self)

fn validate_offset_change(&self, _old_value: Vector, _new_value: Vector)

fn on_offset_changed(&self)

fn on_offset_changing(&self)

fn validate_rotation_angle_change(&self, _old_value: f32, _new_value: f32)

fn on_rotation_angle_changed(&self)

fn on_rotation_angle_changing(&self)

fn validate_scale_change(&self, _old_value: Vector, _new_value: Vector)

fn on_scale_changed(&self)

fn on_scale_changing(&self)

fn validate_transform_matrix_change( &self, _old_value: Matrix, _new_value: Matrix, )

fn on_transform_matrix_changed(&self)

fn on_transform_matrix_changing(&self)

impl CompositionLinearGradientBrushHooks for CompositionBrush

fn base_serialize_changes_core(&self, writer: &mut BatchStreamWriter<'_>)

base.SerializeChangesCore(writer): serializes the changes of the hand-written base class CompositionGradientBrush.

fn initialize_defaults_extra(&self)

fn validate_start_point_change( &self, _old_value: RelativePoint, _new_value: RelativePoint, )

fn on_start_point_changed(&self)

fn on_start_point_changing(&self)

fn validate_end_point_change( &self, _old_value: RelativePoint, _new_value: RelativePoint, )

fn on_end_point_changed(&self)

fn on_end_point_changing(&self)

fn validate_anchor_point_change(&self, _old_value: Vector, _new_value: Vector)

fn on_anchor_point_changed(&self)

fn on_anchor_point_changing(&self)

fn validate_center_point_change(&self, _old_value: Vector, _new_value: Vector)

fn on_center_point_changed(&self)

fn on_center_point_changing(&self)

fn validate_offset_change(&self, _old_value: Vector, _new_value: Vector)

fn on_offset_changed(&self)

fn on_offset_changing(&self)

fn validate_rotation_angle_change(&self, _old_value: f32, _new_value: f32)

fn on_rotation_angle_changed(&self)

fn on_rotation_angle_changing(&self)

fn validate_scale_change(&self, _old_value: Vector, _new_value: Vector)

fn on_scale_changed(&self)

fn on_scale_changing(&self)

fn validate_transform_matrix_change( &self, _old_value: Matrix, _new_value: Matrix, )

fn on_transform_matrix_changed(&self)

fn on_transform_matrix_changing(&self)

impl CompositionMaskBrushHooks for CompositionBrush

fn initialize_defaults_extra(&self)

fn validate_source_change( &self, _old_value: &Option<Rc<dyn ICompositionObject>>, _new_value: &Option<Rc<dyn ICompositionObject>>, )

fn on_source_changed(&self)

fn on_source_changing(&self)

fn validate_mask_change( &self, _old_value: &Option<Rc<dyn ICompositionObject>>, _new_value: &Option<Rc<dyn ICompositionObject>>, )

fn on_mask_changed(&self)

fn on_mask_changing(&self)

impl CompositionNineGridBrushHooks for CompositionBrush

fn initialize_defaults_extra(&self)

fn validate_source_change( &self, _old_value: &Option<Rc<dyn ICompositionObject>>, _new_value: &Option<Rc<dyn ICompositionObject>>, )

fn on_source_changed(&self)

fn on_source_changing(&self)

fn validate_left_inset_change(&self, _old_value: f32, _new_value: f32)

fn on_left_inset_changed(&self)

fn on_left_inset_changing(&self)

fn validate_top_inset_change(&self, _old_value: f32, _new_value: f32)

fn on_top_inset_changed(&self)

fn on_top_inset_changing(&self)

fn validate_right_inset_change(&self, _old_value: f32, _new_value: f32)

fn on_right_inset_changed(&self)

fn on_right_inset_changing(&self)

fn validate_bottom_inset_change(&self, _old_value: f32, _new_value: f32)

fn on_bottom_inset_changed(&self)

fn on_bottom_inset_changing(&self)

fn validate_left_inset_scale_change(&self, _old_value: f32, _new_value: f32)

fn on_left_inset_scale_changed(&self)

fn on_left_inset_scale_changing(&self)

fn validate_top_inset_scale_change(&self, _old_value: f32, _new_value: f32)

fn on_top_inset_scale_changed(&self)

fn on_top_inset_scale_changing(&self)

fn validate_right_inset_scale_change(&self, _old_value: f32, _new_value: f32)

fn on_right_inset_scale_changed(&self)

fn on_right_inset_scale_changing(&self)

fn validate_bottom_inset_scale_change(&self, _old_value: f32, _new_value: f32)

fn on_bottom_inset_scale_changed(&self)

fn on_bottom_inset_scale_changing(&self)

fn validate_is_center_hollow_change(&self, _old_value: bool, _new_value: bool)

fn on_is_center_hollow_changed(&self)

fn on_is_center_hollow_changing(&self)

impl CompositionRadialGradientBrushHooks for CompositionBrush

fn base_serialize_changes_core(&self, writer: &mut BatchStreamWriter<'_>)

base.SerializeChangesCore(writer): serializes the changes of the hand-written base class CompositionGradientBrush.

fn initialize_defaults_extra(&self)

fn validate_center_change( &self, _old_value: RelativePoint, _new_value: RelativePoint, )

fn on_center_changed(&self)

fn on_center_changing(&self)

fn validate_gradient_origin_change( &self, _old_value: RelativePoint, _new_value: RelativePoint, )

fn on_gradient_origin_changed(&self)

fn on_gradient_origin_changing(&self)

fn validate_radius_x_change( &self, _old_value: RelativeScalar, _new_value: RelativeScalar, )

fn on_radius_x_changed(&self)

fn on_radius_x_changing(&self)

fn validate_radius_y_change( &self, _old_value: RelativeScalar, _new_value: RelativeScalar, )

fn on_radius_y_changed(&self)

fn on_radius_y_changing(&self)

fn validate_anchor_point_change(&self, _old_value: Vector, _new_value: Vector)

fn on_anchor_point_changed(&self)

fn on_anchor_point_changing(&self)

fn validate_center_point_change(&self, _old_value: Vector, _new_value: Vector)

fn on_center_point_changed(&self)

fn on_center_point_changing(&self)

fn validate_offset_change(&self, _old_value: Vector, _new_value: Vector)

fn on_offset_changed(&self)

fn on_offset_changing(&self)

fn validate_rotation_angle_change(&self, _old_value: f32, _new_value: f32)

fn on_rotation_angle_changed(&self)

fn on_rotation_angle_changing(&self)

fn validate_scale_change(&self, _old_value: Vector, _new_value: Vector)

fn on_scale_changed(&self)

fn on_scale_changing(&self)

fn validate_transform_matrix_change( &self, _old_value: Matrix, _new_value: Matrix, )

fn on_transform_matrix_changed(&self)

fn on_transform_matrix_changing(&self)

impl CompositionSolidColorBrushHooks for CompositionBrush

fn initialize_defaults_extra(&self)

fn validate_color_change(&self, _old_value: Color, _new_value: Color)

fn on_color_changed(&self)

fn on_color_changing(&self)

impl CompositionSurfaceBrushHooks for CompositionBrush

fn initialize_defaults_extra(&self)

fn validate_surface_change( &self, _old_value: &Option<Rc<dyn ICompositionObject>>, _new_value: &Option<Rc<dyn ICompositionObject>>, )

fn on_surface_changed(&self)

fn on_surface_changing(&self)

fn validate_stretch_change( &self, _old_value: CompositionStretch, _new_value: CompositionStretch, )

fn on_stretch_changed(&self)

fn on_stretch_changing(&self)

fn validate_horizontal_alignment_ratio_change( &self, _old_value: f32, _new_value: f32, )

fn on_horizontal_alignment_ratio_changed(&self)

fn on_horizontal_alignment_ratio_changing(&self)

fn validate_vertical_alignment_ratio_change( &self, _old_value: f32, _new_value: f32, )

fn on_vertical_alignment_ratio_changed(&self)

fn on_vertical_alignment_ratio_changing(&self)

fn validate_bitmap_interpolation_mode_change( &self, _old_value: CompositionBitmapInterpolationMode, _new_value: CompositionBitmapInterpolationMode, )

fn on_bitmap_interpolation_mode_changed(&self)

fn on_bitmap_interpolation_mode_changing(&self)

fn validate_anchor_point_change(&self, _old_value: Vector, _new_value: Vector)

fn on_anchor_point_changed(&self)

fn on_anchor_point_changing(&self)

fn validate_center_point_change(&self, _old_value: Vector, _new_value: Vector)

fn on_center_point_changed(&self)

fn on_center_point_changing(&self)

fn validate_offset_change(&self, _old_value: Vector, _new_value: Vector)

fn on_offset_changed(&self)

fn on_offset_changing(&self)

fn validate_rotation_angle_change(&self, _old_value: f32, _new_value: f32)

fn on_rotation_angle_changed(&self)

fn on_rotation_angle_changing(&self)

fn validate_scale_change(&self, _old_value: Vector, _new_value: Vector)

fn on_scale_changed(&self)

fn on_scale_changing(&self)

fn validate_transform_matrix_change( &self, _old_value: Matrix, _new_value: Matrix, )

fn on_transform_matrix_changed(&self)

fn on_transform_matrix_changing(&self)

fn validate_snap_to_pixels_change(&self, _old_value: bool, _new_value: bool)

fn on_snap_to_pixels_changed(&self)

fn on_snap_to_pixels_changing(&self)

impl IBrush for CompositionBrush

fn opacity(&self) -> f64

The opacity of the brush.

fn transform(&self) -> Option<Rc<dyn ITransform>>

The transform of the brush.

fn transform_origin(&self) -> RelativePoint

The origin of the brush transform.

fn relative_transform(&self) -> Option<Rc<dyn ITransform>>

The transform of the brush, relative to the bounds of the painted area.

fn as_any(&self) -> &dyn Any

The implementing value, for downcasts to immutable brush types. For mutable brushes use as_object.

fn as_solid_color_brush(&self) -> Option<&dyn ISolidColorBrush>

The brush viewed as ISolidColorBrush, when it is one.

fn as_gradient_brush(&self) -> Option<&dyn IGradientBrush>

The brush viewed as IGradientBrush, when it is one.

fn as_linear_gradient_brush(&self) -> Option<&dyn ILinearGradientBrush>

The brush viewed as ILinearGradientBrush, when it is one.

fn as_radial_gradient_brush(&self) -> Option<&dyn IRadialGradientBrush>

The brush viewed as IRadialGradientBrush, when it is one.

fn as_conic_gradient_brush(&self) -> Option<&dyn IConicGradientBrush>

The brush viewed as IConicGradientBrush, when it is one.

fn as_composition_brush(&self) -> Option<&CompositionBrush>

The brush as a composition brush, when it is one (the is CompositionBrush test of upstream).

fn as_object(&self) -> Option<&FerroObject>

The object behind the brush when it is a mutable Brush.

fn as_tile_brush(&self) -> Option<&dyn ITileBrush>

The brush viewed as ITileBrush, when it is one.

fn as_image_brush(&self) -> Option<&dyn IImageBrush>

The brush viewed as IImageBrush, when it is one.

fn as_scene_brush(&self) -> Option<&dyn ISceneBrush>

The brush viewed as ISceneBrush, when it is one.

fn as_mutable_brush(&self) -> Option<&dyn IMutableBrush>

The brush viewed as IMutableBrush, when it is one.

fn as_immutable_brush(&self) -> Option<&dyn IImmutableBrush>

The brush viewed as IImmutableBrush, when it is one (the is IImmutableBrush test of upstream).

fn as_composition_render_resource( &self, ) -> Option<&dyn ICompositionRenderResource>

The composition render resource behind the object, if it is a mutable object with server-side counterparts on the compositors it is drawn with.

fn into_immutable_brush(self: Rc<Self>) -> Option<Rc<dyn IImmutableBrush>>

The brush as an IImmutableBrush handle, when it is immutable.

fn to_shared(&self) -> Option<SharedBrush>

The form of the brush that is sent to the render thread, when the type keeps one: see SharedBrush. An immutable brush creates it once, so its identity is stable.

fn equals(&self, other: &dyn IBrush) -> bool

Whether the brush equals other. Brushes compare by reference unless the type defines structural equality (immutable solid color brushes).

impl ICompositionObject for CompositionBrush

fn server(&self) -> ServerObjectId

The id of the server-side counterpart of the object.

fn as_any(&self) -> &dyn Any

fn into_any_rc(self: Rc<Self>) -> Rc<dyn Any>

impl ICompositionObjectAnimations for CompositionBrush

fn stop_animation(&self, property_name: &str)

StopAnimation: an animatable property of an effect brush is stopped on the property set of the brush, which runs it; any other property as for every composition object.

fn try_start_animation( &self, property_name: &str, animation: &dyn ICompositionAnimation, final_value: Option<ExpressionVariant>, ) -> bool

StartAnimation(propertyName, animation, finalValue) of the class: returns false for a property the class does not know.

fn get_composition_property( &self, property_name: &str, ) -> Option<&'static CompositionProperty>

The composition property with the given name.

fn composition_object(&self) -> &CompositionObject

The embedded CompositionObject.

fn start_animation( &self, property_name: &str, animation: &dyn ICompositionAnimation, )

Connects an animation with the named property of the object and starts the animation.

fn start_animation_with_final_value( &self, property_name: &str, animation: &dyn ICompositionAnimation, final_value: Option<ExpressionVariant>, )

See start_animation. property_name may name a sub-channel of a vector property (Offset.X, Scale.XY, components X, Y, Z, W in any case): the animation then animates a value of the sub-channel’s type (a scalar for one component, a Vector2 for two, …) and leaves the other components alone. Several sub-channels of one property run together; an animation of the whole property replaces them.

fn start_animation_with_controller( &self, property_name: &str, animation: &dyn ICompositionAnimation, controller: &Rc<AnimationController>, )

StartAnimation(propertyName, animation, animationController): starts the animation under controller, which can pause, resume, scrub and speed it up. property_name may name a sub-channel, as for start_animation.

fn try_get_animation_controller( &self, property_name: &str, ) -> Option<Rc<AnimationController>>

The controller of the animation of the named property (TryGetAnimationController): the controller it was started with, or a new controller that takes the running animation over. None when no animation was started on the property through this object, or it was stopped.

fn start_animation_group(&self, grp: &dyn ICompositionAnimationBase)

Starts an animation group. The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object.

fn start_animation_group_part( &self, animation: &dyn ICompositionAnimation, target: &str, final_value: ExpressionVariant, ) -> bool

StartAnimationGroupPart.

fn start_animation_group_for( &self, grp: &dyn ICompositionAnimationBase, target: &str, final_value: ExpressionVariant, ) -> bool

Starts an animation or an animation group triggered by the change of property target to final_value. Returns whether one of the animations targets that property.

fn stop_animation_group(&self, grp: &dyn ICompositionAnimationBase)

Stops an animation group.

impl ICompositionObjectHost for CompositionBrush

fn server(&self) -> ServerObjectId

The id of the server-side counterpart of the object.

fn pending_animations(&self) -> &PendingAnimations

The animations waiting to be sent with the next batch.

fn implicit_animation( &self, property_name: &str, ) -> Option<Rc<dyn ICompositionAnimationBase>>

The implicit animation attached to a property of the object, if there is one (ImplicitAnimations?.TryGetValue(name)).

fn start_animation_group( &self, grp: &Rc<dyn ICompositionAnimationBase>, target: &str, final_value: ExpressionVariant, ) -> bool

Starts an animation or an animation group triggered by the change of property target to final_value. Returns whether one of the animations targets that property.

impl ICompositorSerializable for CompositionBrush

fn try_get_server(&self, c: &Compositor) -> Option<ServerObjectId>

The server-side counterpart of the object on compositor c, if it has one.

fn serialize_changes(&self, c: &Compositor, writer: &mut BatchStreamWriter<'_>)

Writes the pending changes of the object for compositor c.

fn serialization_key(&self) -> *const ()

The identity of the object, by which a compositor avoids queueing it twice. The default is the address of the implementing value; an adapter around an object returns the identity of that object.

fn prepare_serialization(&self, _c: &Compositor)

Called before the changes of the object are written for compositor c.

impl IConicGradientBrush for CompositionBrush

fn center(&self) -> RelativePoint

The center point for the gradient.

fn angle(&self) -> f64

The starting angle for the gradient in degrees, measured from the point above the center point.

impl IGradientBrush for CompositionBrush

fn gradient_stops(&self) -> Vec<Rc<dyn IGradientStop>>

The brush’s gradient stops.

fn spread_method(&self) -> GradientSpreadMethod

The brush’s spread method that defines how to draw a gradient that doesn’t fill the bounds of the destination control.

impl ILinearGradientBrush for CompositionBrush

fn start_point(&self) -> RelativePoint

The start point for the gradient.

fn end_point(&self) -> RelativePoint

The end point for the gradient.

impl IRadialGradientBrush for CompositionBrush

fn center(&self) -> RelativePoint

The start point for the gradient.

fn gradient_origin(&self) -> RelativePoint

The location of the two-dimensional focal point that defines the beginning of the gradient.

fn radius_x(&self) -> RelativeScalar

The horizontal radius of the outermost circle of the radial gradient.

fn radius_y(&self) -> RelativeScalar

The vertical radius of the outermost circle of the radial gradient.

impl IRegisterForSerialization for CompositionBrush

fn register_for_serialization(&self)

impl ISolidColorBrush for CompositionBrush

fn color(&self) -> Color

The color of the brush.