CompositionMaskBrush Clase

Definición

Espacio de nombres:

Windows.UI.Composition

Pinta un SpriteVisual con un CompositionBrush con una máscara de opacidad aplicada. La fuente de la máscara de opacidad puede ser cualquier CompositionBrush de tipo CompositionColorBrush, CompositionLinearGradientBrush, CompositionSurfaceBrush, CompositionEffectBrush o CompositionNineGridBrush. La máscara de opacidad debe especificarse como 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

Herencia

Object Platform::Object IInspectable CompositionObject CompositionBrush CompositionMaskBrush

Atributos

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Requisitos de Windows

Familia de dispositivos	Windows 10 Anniversary Edition (se introdujo en la versión 10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (se introdujo en la versión v3.0)

Ejemplos

Aplique una máscara con forma de star a una imagen.

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;           
} 

Aplicar una máscara de opacidad a relleno de color sólido para crear una forma; animar la propiedad de transformación en la máscara de opacidad CompositionSurfaceBrush para crear una animación de floración de color

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);      
}

Aplicar una máscara de rectángulo redondeado para crear un rectángulo redondeado de color sólido cuyo radio de esquina no aumenta al cambiar el tamaño (use CompositionNineGridBrush como entrada para un 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;

}

Comentarios

CompositionMaskBrush no se puede establecer como parámetro de origen en compositionEffectBrush. Si desea aplicar un IGraphicsEffect al contenido enmascarado, use un CompositionEffectBrush con el efecto Composite en su lugar.

Propiedades

Comment	Cadena que se va a asociar con CompositionObject. (Heredado de CompositionObject)
Compositor	Compositor usado para crear este CompositionObject. (Heredado de CompositionObject)
Dispatcher	Distribuidor del compositionObject. (Heredado de CompositionObject)
DispatcherQueue	Obtiene dispatcherQueue para CompostionObject. (Heredado de CompositionObject)
ImplicitAnimations	Colección de animaciones implícitas adjuntas a este objeto. (Heredado de CompositionObject)
Mask	Pincel que contiene la máscara de opacidad con la que se va a enmascarar el contenido del pincel de origen. Puede ser de tipo CompositionSurfaceBrush o CompositionNineGridBrush.
Properties	Colección de propiedades asociadas a CompositionObject. (Heredado de CompositionObject)
Source	Pincel cuyo contenido se va a enmascarar mediante la máscara de opacidad. Puede ser de tipo CompositionSurfaceBrush, CompositionColorBrush o CompositionNineGridBrush.

Métodos

Close()	Cierra compositionObject y libera los recursos del sistema. (Heredado de CompositionObject)
ConnectAnimation(String, CompositionAnimation)	Conecta y animación. (Heredado de CompositionObject)
DisconnectAnimation(String)	Desconecta una animación. (Heredado de CompositionObject)
Dispose()	Realiza tareas definidas por la aplicación asociadas a la liberación o al restablecimiento de recursos no administrados. (Heredado de CompositionObject)
PopulatePropertyInfo(String, AnimationPropertyInfo)	Define una propiedad que se puede animar. (Heredado de CompositionObject)
StartAnimation(String, CompositionAnimation)	Conecta una animación con la propiedad especificada del objeto e inicia la animación. (Heredado de CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	Conecta una animación con la propiedad especificada del objeto e inicia la animación. (Heredado de CompositionObject)
StartAnimationGroup(ICompositionAnimationBase)	Inicia un grupo de animación. El método StartAnimationGroup en CompositionObject le permite iniciar CompositionAnimationGroup. Todas las animaciones del grupo se iniciarán al mismo tiempo en el objeto . (Heredado de CompositionObject)
StopAnimation(String)	Desconecta una animación de la propiedad especificada y detiene la animación. (Heredado de CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	Detiene un grupo de animación. (Heredado de CompositionObject)
TryGetAnimationController(String)	Devuelve un AnimationController para la animación que se ejecuta en la propiedad especificada. (Heredado de CompositionObject)

Consulte también

• CompositionBrush
• IClosable