CompositionMaskBrush 類別

定義

命名空間:

Microsoft.UI.Composition

使用套用不透明度遮罩的 CompositionBrush 繪製 SpriteVisual。 不透明度遮罩的來源可以是 CompositionColorBrush、CompositionLinearGradientBrush、CompositionSurfaceBrush、CompositionEffectBrush 或 CompositionNineGridBrush 的任何 CompositionBrush。 不透明度遮罩必須指定為 CompositionSurfaceBrush。

public ref class CompositionMaskBrush sealed : CompositionBrush

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
class CompositionMaskBrush final : CompositionBrush

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65536)]
public sealed class CompositionMaskBrush : CompositionBrush

Public NotInheritable Class CompositionMaskBrush
Inherits CompositionBrush

繼承

Object Platform::Object IInspectable CompositionObject CompositionBrush CompositionMaskBrush

屬性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

範例

將star形狀的遮罩套用至影像。

private SpriteVisual CreateCircleImage(ICompositionSurface myImageSurface, ICompositionSurface myStarMaskSurface) 
{ 
  // Create SurfaceBrush with image surface and specify stretch and alignment 
  CompositionSurfaceBrush imageBrush = _compositor.CreateSurfaceBrush(myImageSurface); 
  imageBrush.HorizontalAlignmentRatio = 0.5f; 
  imageBrush.VerticalAlignmentRatio = 0.5f; 
  imageBrush.Stretch = CompositionStretch.UniformToFill; 

  // Create surface brush with opacity mask surface and specify stretch and alignment 
  CompositionSurfaceBrush starMaskBrush = _compositor.CreateSurfaceBrush(myStarMaskSurface); 
  starMaskBrush.Stretch = CompositionStretch.Uniform; 

  // SpriteVisual to be painted with masked content 
  SpriteVisual imageVisual = _compositor.CreateSpriteVisual(); 
  imageVisual.Size = new Vector2(200, 200); 

  // Create MaskBrush 
  CompositionMaskBrush maskBrush = _compositor.CreateMaskBrush(); 
  maskBrush.Source = imageBrush; // Set source to content that is to be masked 
  maskBrush.Mask = starMaskBrush; // Set mask to content that is the opacity mask 

  imageVisual.Brush = maskBrush; // Paint SpriteVisual with MaskBrush 

  return imageVisual;           
} 

將不透明度遮罩套用至純色填滿以建立圖形;以動畫顯示不透明度遮罩 CompositionSurfaceBrush 上的轉換屬性，以建立色彩開開動畫

private void CreateCircleMaskSprite(ICompositionSurface myCircleMaskSurface, ICompositionSurface myImageSurface)
{
  // SpriteVisual to be painted by MaskBrush
  _circleVisual = _compositor.CreateSpriteVisual();
  _circleVisual.Size = MyContainerGrid.RenderSize.ToVector2();

  // SurfaceBrush w/ image as MaskBrush.Source
  CompositionSurfaceBrush imageBrush = _compositor.CreateSurfaceBrush(myImageSurface);
  imageBrush.Stretch = CompositionStretch.UniformToFill;

  // SurfaceBrush w/ opacity mask surface as MaskBrush.Mask
  CompositionSurfaceBrush circleBrush = _compositor.CreateSurfaceBrush(myCircleMaskSurface);

  // Specify stretch and transform properties to scale and position brush for initial state
  circleBrush.Stretch = CompositionStretch.Uniform;
  circleBrush.CenterPoint = _circleVisual.Size / 2;
  circleBrush.Scale = new Vector2(0.5f);

  // Create MaskBrush
  CompositionMaskBrush maskBrush = _compositor.CreateMaskBrush();
  maskBrush.Source = imageBrush;
  maskBrush.Mask = circleBrush;
  _circleVisual.Brush = maskBrush;

  // Set SpriteVisual as child of XAML Grid
  ElementCompositionPreview.SetElementChildVisual(MyContainerGrid, _circleVisual);
}

private void BloomAnimation()
{
  // Create KeyFrame Animation to target Scale transform on SurfaceBrush 
  Vector2KeyFrameAnimation scaleAnimation = _compositor.CreateVector2KeyFrameAnimation();
  scaleAnimation.InsertKeyFrame(1.0f, new Vector2(2));
  scaleAnimation.Duration = TimeSpan.FromMilliseconds(500);

  var maskBrush = (CompositionMaskBrush)_circleVisual.Brush;
  var surfaceBrush = (CompositionSurfaceBrush) maskBrush.Mask;

  // Animate the Scale on the circle opacity mask
  surfaceBrush.StartAnimation("Scale", scaleAnimation);      
}

