CompositionMaskBrush Класс

Определение

Пространство имен:

Windows.UI.Composition

Рисует spriteVisual с помощью CompositionBrush с примененной к нему маской непрозрачности. Источником маски непрозрачности может быть любой объект CompositionBrush типа CompositionColorBrush, CompositionLinearGradientBrush, CompositionSurfaceBrush, CompositionEffectBrush или CompositionNineGridBrush. Маска непрозрачности должна быть указана как CompositionSurfaceBrush.

public ref class CompositionMaskBrush sealed : CompositionBrush

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

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

Public NotInheritable Class CompositionMaskBrush
Inherits CompositionBrush

Наследование

Object Platform::Object IInspectable CompositionObject CompositionBrush CompositionMaskBrush

Атрибуты

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Требования к Windows

Семейство устройств	Windows 10 Anniversary Edition (появилось в 10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (появилось в v3.0)

Примеры

Примените 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 с эффектом Composite .

Свойства

Comment	Строка, связанная с CompositionObject. (Унаследовано от CompositionObject)
Compositor	Составитель, используемый для создания этого объекта CompositionObject. (Унаследовано от CompositionObject)
Dispatcher	Диспетчер для CompositionObject. (Унаследовано от CompositionObject)
DispatcherQueue	Возвращает dispatcherQueue для объекта CompostionObject. (Унаследовано от CompositionObject)
ImplicitAnimations	Коллекция неявных анимаций, присоединенных к этому объекту. (Унаследовано от CompositionObject)
Mask	Кисть, содержащая маску непрозрачности, с помощью которой маскируется содержимое исходной кисти. Может иметь тип CompositionSurfaceBrush или CompositionNineGridBrush.
Properties	Коллекция свойств, связанных с CompositionObject. (Унаследовано от CompositionObject)
Source	Кисть, содержимое которой должно маскироваться маской непрозрачности. Может иметь тип CompositionSurfaceBrush, CompositionColorBrush или CompositionNineGridBrush.

Методы

Close()	Закрывает объект CompositionObject и освобождает системные ресурсы. (Унаследовано от CompositionObject)
ConnectAnimation(String, CompositionAnimation)	Соединения и анимация. (Унаследовано от CompositionObject)
DisconnectAnimation(String)	Отключает анимацию. (Унаследовано от CompositionObject)
Dispose()	Выполняет определяемые приложением задачи, связанные с удалением, высвобождением или сбросом неуправляемых ресурсов. (Унаследовано от CompositionObject)
PopulatePropertyInfo(String, AnimationPropertyInfo)	Определяет свойство, которое можно анимировать. (Унаследовано от CompositionObject)
StartAnimation(String, CompositionAnimation)	Подключает анимацию к указанному свойству объекта и запускает анимацию. (Унаследовано от CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	Подключает анимацию к указанному свойству объекта и запускает анимацию. (Унаследовано от CompositionObject)
StartAnimationGroup(ICompositionAnimationBase)	Запускает группу анимации. Метод StartAnimationGroup в CompositionObject позволяет запустить CompositionAnimationGroup. Все анимации в группе будут запущены одновременно для объекта . (Унаследовано от CompositionObject)
StopAnimation(String)	Отключает анимацию от указанного свойства и останавливает анимацию. (Унаследовано от CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	Останавливает группу анимации. (Унаследовано от CompositionObject)
TryGetAnimationController(String)	Возвращает AnimationController для анимации, выполняемой с указанным свойством. (Унаследовано от CompositionObject)

См. также раздел

• CompositionBrush
• IClosable