mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-08 19:10:35 +00:00
baldurk
bdee4706da
* Since CONTRIBUTING.md gets auto-linked whenever opening a pull-request, this is more convenient for contributors.
35 lines
2.2 KiB
Markdown
35 lines
2.2 KiB
Markdown
Windows
|
|
--------------
|
|
|
|
The main [renderdoc.sln](renderdoc.sln) is a VS2010 solution. To build on later VS versions, simply open & upgrade, I've tested building on VS2012 and VS2013 without issues. It compiles fine in the [free VS2013 version](http://www.visualstudio.com/en-us/news/vs2013-community-vs.aspx).
|
|
|
|
The only external dependency should be the [Windows 8.1 SDK](http://msdn.microsoft.com/en-us/windows/desktop/bg162891.aspx). The 8.0 SDK should also work fine, but [the vcxproj](renderdoc/renderdoc.vcxproj) is set up to look in `$(ProgramFiles)\Windows Kits\8.1\` for the necessary paths. If your SDK is installed elsewhere you'll also need to change these locally. You can also compile only against the June 2010 DirectX SDK if you undefine `INCLUDE_D3D_11_1` in `d3d11_common.h`, and `INCLUDE_DXGI_1_2` in `dxgi_wrapped.h`.
|
|
|
|
Profile configuration is recommended for day-to-day dev. It's debuggable but not too slow. Release configuration is then obviously what you should build for any builds you'll send out to people or if you want to evaluate performance.
|
|
|
|
### Visual Studio Visualisers ###
|
|
|
|
You might find these visualisers useful, going under your [Visualizer] section in autoexp.dat:
|
|
|
|
rdctype::str { preview([$e.elems,s]) stringview([$e.elems,s]) }
|
|
|
|
rdctype::array<*> {
|
|
preview ( #( "[",$e.count,"] {", #array(expr: $e.elems[$i], size: $e.count), "}") )
|
|
children ( #( #([size] : $e.count), #array(expr: $e.elems[$i], size: $e.count) ) )
|
|
}
|
|
|
|
Linux
|
|
--------------
|
|
|
|
Just 'make' in the root should do the trick. This build system is work in progress as the linux port is very early, so it may change!
|
|
|
|
There's no configuration or cmake setup, it assumes gcc/g++ (this can be overwridden via variables CC and CPP, or just in the makefiles), and links against -lX11 and -lGL.
|
|
|
|
Builds
|
|
--------------
|
|
|
|
Official releases will get a github release made for them, nightly builds and beta are just marked with the hash of the commit they were built from.
|
|
|
|
Please don't distribute releases marked with a version number and commit hash as it will confuse me with auto-submitted crashes since I won't have the symbols for them. If you distribute releases leave the version information as is (master is always marked as an unofficial non-versioned build).
|
|
|