D2DSvgImage

topic	languages	products
sample	cpp cppcx	windows windows-uwp

Direct2D SVG image rendering sample

Shows how to use Direct2D to draw and manipulate SVG images programmatically.

Note: This sample is part of a large collection of UWP feature samples. If you are unfamiliar with Git and GitHub, you can download the entire collection as a ZIP file, but be sure to unzip everything to access shared dependencies. For more info on working with the ZIP file, the samples collection, and GitHub, see Get the UWP samples from GitHub. For more samples, see the Samples portal on the Windows Dev Center.

Specifically, this sample shows how to:

• Load an SVG image from the app package and parse it with Direct2D.
• Use Direct2D's SVG object model APIs to programmatically walk the SVG tree and read/write SVG attributes.
• Render an SVG document parsed by Direct2D.

Sample project files

The sample's project files fall into the following categories.

Sample-specific files

The following files form the main educational content of the sample:

• DirectXPage.xaml/.cpp/.h/: Implements a XAML-based UI to drive the app. Hosts the DirectX content in a SwapChainPanel.
• App.xaml/.cpp/.h: The app's main entry point.
• D2DSvgImageRenderer.cpp/.h: The core implementation of the Direct2D scene.

DirectX SDK sample common files

The following files provide common functionality needed by DirectX SDK samples:

• DeviceResources.cpp/.h: Manages creation and lifetime of the core Direct3D and Direct2D device-dependent resources. Handles cases such as device lost and window size and orientation changes.
• DirectXHelper.h: Common inline helper functions, including ThrowIfFailed which converts HRESULT-based APIs into an exception model.

All DirectX SDK samples and the Visual Studio template DirectX projects contain a version of these files. These common files demonstrate important best practices for DirectX UWP apps, and you are encouraged to use them in your own projects.

C++ UWP common files

Variants of the following files are found in every UWP app written in C++:

• Package.appxmanifest
• pch.cpp/.h
• D2DSvgImageRenderer.vcxproj
• D2DSvgImageRenderer.vcxproj.filters
• D2DSvgImageRenderer.sln

Related topics

Feature areas

Direct2D: used to render images, primitives, and text.
XAML overview: technology for building user interfaces in managed and C++ code.

Reference

Direct2D APIs:

Direct2D SVG Support
ID2D1DeviceContext5::CreateSvgDocument
ID2D1SvgDocument
ID2D1SvgElement

Related APIs:

SwapChainPanel

System requirements

Client: Windows 10

Server: Windows Server 2016 Technical Preview

Phone: Windows 10

Build the sample

1. If you download the samples ZIP, be sure to unzip the entire archive, not just the folder with the sample you want to build.
2. Start Microsoft Visual Studio 2017 and select File > Open > Project/Solution.
3. Starting in the folder where you unzipped the samples, go to the Samples subfolder, then the subfolder for this specific sample, then the subfolder for your preferred language (C++, C#, or JavaScript). Double-click the Visual Studio Solution (.sln) file.
4. Press Ctrl+Shift+B, or select Build > Build Solution.

Run the sample

The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it.

Deploying the sample

• Select Build > Deploy Solution.

Deploying and running the sample

• To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging.

Run the sample

The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it.

Deploying the sample

• Select Build > Deploy Solution.

Deploying and running the sample

• To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging.