CompositionVirtualDrawingSurface CompositionVirtualDrawingSurface CompositionVirtualDrawingSurface CompositionVirtualDrawingSurface Class

Definition

Represents sparsely allocated bitmaps that can be associated with visuals for composition in a visual tree.

public : class CompositionVirtualDrawingSurface : CompositionDrawingSurface
struct winrt::Windows::UI::Composition::CompositionVirtualDrawingSurface : CompositionDrawingSurface
public class CompositionVirtualDrawingSurface : CompositionDrawingSurface
Public Class CompositionVirtualDrawingSurface Inherits CompositionDrawingSurface
Inheritance
CompositionVirtualDrawingSurfaceCompositionVirtualDrawingSurfaceCompositionVirtualDrawingSurfaceCompositionVirtualDrawingSurface
Attributes

Windows 10 requirements

Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Remarks

The virtual drawing surface is designed for use in scenarios where an application needs to define a large amount of content but only expects a small portion of content to be visible to a user at a given time. For example, think of a long scrolling document or webpage. In such cases, the app only needs to draw the part of the surface that is currently visible to the user, and can defer drawing portions that are not visible until later when they become visible.

The maximum size of a virtual surface is 2^24(16M) pixels. This limit has been imposed because of floating point precision limits, that come into play beyond that size, which prevents guaranteed accurate pixel alignment of drawn patches.

Methods

Close Close Close Close

Closes the CompositionObject and releases system resources.

(Inherited from CompositionObject)
PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo)

Defines a property that can be animated.

(Inherited from CompositionObject)
Resize(SizeInt32) Resize(SizeInt32) Resize(SizeInt32) Resize(SizeInt32)

Resizes the drawing surface to the specified size.

(Inherited from CompositionDrawingSurface)
Scroll(PointInt32) Scroll(PointInt32) Scroll(PointInt32) Scroll(PointInt32)

Scrolls the drawing surface.

(Inherited from CompositionDrawingSurface)
Scroll(PointInt32,RectInt32) Scroll(PointInt32,RectInt32) Scroll(PointInt32,RectInt32) Scroll(PointInt32,RectInt32)

Scrolls the drawing surface.

(Inherited from CompositionDrawingSurface)
ScrollWithClip(PointInt32,RectInt32) ScrollWithClip(PointInt32,RectInt32) ScrollWithClip(PointInt32,RectInt32) ScrollWithClip(PointInt32,RectInt32)

Scrolls the drawing surface using the specified clip rectangle.

(Inherited from CompositionDrawingSurface)
ScrollWithClip(PointInt32,RectInt32,RectInt32) ScrollWithClip(PointInt32,RectInt32,RectInt32) ScrollWithClip(PointInt32,RectInt32,RectInt32) ScrollWithClip(PointInt32,RectInt32,RectInt32)

Scrolls the drawing surface with the specified clip rectangle.

(Inherited from CompositionDrawingSurface)
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)
StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase)

Starts an animation group on the specified target.

(Inherited from CompositionObject)
StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation)

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

(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)
Trim(RectInt32[]) Trim(RectInt32[]) Trim(RectInt32[]) Trim(RectInt32[])

Clears portions of a virtual drawing surface that were previously defined. Areas that are cleared will be treated as empty once again, and video memory that was previously backing them will be reclaimed.

TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String)

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

(Inherited from CompositionObject)

Properties

AlphaMode AlphaMode AlphaMode AlphaMode

The alpha mode of the drawing surface.

(Inherited from CompositionDrawingSurface)
Comment Comment Comment Comment

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
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)
PixelFormat PixelFormat PixelFormat PixelFormat

The pixel format of the drawing surface.

(Inherited from CompositionDrawingSurface)
Properties Properties Properties Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)
Size Size Size Size

The size of the drawing surface.

(Inherited from CompositionDrawingSurface)
SizeInt32 SizeInt32 SizeInt32 SizeInt32

The size of the drawing surface.

(Inherited from CompositionDrawingSurface)