# Build Instructions
-This project fully supports Linux today.
-Support for Windows is for the loader, layers, and the VkTrace trace/replay tools.
+This project fully supports Linux and Windows today.
Support for Android is TBD.
## Git the Bits
These packages are used for building and running the samples.
```
-sudo apt-get install git subversion cmake libgl1-mesa-dev freeglut3-dev libglm-dev libmagickwand-dev qt5-default libpciaccess-dev libpthread-stubs0-dev libudev-dev bison graphviz libpng-dev
+sudo apt-get install git subversion cmake libgl1-mesa-dev freeglut3-dev libglm-dev qt5-default libpciaccess-dev libpthread-stubs0-dev libudev-dev bison graphviz libpng-dev
sudo apt-get build-dep mesa
```
packaged, and how developers can point to ICDs and layers within their builds.
-## Linux Test
+## Validation Test
The test executibles can be found in the dbuild/tests directory. The tests use the Google
gtest infrastructure. Tests available so far:
-- vkbase: Test basic entry points
-- vk_blit_tests: Test VK Blits (copy, clear, and resolve)
-- vk_image_tests: Test VK image related calls needed by render_test
-- vk_render_tests: Render a single triangle with VK. Triangle will be in a .ppm in
-the current directory at the end of the test.
- vk_layer_validation_tests: Test Vulkan layers.
There are also a few shell and Python scripts that run test collections (eg,
- tri: a textured triangle
- cube: a textured spinning cube
-## Linux Render Nodes
-
-The render tests depend on access to DRM render nodes.
-To make that available, a couple of config files need to be created to set a module option
-and make accessible device files.
-The system will need to be rebooted with these files in place to complete initialization.
-These commands will create the config files.
-
-```
-sudo tee /etc/modprobe.d/drm.conf << EOF
-# Enable render nodes
-options drm rnodes=1
-EOF
-# this will add the rnodes=1 option into the boot environment
-sudo update-initramfs -k all -u
-```
-```
-sudo tee /etc/udev/rules.d/drm.rules << EOF
-# Add permissions to render nodes
-SUBSYSTEM=="drm", ACTION=="add", DEVPATH=="/devices/*/renderD*", MODE="020666"
-EOF
-```
-
## Windows System Requirements
Windows 7+ with additional required software packages:
- Microsoft Visual Studio 2013 Professional. Note: it is possible that lesser/older versions may work, but that has not been tested.
- CMake (from http://www.cmake.org/download/). Notes:
- - In order to build the VkTrace tools, you need at least version 3.0.
- Tell the installer to "Add CMake to the system PATH" environment variable.
- Python 3 (from https://www.python.org/downloads). Notes:
- Select to install the optional sub-package to add Python to the system PATH environment variable.
- Note: If you use Cygwin, you can normally use Cygwin's "git.exe". However, in order to use the "update_external_sources.bat" script, you must have this version.
- Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
- Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
-- Image Magick is used by the tests to compare images (from http://www.imagemagick.org/script/binary-releases.php)
- Install each a 32-bit and a 64-bit version, as the 64-bit installer does not install the 32-bit libraries and tools.
- - Here are some helpful links (warning they may go out of date with a newer ImageMagick).
- - 64-bit: http://www.imagemagick.org/download/binaries/ImageMagick-6.9.3-2-Q16-x64-dll.exe
- - 32-bit: http://www.imagemagick.org/download/binaries/ImageMagick-6.9.3-2-Q16-x86-dll.exe
- - For each of the installs, be sure to check box to "Install development headers and libraries"
- glslang is required for demos and tests.
- You can download and configure it (in a peer directory) here: https://github.com/KhronosGroup/glslang/blob/master/README.md
- A windows batch file has been included that will pull and build the correct version. Run it from Developer Command Prompt for VS2013 like so:
-# Explicit GL (VK) Ecosystem Components\r
-*Version 0.9, 28 Sep 2015*\r
+# Vulkan Ecosystem Components\r
+*Version 1.0, January 25, 2016*\r
\r
-This project provides *open source* tools for VK Developers.\r
+This project provides loader and validation layers for Vulkan developers on Windows and Linux.\r
\r
## Introduction\r
\r
-VK is an Explicit API, enabling direct control over how GPUs actually work. No validation, shader recompilation, memory management or synchronization is done inside an VK driver. Applications have full control and responsibility. Any errors in how VK is used are likely to result in a crash. This project provides layered utility libraries to ease development and help guide developers to proven safe patterns.\r
+Vulkan is an Explicit API, enabling direct control over how GPUs actually work. No (or very little) validation or error checking is done inside a VK driver. Applications have full control and responsibility. Any errors in how VK is used are likely to result in a crash. This project provides layered utility libraries to ease development and help guide developers to proven safe patterns.\r
\r
-New with VK in an extensible layered architecture that enables significant innovation in tools:\r
-- Cross IHV support enables tools vendors to plug into a common, extensible layer architecture\r
-- Layered tools during development enable validating, debugging and profiling without production performance impact\r
-- Modular validation architecture encourages many fine-grained layers--and new layers can be added easily\r
-- Encourages open community of tool developers: led by Valve, LunarG, Codeplay and others\r
-- Customized interactive debugging and validation layers will be available together with first drivers\r
-\r
-The components here are being shared with the Khronos community to provide\r
-insights into the specification as we approach an alpha header, and to assists those doing\r
-demos for GDC.\r
-\r
-The following components are available:\r
-- VK Library and header files, which include:\r
- - [*ICD Loader*](loader) and [*Layer Manager*](layers/README.md)\r
- - Snapshot of *VK* and *SPIR-V* header files from [*Khronos*](www.khronos.org)\r
-\r
-- [*VKTRACE tools*](vktrace)\r
+New with Vulkan is an extensible layered architecture that enables validation libraries to be implemented as layers. The loader is essential in supporting multiple drivers and GPUs along with layer library enablement.\r
\r
+The following components are available in this repository:\r
+- Vulkan header files\r
+- [*ICD Loader*](loader) and [*Layer Manager*](layers/README.md, loader/README.md\r
- Core [*Validation Layers*](layers/)\r
-\r
-- [*Sample Driver*](icd)\r
-\r
-## New\r
-\r
-- Header matches provisional specification (v170) with two changes.\r
- - DrawIndirect correction (bug #14715)\r
- - DynamicState refactor (bug #14365)\r
-- Provisional specification document (PDF & HTML)\r
-- Loader now uses JSON manifest files for ICDs and layers. See BUILD.md for details on customizing loader behavior.\r
-- All validation errors now reported via DEBUG_REPORT extension. [*DEBUG_REPORT*, Extension Document](TODO: link to VulkanDbgExtensions.docx)\r
-- Warning: The sample driver requires DRI3 and recent versions of ubuntu 14.10 have **REMOVED** DRI 3.\r
- Version: 2:2.99.914-1~exp1ubuntu4.1 is known to work.\r
- Ubuntu 15.04 requires customization to add DRI3.\r
- See BUILD.md for details.\r
-\r
-## Prior updates\r
+- Demos and tests for the loader and validation layers\r
\r
\r
## How to Build and Run\r
[BUILD.md](BUILD.md)\r
includes directions for building all the components, running the validation tests and running the demo applications.\r
\r
-Information on how to enable the various Debug and Validation layers is in\r
+Information on how to enable the various Validation layers is in\r
[layers/README.md](layers/README.md).\r
\r
-## References\r
-This version of the components are written based on the following preliminary specs and proposals:\r
-- [**Core Vulkan Header**, vulkan.h](https://gitlab.khronos.org/vulkan/vulkan/blob/6e1463d85b747fcad43c48eb8abd94d0f58824de/src/include/vulkan.h)\r
-- [**SPIR-V**, revision 32](https://cvs.khronos.org/svn/repos/SPIRV/trunk/Promoter32)\r
-- [**WSI Device Swapchain**, Revision 53 for VK_EXT_KHR_device_swapchain](https://cvs.khronos.org/svn/repos/promoters/specs/candidates/oglc/extensions/20150910/vk_ext_khr_device_swapchain.txt)\r
-- [**WSI Swapchain**, Revision 17 for VK_EXT_KHR_swapchain](https://cvs.khronos.org/svn/repos/promoters/specs/candidates/oglc/extensions/20150910/vk_ext_khr_swapchain.txt)\r
-\r
\r
## License\r
-This work is intended to be released as open source under a BSD-style\r
-license once the VK specification is public. Until that time, this work\r
+This work is intended to be released as open source under a MIT-style\r
+license once the Vulkan specification is public. Until that time, this work\r
is covered by the Khronos NDA governing the details of the VK API.\r
\r
## Acknowledgements\r
providing an initial co-editor for the spec; Qualcomm for picking up the\r
co-editor's chair; and Khronos, for providing hosting within GitHub.\r
\r
-## Contact\r
-If you have questions or comments about this driver; or you would like to contribute\r
-directly to this effort, please contact us at VK@LunarG.com; or if you prefer, via\r
-the GL Common mailing list: gl_common@khronos.org\r
projects / platform / upstream / Vulkan-LoaderAndValidationLayers.git / commitdiff