CompositionDrawingSurface Class

Reference

Definition

Namespace:: Windows.UI.Composition

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

A drawing surface for interoperation with Direct2D or Direct3D.

public ref class CompositionDrawingSurface sealed : CompositionObject, ICompositionSurface

public ref class CompositionDrawingSurface : CompositionObject, ICompositionSurface

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class CompositionDrawingSurface final : CompositionObject, ICompositionSurface

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class CompositionDrawingSurface : CompositionObject, ICompositionSurface

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class CompositionDrawingSurface : CompositionObject, ICompositionSurface

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class CompositionDrawingSurface : CompositionObject, ICompositionSurface

Public NotInheritable Class CompositionDrawingSurface
Inherits CompositionObject
Implements ICompositionSurface

Public Class CompositionDrawingSurface
Inherits CompositionObject
Implements ICompositionSurface

Inheritance: Object Platform::Object IInspectable CompositionObject CompositionDrawingSurface

Derived: Windows.UI.Composition.CompositionVirtualDrawingSurface

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements: ICompositionSurface

Windows requirements

Device family	Windows 10 (introduced in 10.0.10586.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v2.0)

Examples

See the code example in Composition native interoperation with DirectX and Direct2D.

Remarks

CompositionDrawingSurface is a fixed sized surface that can be rendered with:

an image using LoadedImageSurface.
a custom drawing using Win2D (orD2D).
a video using MediaPlayer.

Version history

Windows version	SDK version	Value added
1703	15063	Resize
1703	15063	Scroll(PointInt32)
1703	15063	Scroll(PointInt32,RectInt32)
1703	15063	ScrollWithClip(PointInt32,RectInt32)
1703	15063	ScrollWithClip(PointInt32,RectInt32,RectInt32)
1703	15063	SizeInt32

Properties

AlphaMode	The alpha mode of the drawing surface.
Comment	A string to associate with the CompositionObject. (Inherited from CompositionObject)
Compositor	The Compositor used to create this CompositionObject. (Inherited from CompositionObject)
Dispatcher	The dispatcher for the CompositionObject. (Inherited from CompositionObject)
DispatcherQueue	Gets the DispatcherQueue for the CompostionObject. (Inherited from CompositionObject)
ImplicitAnimations	The collection of implicit animations attached to this object. (Inherited from CompositionObject)
PixelFormat	The pixel format of the drawing surface.
Properties	The collection of properties associated with the CompositionObject. (Inherited from CompositionObject)
Size	The size of the drawing surface.
SizeInt32	The size of the drawing surface.

Methods

Close()	Closes the CompositionObject and releases system resources. (Inherited from CompositionObject)
ConnectAnimation(String, CompositionAnimation)	Connects and animation. (Inherited from CompositionObject)
DisconnectAnimation(String)	Disconnects an animation. (Inherited from CompositionObject)
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from CompositionObject)
PopulatePropertyInfo(String, AnimationPropertyInfo)	Defines a property that can be animated. (Inherited from CompositionObject)
Resize(SizeInt32)	Resizes the drawing surface to the specified size.
Scroll(PointInt32, RectInt32)	Scrolls the drawing surface.
Scroll(PointInt32)	Scrolls the drawing surface.
ScrollWithClip(PointInt32, RectInt32, RectInt32)	Scrolls the drawing surface with the specified clip rectangle.
ScrollWithClip(PointInt32, RectInt32)	Scrolls the drawing surface using the specified clip rectangle.
StartAnimation(String, CompositionAnimation, AnimationController)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
StartAnimation(String, CompositionAnimation)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
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)	Disconnects an animation from the specified property and stops the animation. (Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	Stops an animation group. (Inherited from CompositionObject)
TryGetAnimationController(String)	Returns an AnimationController for the animation running on the specified property. (Inherited from CompositionObject)

Applies to

Jaa