Repository files navigation

Moving Win2D over to WindowsAppSdk and WinUI3 is a work in progress, and some features such as CanvasAnimatedControl have partial or no support.

Win2D is an easy-to-use Windows Runtime API for immediate mode 2D graphicsrendering with GPU acceleration. It is available to C#, C++ and VB developerswriting apps for WinUI3. It utilizes the powerof Direct2D, and integrates seamlessly with XAML.

Visit theDirectX Landing Page for more resources for DirectX developers.

• NuGet package
• Source code

• Documentation
• Sample code -also available in theStore (not updated for Reunion)

• Report a bug or ask a question
• Changelog
• License
• Contributing

To give you a flavor of what the code looks like, here is a snippet of XAML:

xmlns:canvas="using:Microsoft.Graphics.Canvas.UI.Xaml"<Grid>    <canvas:CanvasControlDraw="canvasControl_Draw"ClearColor="CornflowerBlue" /></Grid>

and C#:

voidcanvasControl_Draw(CanvasControlsender,CanvasDrawEventArgsargs){args.DrawingSession.DrawEllipse(155,115,80,30,Colors.Black,3);args.DrawingSession.DrawText("Hello, world!",100,100,Colors.Yellow);}

or C++/CX:

voidMainPage::CanvasControl_Draw(CanvasControl^ sender, CanvasDrawEventArgs^ args){    args->DrawingSession->DrawEllipse(155,115,80,30, Colors::Black,3);    args->DrawingSession->DrawText("Hello, world!",100,100, Colors::Yellow);}

or C++/WinRT:

voidMainPage::CanvasControl_Draw(CanvasControlconst& sender, CanvasDrawEventArgsconst& args){    args.DrawingSession().DrawEllipse(155,115,80,30,Colors::Black(),3);    args.DrawingSession().DrawText(L"Hello, world!",100,100,Colors::Yellow());}

or VB:

SubcanvasControl_Draw(senderAsCanvasControl,argsAsCanvasDrawEventArgs)args.DrawingSession.DrawEllipse(155,115,80,30,Colors.Black,3)args.DrawingSession.DrawText("Hello, world!",100,100,Colors.Yellow)EndSub

Thedocumentation explains how to install VisualStudio, add the Win2D NuGet package to your project, and get started using the API.

• Visual Studio 2019 16.9 with Tools for Universal Windows Apps 15.0.27428.01 and Windows SDK 18362

• Go to 'View' -> 'Team Explorer' -> 'Local Git Repositories' -> 'Clone'
• Add the Win2D repository URL (https://github.com/Microsoft/Win2D.git) and hit 'Clone'

• Launch 'Developer Command Prompt for VS2019'
• Change directory to your cloned Win2D repository and run 'build'

• In Visual Studio, go to 'Tools' -> 'NuGet Package Manager' -> 'Package Manager Settings'
• Choose 'Package Sources'
• Click the '+' button to add a new source
• Set 'Name' to 'Win2D' (or a name of your choosing)
• Set 'Source' to the full path to the 'bin' directory (inside your cloned Win2D repository)
• Click the 'Update' button
• Click 'OK'

Locally built versions of Win2D are marked as prerelease, so you must change the 'StableOnly' setting to 'Include Prerelease' when adding them to your project.

This project has adopted theMicrosoft Open Source Code of Conduct.For more information see theCode of Conduct FAQ or contactopencode@microsoft.com with any additional questions or comments.