套用圓角矩形遮罩來建立純色圓角矩形，其圓角半徑不會在調整大小時增加 (使用 CompositionNineGridBrush 作為 CompositionMaskBrush ) 的輸入。

private SpriteVisual CreateMaskedRoundedRectVisual(ICompositionSurface myRoundedRectMaskSurface)
{
  // ColorBrush to be set as MaskBrush.Source
  CompositionColorBrush colorBrush = _compositor.CreateColorBrush(Colors.Blue);

  // SurfaceBrush w/ opacity mask surface
  CompositionSurfaceBrush roundedRectBrush = _compositor.CreateSurfaceBrush(myRoundedRectMaskSurface);
  roundedRectBrush.Stretch = CompositionStretch.Fill; // stretch for center of nine-grid

  // NineGridBrush w/ insets on opacity mask surface
  CompositionNineGridBrush ninegridBrush = _compositor.CreateNineGridBrush();
  ninegridBrush.Source = roundedRectBrush;
  ninegridBrush.SetInsets(_cornerRadius); // the radius, in pixels, of the corner as specified on my opacity mask surface 

  // Create MaskBrush
  CompositionMaskBrush maskBrush = _compositor.CreateMaskBrush();
  maskBrush.Source = colorBrush;
  maskBrush.Mask = ninegridBrush;

  // Paint SpriteVisual with MaskBrush
  SpriteVisual sprite = _compositor.CreateSpriteVisual();
  sprite.Size = new Vector2(300, 200);
  sprite.Brush = maskBrush;
  return sprite;

}

備註

CompositionMaskBrush 無法設定為 CompositionEffectBrush的來源參數。 如果您想要將 IGraphicsEffect 套用至遮罩的內容，請改用 CompositionEffectBrush 搭配 複合效果 。

屬性

Comment	要與 CompositionObject 建立關聯的字串。 (繼承來源 CompositionObject)
Compositor	用來建立這個CompositionObject的Compositor。 (繼承來源 CompositionObject)
DispatcherQueue	取得 CompositionObject 的 DispatcherQueue。 (繼承來源 CompositionObject)
ImplicitAnimations	附加至這個 物件的隱含動畫集合。 (繼承來源 CompositionObject)
Mask	筆刷，其中包含要遮罩來源筆刷內容的不透明度遮罩。 可以是 CompositionSurfaceBrush 或 CompositionNineGridBrush 類型。
Properties	與 CompositionObject相關聯的屬性集合。 (繼承來源 CompositionObject)
Source	筆刷，其內容要由不透明度遮罩遮罩。 可以是 CompositionSurfaceBrush、CompositionColorBrush 或 CompositionNineGridBrush 類型。

方法

Close()	關閉 CompositionObject 並釋放系統資源。 (繼承來源 CompositionObject)
Dispose()	執行與釋放 (Free)、釋放 (Release) 或重設 Unmanaged 資源相關聯之應用程式定義的工作。 (繼承來源 CompositionObject)
PopulatePropertyInfo(String, AnimationPropertyInfo)	定義可以產生動畫效果的屬性。 (繼承來源 CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	將動畫與物件的指定屬性連接，並啟動動畫。 (繼承來源 CompositionObject)
StartAnimation(String, CompositionAnimation)	將動畫與物件的指定屬性連接，並啟動動畫。 (繼承來源 CompositionObject)
StartAnimationGroup(ICompositionAnimationBase)	啟動動畫群組。 CompositionObject上的StartAnimationGroup 方法可讓您啟動 CompositionAnimationGroup。 群組中的所有動畫都會在 物件上同時啟動。 (繼承來源 CompositionObject)
StopAnimation(String)	中斷動畫與指定屬性的連接，並停止動畫。 (繼承來源 CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	停止動畫群組。 (繼承來源 CompositionObject)
TryGetAnimationController(String)	傳回在指定屬性上執行之動畫的 AnimationController。 (繼承來源 CompositionObject)

另請參閱

• CompositionBrush
• IClosable