Visual Visual Visual Visual Class

Definition

The base visual object in the visual hierarchy.

public : class Visual : CompositionObject, IVisual, IVisual2, IVisual3
struct winrt::Windows::UI::Composition::Visual : CompositionObject, IVisual, IVisual2, IVisual3
public class Visual : CompositionObject, IVisual, IVisual2, IVisual3
Public Class Visual Inherits CompositionObject Implements IVisual, IVisual2, IVisual3
Inheritance
VisualVisualVisualVisual
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Visual objects compose and render serialized drawing content and form the basis of a retained mode visual system. The Visual class supports basic position and clipping and can have 2D and 3D transformations applied to them. Additional functionality like solid colors, images, and content with effects is provided through subclasses like SpriteVisual or ContainerVisual, and by setting the Brush property of the visual to CompositionBrush subclasses such as CompositionColorBrush, CompositionEffectBrush, or CompositionSurfaceBrush.

Visual objects are thread-agile and not bound to the UI thread.

Animatable properties

The following properties can be animated. Call CompositionObject.StartAnimation to associate the property with a CompositionAnimation.

Rotation

Visual supports two forms of rotation:

  • axis-angle

    Axis-angle rotation uses the RotationAngle, RotationAxis, and CenterPoint properties to specify the rotation in degrees, which axis to rotate around, and the center point of the visual to rotate around.

  • orientation

    Rotation by orientation uses the Orientation property to specify a quaternion describing an orientation and rotation in 3D space.

Properties

AnchorPoint AnchorPoint AnchorPoint AnchorPoint

The point on the visual to be positioned at the visual's offset. Value is normalized with respect to the size of the visual. Animatable.

BackfaceVisibility BackfaceVisibility BackfaceVisibility BackfaceVisibility

Specifies whether the back face of the visual should be visible during a 3D transform.

BorderMode BorderMode BorderMode BorderMode

Specifies how to compose the edges of bitmaps and clips associated with a visual, or with all visuals in the subtree rooted at this visual. Setting BorderMode at a parent Visual will affect all children visuals in the subtree and can be selectively turned off at each child visual.

CenterPoint CenterPoint CenterPoint CenterPoint

The point about which rotation or scaling occurs. Animatable

Clip Clip Clip Clip

Specifies the clipping region for the visual. When a visual is rendered, only the portion of the visual that falls inside the clipping region is displayed, while any content that extends outside the clipping region is clipped (that is, not displayed).

Comment Comment Comment Comment

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
CompositeMode CompositeMode CompositeMode CompositeMode

Specifies how a visual's bitmap is blended with the screen.

Compositor Compositor Compositor Compositor

The Compositor used to create this CompositionObject.

(Inherited from CompositionObject)
Dispatcher Dispatcher Dispatcher Dispatcher

The dispatcher for the CompositionObject.

(Inherited from CompositionObject)
DispatcherQueue DispatcherQueue DispatcherQueue DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

(Inherited from CompositionObject)
ImplicitAnimations ImplicitAnimations ImplicitAnimations ImplicitAnimations

The collection of implicit animations attached to this object.

(Inherited from CompositionObject)
IsVisible IsVisible IsVisible IsVisible

Indicates whether the visual and its entire subtree of child visuals is visible.

Offset Offset Offset Offset

The offset of the visual relative to its parent or for a root visual the offset relative to the upper-left corner of the windows that hosts the visual. Animatable.

Opacity Opacity Opacity Opacity

The opacity of the visual. Animatable.

The opacity property determines the transparency, if any, of the Visual and is a value from 0 to 1. 0 is fully transparent and 1 is full opaque. A Visual with an Opacity property of 0 is still present in the tree. Like other properties on the Visual, Opacity can be animated using the Windows,UI.Composition animation system.

Orientation Orientation Orientation Orientation

A quaternion describing an orientation and rotation in 3D space that will be applied to the visual. Animatable.

Parent Parent Parent Parent

The parent of the visual.

ParentForTransform ParentForTransform ParentForTransform ParentForTransform

Visual specifying the coordinate system in which this visual is composed.

Properties Properties Properties Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)
RelativeOffsetAdjustment RelativeOffsetAdjustment RelativeOffsetAdjustment RelativeOffsetAdjustment

Specifies the offset of the visual with respect to the size of its parent visual.

RelativeSizeAdjustment RelativeSizeAdjustment RelativeSizeAdjustment RelativeSizeAdjustment

The size of the visual with respect to the size of its parent visual.

RotationAngle RotationAngle RotationAngle RotationAngle

The rotation angle in radians of the visual. Animatable.

RotationAngleInDegrees RotationAngleInDegrees RotationAngleInDegrees RotationAngleInDegrees

The rotation angle of the visual in degrees. Animatable.

RotationAxis RotationAxis RotationAxis RotationAxis

The axis to rotate the visual around. Animatable.

Scale Scale Scale Scale

The scale to apply to the visual.

Size Size Size Size

The width and height of the visual. Animatable.

TransformMatrix TransformMatrix TransformMatrix TransformMatrix

The transformation matrix to apply to the visual. Animatable.

Methods

Close Close Close Close

Closes the CompositionObject and releases system resources.

(Inherited from CompositionObject)
StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation)

Connects an animation with the specified property of the object and starts the animation.

(Inherited from CompositionObject)
StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase)

Starts an animation group.

The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object.

(Inherited from CompositionObject)
StopAnimation(String) StopAnimation(String) StopAnimation(String) StopAnimation(String)

Disconnects an animation from the specified property and stops the animation.

(Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase)

Stops an animation group.

(Inherited from CompositionObject)
TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String)

Returns an AnimationController for the animation running on the specified property.

(Inherited from CompositionObject)

See Also