Visual Studio Graphics Content Pipeline for C# Projects
d3d11 sharpdx c# vs2012 vs2013
Since Visual Studio 2012 there has been a new graphics content pipeline and graphics debugger – including a DirectX frame debugger and HLSL debugger. The graphics content pipeline provides a number of build targets for converting common 3D and graphics assets into a usable format for DirectX applications, this includes the compilation of common mesh formats such as Collada (.dae), AutoDesk FBX (.fbx), and Wavefront (.obj) into a compiled mesh object (.cmo) file, and converting regular images into .DDS files.
Unfortunately the graphics content pipeline tasks don’t work out-of-the-box with C# because the MSBuild targets are not compatible.
Graphics content pipeline for C#
Thankfully it is quite simple to get this to work for our C# projects by making a few minor tweaks to the MSBuild target XML definitions. These build targets are defined in files named *Task.targets within the directories
- C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE\Extensions\Microsoft\VsGraphics
- C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\IDE\Extensions\Microsoft\VsGraphics
After extracting the contents of the archive we can use the content tasks by right clicking our project in the solution explorer and select Unload Project, then select Edit yourprojectname.csproj. At the end of the project file insert the following:
<Project ...> ... <Import Project="ImageContentTask.targets" /> <Import Project="MeshContentTask.targets" /> <Import Project="ShaderGraphContentTask.targets" /> </Project>
Reload your project, select a graphics resource such as a 3D model and then apply the appropriate Build Action, as shown in the following screenshot.
This will result in a Character.cmo file being generated in the project’s build output directory.
Controlling the graphics content pipeline task properties
In order to pass through options to the task for C# projects it is necessary to edit the associated *.props file. This contains a section for default settings. For example the ImageContentTask allows you to determine whether or not to generate mip levels. The following XML shows the available ImageContentTask parameters found in ImageContentTask.target
<ImageContentTask Source = "%(ImageContentTask.Identity)" ContentOutput = "%(ImageContentTask.ContentOutput)" Compress = "%(ImageContentTask.Compress)" GeneratePremultipliedAlpha = "%(ImageContentTask.GeneratePremultipliedAlpha)" GenerateMips = "%(ImageContentTask.GenerateMips)" TLogDir = "$(ProjectDir)obj\$(ConfigurationName)" IsDebugBuild = "$(UseDebugLibraries)" />
And the following XML extract shows the appropriate section within ImageContentTask.props that you would need to update.
<ImageContentTask> <!--Enter Defaults Here--> <ContentOutput Condition="'%(ImageContentTask.ContentOutput)' == '' and !$(DefineConstants.Contains('NETFX_CORE'))">$(OutDir)%(RelativeDir)%(Filename).dds</ContentOutput> <ContentOutput Condition="'%(ImageContentTask.ContentOutput)' == '' and $(DefineConstants.Contains('NETFX_CORE'))">$(OutDir)AppX\%(RelativeDir)%(Filename).dds</ContentOutput> </ImageContentTask>
Visual Studio 2012 brought with it some significant improvements for graphics / Direct3D programming for the C++ world, however it left C# developers a little short. By integrating the graphics content pipeline with your C# project you can then make use of these great features.
Direct3D Rendering Cookbook by Justin Stenning and published by Packt Publishing provides further examples of how to work with Direct3D in C# using SharpDX and the Visual Studio graphics content pipeline.
Article Update Log
20 Mar 2014: Initial release
About the Author(s)A software enthusiast since DOS was king, Justin Stenning has been working as a software engineer since he was 20. He has been the technical lead on a range of projects, from enterprise content management and software integrations to mobile apps, mapping, and biosecurity management systems.
Justin has been involved in a number of open source projects, including capturing images from fullscreen Direct3D games and displaying in-game overlays, and enjoys giving a portion of his spare time to the open source community. Justin completed his Bachelor of Information Technology at Central Queensland University, Rockhampton.
When not coding or gaming, he is thinking about coding or gaming, or riding his motorbike. Justin lives with the awesome one, the cheeky one and the quirky one in Central Victoria, Australia.