mightypanda / Win2D

An easy-to-use Windows Runtime API for immediate mode 2D graphics rendering

Win2D

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

Win2D is work in progress and evolving rapidly. The goal of releasing this code in an early, incomplete state is to solicit early developer feedback.

• NuGet packages
• Documentation
• Features - what's implemented so far
• Backlog - what we plan to add next
• Team blog
• License
• Contributing

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"

<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);
}

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

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

• 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.