Struct BackdropFilterLayer 

pub struct BackdropFilterLayer { /* private fields */ }

A composited layer that applies a filter to the existing contents of the scene.

Implementations

impl BackdropFilterLayer

pub fn new(app: &mut App) -> Handle<BackdropFilterLayer>

Creates a backdrop filter layer.

The filter property must be non-null before the compositing phase of the pipeline.

The blend_mode property defaults to BlendMode::SrcOver.

pub fn filter(self: Handle<Self>, app: &App) -> Option<&ImageFilter>

The filter to apply to the existing contents of the scene.

The scene must be explicitly recomposited after this property is changed (as described at Layer).

pub fn set_filter(self: Handle<Self>, app: &mut App, value: Option<ImageFilter>)

See filter.

pub fn blend_mode(self: Handle<Self>, app: &App) -> BlendMode

The blend mode to use to apply the filtered background content onto the background surface.

The default value of this property is BlendMode::SrcOver.

The scene must be explicitly recomposited after this property is changed (as described at Layer).

pub fn set_blend_mode(self: Handle<Self>, app: &mut App, value: BlendMode)

See blend_mode.

pub fn backdrop_key(self: Handle<Self>, app: &App) -> Option<BackdropKey>

The backdrop key that identifies the BackdropGroup this filter will apply to.

The default value for the backdrop key is None, meaning that it’s not part of a BackdropGroup.

The scene must be explicitly recomposited after this property is changed (as described at Layer).

pub fn set_backdrop_key( self: Handle<Self>, app: &mut App, value: Option<BackdropKey>, )

See backdrop_key.

Trait Implementations

impl ContainerLayer for BackdropFilterLayer

fn container_layer_data(self: Handle<Self>, app: &App) -> &ContainerLayerData

Mixin field access.

fn container_layer_data_mut( self: Handle<Self>, app: &mut App, ) -> &mut ContainerLayerData

See container_layer_data.

const AS_OFFSET: Option<fn() -> &'static OffsetLayerVTable> = None

The offset table when this type extends OffsetLayer; container_layer_accessors!(offset) sets it. Dart’s layer is OffsetLayer.

fn as_container_layer(self: Handle<Self>) -> AnyContainerLayer

Dart’s implicit upcast of a concrete layer to ContainerLayer.

fn apply_transform( self: Handle<Self>, app: &App, child: Option<AnyLayer>, transform: &mut Matrix4, )

Applies the transform that would be applied when compositing the given child to the given matrix.

fn fire_composition_callbacks( self: Handle<Self>, app: &mut App, include_children: bool, )

ContainerLayer._fireCompositionCallbacks.

fn supports_rasterization(self: Handle<Self>, app: &App) -> bool

ContainerLayer.supportsRasterization.

fn dispose(self: Handle<Self>, app: &mut App)

ContainerLayer.dispose.

fn find_annotations( self: Handle<Self>, app: &App, result: &mut AnnotationSearch, local_position: Offset, only_first: bool, ) -> bool

ContainerLayer.findAnnotations.

fn attach(self: Handle<Self>, app: &mut App, owner: HandleId)

ContainerLayer.attach.

fn detach(self: Handle<Self>, app: &mut App)

ContainerLayer.detach.

fn redepth_children(self: Handle<Self>, app: &mut App)

ContainerLayer.redepthChildren.

fn add_to_scene(self: Handle<Self>, app: &mut App, builder: &mut SceneBuilder)

ContainerLayer.addToScene.

impl Layer for BackdropFilterLayer

const AS_CONTAINER: Option<fn() -> &'static ContainerLayerVTable>

The container table when this type extends ContainerLayer; layer_accessors!(container) sets it. Dart’s layer is ContainerLayer.

fn layer_data(self: Handle<Self>, app: &App) -> &LayerData

Dart’s base-class fields, held under the field layer ([layer_accessors!]).

fn layer_data_mut(self: Handle<Self>, app: &mut App) -> &mut LayerData

See layer_data.

fn supports_rasterization(self: Handle<Self>, app: &App) -> bool

Whether or not this layer, or any child layers, can be rasterized with Scene.toImage.

fn dispose(self: Handle<Self>, app: &mut App)

Clears any retained resources that this layer holds.

fn attach(self: Handle<Self>, app: &mut App, owner: HandleId)

Mark this layer as attached to the given owner.

fn detach(self: Handle<Self>, app: &mut App)

Mark this layer as detached from its owner.

fn redepth_children(self: Handle<Self>, app: &mut App)

Adjust the depth of this node’s children, if any.

fn find_annotations( self: Handle<Self>, app: &App, result: &mut AnnotationSearch, local_position: Offset, only_first: bool, ) -> bool

Search this layer and its subtree for annotations of the searched type at the location described by local_position.

fn add_to_scene(self: Handle<Self>, app: &mut App, builder: &mut SceneBuilder)

Override this method to upload this layer to the engine.

fn fire_composition_callbacks( self: Handle<Self>, app: &mut App, include_children: bool, )

Dart’s _fireCompositionCallbacks; ContainerLayer recurses into its children.

fn describe_clip_bounds(self: Handle<Self>, app: &App) -> Option<Rect>

Describes the clip that would be applied to contents of this layer, if any.

fn always_needs_add_to_scene(self: Handle<Self>, app: &App) -> bool

Subclasses may override this to true to disable retained rendering.