Struct ServerCompositionLinearGradientBrush 

pub struct ServerCompositionLinearGradientBrush { /* private fields */ }

The server-side counterpart of a CompositionLinearGradientBrush.

Implementations

impl ServerCompositionLinearGradientBrush

pub fn new( compositor: &Rc<ServerCompositor>, ) -> Rc<ServerCompositionLinearGradientBrush>

Creates the brush, active: the UI-thread brush activates its server object when it is created (InitializeDefaultsExtra), which is here done when the server object is created for it.

pub fn is_disposed(&self) -> bool

pub fn brush_props(&self) -> &ServerCompositionBrushProps

The properties of the generated ServerCompositionBrush.

impl ServerCompositionLinearGradientBrush

pub fn props(&self) -> &ServerCompositionLinearGradientBrushProps

The properties of the brush.

pub fn gradient(&self) -> &ServerCompositionGradientBrush

The gradient part of the brush.

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

pub fn spread_method(&self) -> GradientSpreadMethod

Trait Implementations

impl IAnimatedServerObject for ServerCompositionLinearGradientBrush

fn server_object(&self) -> &ServerObject

The embedded ServerObject part.

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

The composition property with the given name, if the class has one.

fn as_server_object_dyn(&self) -> &dyn IServerObject

The object as the base contract (an explicit upcast).

impl IBrush for ServerCompositionLinearGradientBrush

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_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_object(&self) -> Option<&FerroObject>

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

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

The brush viewed as ISolidColorBrush, 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_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 as_composition_brush(&self) -> Option<&CompositionBrush>

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

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 IGradientBrush for ServerCompositionLinearGradientBrush

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 ServerCompositionLinearGradientBrush

fn start_point(&self) -> RelativePoint

The start point for the gradient.

fn end_point(&self) -> RelativePoint

The end point for the gradient.

impl IServerAnimatedPropertyHost for ServerCompositionLinearGradientBrush

fn set_animated_value( &self, property: &'static CompositionProperty, current_value: ExpressionVariant, committed_at: Duration, animation: Rc<dyn IAnimationInstance>, )

SetAnimatedValue(prop, ref field, committedAt, animation): starts animation on the property. current_value is the value of the field as a variant; the animation writes the field through CompositionProperty::set_variant.

fn remove_animation_for_property(&self, property: &'static CompositionProperty)

The tail of SetAnimatedValue(prop, out field, value): the field has been assigned directly, so the animation of the property, if any, is removed.

fn notify_animated_value_changed(&self, _property: &'static CompositionProperty)

An animation wrote a new value into the field of property.

impl IServerObject for ServerCompositionLinearGradientBrush

fn deserialize_changes_core( &self, reader: &mut BatchStreamReader<'_>, committed_at: Duration, )

Reads the changes of the object from a batch.

fn values_invalidated(&self)

Called after a group of values of the object changed.

fn dispose(&self)

Releases the object: it has been disposed on the UI thread.

fn as_render_resource(self: Rc<Self>) -> Option<Rc<dyn IServerRenderResource>>

The object as a render resource, if it is one.

fn as_brush(self: Rc<Self>) -> Option<Rc<dyn IBrush>>

The object as a brush, if it is a server-side brush.

fn as_animated(self: Rc<Self>) -> Option<Rc<dyn IAnimatedServerObject>>

The object as an animatable object, if it is one.

fn get_props(&self, type_id: TypeId) -> Option<&dyn Any>

The generated property block of the given type embedded in the object, if it has one. A class that embeds generated properties forwards to their find_props; composition properties locate their fields through it.

fn as_any(&self) -> &dyn Any

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

fn deserialize_changes( &self, reader: &mut BatchStreamReader<'_>, committed_at: Duration, )

Applies the changes of the object from a batch.

fn as_pen(self: Rc<Self>) -> Option<Rc<dyn IPen>>

The object as a pen, if it is a server-side pen.

fn as_render_data_geometry( self: Rc<Self>, ) -> Option<Rc<dyn IRenderDataGeometry>>

The object as a geometry usable by render data, if it is a server-side geometry.

fn as_transform(self: Rc<Self>) -> Option<Rc<dyn ITransform>>

The object as a transform, if it is a server-side transform.

fn as_gradient_stop(self: Rc<Self>) -> Option<Rc<dyn IGradientStop>>

The object as a gradient stop, if it is a server-side gradient stop.

fn as_surface(self: Rc<Self>) -> Option<Rc<dyn IServerCompositionSurface>>

The object as a composition surface, if it is one.

impl IServerPropertyHost for ServerCompositionLinearGradientBrush

fn server_compositor(&self) -> Option<Rc<ServerCompositor>>

The compositor of the object, while it is alive. Used to resolve the server objects a batch refers to.

fn set_value( &self, _property: &'static CompositionProperty, change: ServerValueChange<'_>, )

SetValue(prop, ref field, value) as the class of the object defines it. A plain server object assigns; an animated object also invalidates the subscriptions of the property; a render resource goes through super::ServerRenderResourceCore::set_value.

impl IServerRenderResource for ServerCompositionLinearGradientBrush

fn add_observer(&self, observer: &Rc<dyn IServerRenderResourceObserver>)

fn remove_observer(&self, observer: &Rc<dyn IServerRenderResourceObserver>)

fn queued_invalidate(&self)

impl IServerRenderResourceHost for ServerCompositionLinearGradientBrush

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

The compositor of the resource, while it is alive.

fn as_render_resource_rc(&self) -> Option<Rc<dyn IServerRenderResource>>

The resource as a shared handle, for the invalidation queue.

fn resource_property_changed(&self)

Called once per group of property changes, before the queued invalidation.

impl IServerRenderResourceObserver for ServerCompositionLinearGradientBrush

fn dependency_queued_invalidate(&self, _sender: &dyn IServerRenderResource)

impl ServerCompositionBrushHooks for ServerCompositionLinearGradientBrush

fn deserialize_changes_extra(&self, _reader: &mut BatchStreamReader<'_>)

fn on_fields_deserialized(&self, _changed: CompositionBrushChangedFields)

fn on_transform_origin_changed(&self)

fn on_transform_origin_changing(&self)

fn on_transform_changed(&self)

fn on_transform_changing(&self)

fn on_relative_transform_changed(&self)

fn on_relative_transform_changing(&self)

impl ServerCompositionLinearGradientBrushHooks for ServerCompositionLinearGradientBrush

fn base_deserialize_changes_core( &self, reader: &mut BatchStreamReader<'_>, committed_at: Duration, )

base.DeserializeChangesCore(reader, committedAt): reads the changes of the hand-written base class ServerCompositionGradientBrush.

fn deserialize_changes_extra(&self, _reader: &mut BatchStreamReader<'_>)

fn on_fields_deserialized( &self, _changed: CompositionLinearGradientBrushChangedFields, )