Struct CompositionSurfaceBrushProps 

pub struct CompositionSurfaceBrushProps { /* private fields */ }

The UI-thread properties of CompositionSurfaceBrush.

Implementations

impl CompositionSurfaceBrushProps

pub fn new() -> Self

Creates the properties with every field at the default of its type. The defaults of the schema are applied by initialize_defaults.

pub fn base(&self) -> &CompositionBrushProps

The properties of the base class.

pub fn initialize_defaults(&self, host: &dyn CompositionSurfaceBrushHooks)

The InitializeDefaults calls of the constructor chain: the base classes first, then this class.

pub fn initialize_own_defaults(&self, host: &dyn CompositionSurfaceBrushHooks)

InitializeDefaults of this class alone.

pub fn surface(&self) -> Option<Rc<dyn ICompositionObject>>

Surface (FerroUI overlay).

pub fn set_surface( &self, host: &dyn CompositionSurfaceBrushHooks, value: Option<Rc<dyn ICompositionObject>>, )

Sets Surface (FerroUI overlay).

pub fn stretch(&self) -> CompositionStretch

Stretch (default CompositionStretch::Fill, FerroUI overlay).

pub fn set_stretch( &self, host: &dyn CompositionSurfaceBrushHooks, value: CompositionStretch, )

Sets Stretch (default CompositionStretch::Fill, FerroUI overlay).

pub fn horizontal_alignment_ratio(&self) -> f32

HorizontalAlignmentRatio (animated, default 0.5, FerroUI overlay).

pub fn set_horizontal_alignment_ratio( &self, host: &dyn CompositionSurfaceBrushHooks, value: f32, )

Sets HorizontalAlignmentRatio (animated, default 0.5, FerroUI overlay).

pub fn vertical_alignment_ratio(&self) -> f32

VerticalAlignmentRatio (animated, default 0.5, FerroUI overlay).

pub fn set_vertical_alignment_ratio( &self, host: &dyn CompositionSurfaceBrushHooks, value: f32, )

Sets VerticalAlignmentRatio (animated, default 0.5, FerroUI overlay).

pub fn bitmap_interpolation_mode(&self) -> CompositionBitmapInterpolationMode

BitmapInterpolationMode (default CompositionBitmapInterpolationMode::Linear, FerroUI overlay).

pub fn set_bitmap_interpolation_mode( &self, host: &dyn CompositionSurfaceBrushHooks, value: CompositionBitmapInterpolationMode, )

Sets BitmapInterpolationMode (default CompositionBitmapInterpolationMode::Linear, FerroUI overlay).

pub fn anchor_point(&self) -> Vector

AnchorPoint (animated, FerroUI overlay).

pub fn set_anchor_point( &self, host: &dyn CompositionSurfaceBrushHooks, value: Vector, )

Sets AnchorPoint (animated, FerroUI overlay).

pub fn center_point(&self) -> Vector

CenterPoint (animated, FerroUI overlay).

pub fn set_center_point( &self, host: &dyn CompositionSurfaceBrushHooks, value: Vector, )

Sets CenterPoint (animated, FerroUI overlay).

pub fn offset(&self) -> Vector

Offset (animated, FerroUI overlay).

pub fn set_offset(&self, host: &dyn CompositionSurfaceBrushHooks, value: Vector)

Sets Offset (animated, FerroUI overlay).

pub fn rotation_angle(&self) -> f32

RotationAngle (animated, FerroUI overlay).

pub fn set_rotation_angle( &self, host: &dyn CompositionSurfaceBrushHooks, value: f32, )

Sets RotationAngle (animated, FerroUI overlay).

pub fn scale(&self) -> Vector

Scale (animated, default Vector::new(1.0, 1.0), FerroUI overlay).

pub fn set_scale(&self, host: &dyn CompositionSurfaceBrushHooks, value: Vector)

Sets Scale (animated, default Vector::new(1.0, 1.0), FerroUI overlay).

pub fn transform_matrix(&self) -> Matrix

TransformMatrix (animated, default Matrix::IDENTITY, FerroUI overlay).

pub fn set_transform_matrix( &self, host: &dyn CompositionSurfaceBrushHooks, value: Matrix, )

Sets TransformMatrix (animated, default Matrix::IDENTITY, FerroUI overlay).

pub fn snap_to_pixels(&self) -> bool

SnapToPixels (FerroUI overlay).

pub fn set_snap_to_pixels( &self, host: &dyn CompositionSurfaceBrushHooks, value: bool, )

Sets SnapToPixels (FerroUI overlay).

pub fn start_animation( &self, host: &dyn CompositionSurfaceBrushHooks, property_name: &str, animation: &dyn ICompositionAnimation, final_value: Option<ExpressionVariant>, ) -> bool

Connects an animation with the named property. Returns false when neither this class nor its generated bases have an animated property of that name: the caller continues with its hand-written base.

pub fn serialize_changes_core( &self, host: &dyn CompositionSurfaceBrushHooks, writer: &mut BatchStreamWriter<'_>, )

Writes the changes of the object: the base class first, then the changed-fields mask and the changed members of this class.

Trait Implementations

impl Default for CompositionSurfaceBrushProps

fn default() -> Self

Returns the “default value” for a type.