Skip to content

Commit 117cac5

Browse files
committed
Added docs page for PipelineVisualFactory
1 parent f66deda commit 117cac5

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

docs/brushes/PipelineVisualFactory.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: PipelineVisualFactory
3+
author: Sergio0694
4+
description: A builder type to create sprite visuals with custom Win2D/Composition effects chains and attach them to UI elements.
5+
keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, brush, backdrop, blur, win2d, composition
6+
---
7+
8+
# PipelineVisualFactory
9+
10+
The [`PipelineVisualFactory`](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.media.PipelineVisualFactory) is a helper type that can be used to create sprite visuals with custom Win2D/Composition effects chains and attach them to UI elements. It can create the same visual brushes as the [`PipelineBrush`](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.media.pipelinebrush) type, but it can attach them directly on the underlying [`Visual`](https://docs.microsoft.com/uwp/api/windows.ui.composition.visual) instance backing a UI element. This can make the XAML code less verbose and more efficient, as there is no need to insert additional elements just so that a brush can be applied to them.
11+
12+
> **Platform APIs:** [`PipelineVisualFactory`](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.media.PipelineVisualFactory), [`PipelineBrush`](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.media.pipelinebrush)
13+
14+
## Syntax
15+
16+
```xaml
17+
<Grid Height="480" Width="720">
18+
<Grid.Background>
19+
<ImageBrush ImageSource="/Assets/landscape.jpg" Stretch="UniformToFill"/>
20+
</Grid.Background>
21+
22+
<Border
23+
VerticalAlignment="Center"
24+
HorizontalAlignment="Right"
25+
Height="480"
26+
Width="480">
27+
<media:UIElementExtensions.VisualFactory>
28+
<media:PipelineVisualFactory Source="{media:BackdropSource}">
29+
<media:LuminanceToAlphaEffect/>
30+
<media:OpacityEffect Value="0.4"/>
31+
<media:BlendEffect Mode="Multiply" Source="{media:BackdropSource}"/>
32+
<media:BlurEffect Amount="16"/>
33+
<media:ShadeEffect Color="#FF222222" Intensity="0.2"/>
34+
<media:BlendEffect Mode="Overlay" Placement="Foreground" Source="{media:TileSource Uri=ms-appx:///Assets/NoiseTexture.png}"/>
35+
</media:PipelineVisualFactory>
36+
</media:UIElementExtensions.VisualFactory>
37+
</Border>
38+
</Grid>
39+
```
40+
41+
## Example Image
42+
43+
![PipelineVisualFactory sample](../resources/images/Brushes/PipelineVisualFactory.jpg)
44+
45+
## Examples
46+
47+
You can find more examples in the [sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/master/Microsoft.Toolkit.Uwp.SampleApp).
Loading

0 commit comments

Comments
 (0)