Win2D

Win2D is an easy-to-use Windows Runtime API for immediate mode 2D graphics rendering with GPU acceleration. It is available to C#, C++ and VB developers writing Windows apps for Windows 8.1, Windows Phone 8.1 and Windows 10. It utilizes the power of Direct2D, and integrates seamlessly with XAML and CoreWindow.

Where to get it

NuGet packages for Windows 10 or Windows / Phone 8.1
Source code

How to use it

Documentation
Sample code - also available in the Store

More info

Code Example

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:CanvasControl Draw="canvasControl_Draw" ClearColor="CornflowerBlue" />
</Grid>

and C#:

void 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++/CX:

void MainPage::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 VB:

Sub canvasControl_Draw(sender As CanvasControl, args As CanvasDrawEventArgs)
    args.DrawingSession.DrawEllipse(155, 115, 80, 30, Colors.Black, 3)
    args.DrawingSession.DrawText("Hello, world!", 100, 100, Colors.Yellow)
End Sub

Using Win2D

The documentation explains how to install Visual Studio, add the Win2D NuGet package to your project, and get started using the API.

Building Win2D from source

Requirements

Recommended: Visual Studio 2015 with Update 3 and Universal Windows App Development Tools 1.4.1
Visual Studio 2013 Update 5 is also supported (for Windows 8.1 or Windows Phone 8.1 development only)

Clone Repository

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

Build NuGet Packages

If using Visual Studio 2015:
- Launch 'MSBuild Command Prompt for VS2015'
If using Visual Studio 2013:
- In Windows search, type 'Visual Studio Tools', and select that folder to open it
- Launch 'Developer Command Prompt for VS2013'
Change directory to your cloned Win2D repository and run 'build'

Point Visual Studio at the resulting 'bin' directory

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 'Stable Only' setting to 'Include Prerelease' when adding them to your project.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

heejune/Win2D