SpriteVisual
SpriteVisual
SpriteVisual
SpriteVisual
Class
Definition
Hosts 2D boxed content of type CompositionBrush. Any part of the visual not covered by pixels from the brush are rendered as transparent pixels. CompositionBrush can be either a CompositionBackdropBrush, CompositionColorBrush, a CompositionSurfaceBrush or a CompositionEffectBrush.
public : sealed class SpriteVisual : ContainerVisual, ISpriteVisual, ISpriteVisual2public sealed class SpriteVisual : ContainerVisual, ISpriteVisual, ISpriteVisual2Public NotInheritable Class SpriteVisual Inherits ContainerVisual Implements ISpriteVisual, ISpriteVisual2// This API is not available in Javascript.
- Inheritance
-
SpriteVisualSpriteVisualSpriteVisualSpriteVisual
- Attributes
Windows 10 requirements
| Device family |
Windows 10 (introduced v10.0.10586.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v2)
|
Inherited Members
Inherited properties
Inherited methods
StartAnimation(String,CompositionAnimation)StartAnimation(String,CompositionAnimation)StartAnimation(String,CompositionAnimation)StartAnimation(String,CompositionAnimation)
Examples
SpriteVisual visual= compositor.CreateSpriteVisual();
visual.Brush = compositor.CreateColorBrush (Colors.White);
SpriteVisual visual= compositor.CreateSpriteVisual();
var surface = graphicsDevice.CreateDrawingSurface(new Size(300, 50),
Windows.Graphics.DirectX.DirectXPixelFormat.B8G8R8A8UIntNormalized,
CompositionAlphaMode.Ignore);
visual.Brush = compsositor.CreateSurfaceBrush (surface);
Adding a Shadow
//Create surface brush and load in an image
CompositionSurfaceBrush surfaceBrush = compositor.CreateSurfaceBrush();
surfaceBrush.Surface = await imageLoader.LoadImageFromUriAsync(new Uri("ms-appx:///Assets/cat.jpg"));
//Create sprite visual
SpriteVisual visual = compositor.CreateSpriteVisual();
visual.Brush = surfaceBrush;
visual.Size = new Vector2(270, 200);
//Create drop shadow
DropShadow shadow = compositor.CreateDropShadow();
shadow.BlurRadius = 5;
shadow.Offset = new Vector3(15, 15, -10);
shadow.Color = Colors.DarkGray;
//Associate shadow to visual
visual.Shadow = shadow;
Properties
Brush Brush Brush Brush
A CompositionBrush describing how the SpriteVisual is painted.
public : CompositionBrush Brush { get; set; }public CompositionBrush Brush { get; set; }Public ReadWrite Property Brush As CompositionBrush// This API is not available in Javascript.
A CompositionBrush describing how the SpriteVisual is painted.
Shadow Shadow Shadow Shadow
The shadow for the SpriteVisual.
public : CompositionShadow Shadow { get; set; }public CompositionShadow Shadow { get; set; }Public ReadWrite Property Shadow As CompositionShadow// This API is not available in Javascript.
The shadow for the SpriteVisual.
Additional features and requirements
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|