README.intel-vulkan.txt

   1 Intel's Open Source Vulkan Driver
   2 Vulkan API Version: 0.170.2
   3 SPIR-V Version: 32
   4
   5 Intro
   6 =====
   7 The Open Source Technology Center 3D graphics team at Intel has
   8 been working on a Vulkan implementation based on the Mesa open source
   9 OpenGL implementation. At this point we're ready to share what we have
  10 with our Khronos friends, in the hope that an early preview will be
  11 useful.
  12
  13 When the Vulkan specification goes public, we will continue the work
  14 in the Mesa public git repository, but in the interim we will share
  15 our progress on the 'vulkan' branch in the 'mesa' repository in
  16 Khronos gitlab.
  17
  18 The Mesa project source and our driver implementation is under the MIT
  19 license [1], but is also covered by the Khronos IP framework as it
  20 pertains to a specification under construction [2].
  21
  22 We welcome all feedback and contibutions, as long as the contributions
  23 are MIT licensed and can be open sourced with the driver.
  24
  25 [1] https://opensource.org/licenses/MIT
  26 [2] https://www.khronos.org/members/ip-framework
  27
  28
  29 Maintainers
  30 ===========
  31 Kristian Høgsberg Kristensen <kristian.h.kristensen@intel.com>
  32 Jason Ekstrand <jason.ekstrand@intel.com>
  33 Chad Versace <chad.versace@intel.com>
  34
  35
  36 Supported Hardware
  37 ==================
  38 - Broadwell, main development focus
  39 - Ivybridge, early experimental support
  40
  41
  42 Supported OS Platforms
  43 ======================
  44  - Linux, tested on Fedora 22 with kernel >= 4.1
  45      - X11 with DRI3
  46      - Wayland
  47  - Android
  48      - TODO
  49
  50
  51 Building and Installing
  52 =======================
  53 This driver is intended to be used directly from the build tree. Installing the
  54 driver into a system location is not yet fully supported. If you require support
  55 for system-wide installation, please contact a maintainer.
  56
  57 Throughout the instructions, MESA_TOP refers to the top of the Mesa repository.
  58
  59 First, install the usual dependencies needed to build Mesa.
  60
  61         Fedora:
  62             $ sudo yum builddep mesa
  63         Ubunutu:
  64             $ FINISHME
  65
  66 Next, configure and build. The below commands will build Mesa in release mode.
  67 If you wish to build Mesa in debug mode, add option '--enable-debug' to the
  68 configure command.
  69
  70         $ cd $MESA_TOP
  71         $ autoreconf -vfi
  72         $ ./configure --with-dri-drivers=i965 --with-gallium-drivers=
  73         $ make
  74
  75 To use the driver's libvulkan.so directly, without LunarG's loader, you must set
  76 an environment variable before running your Vulkan application:
  77
  78         $ export LD_LIBRARY_PATH="$MESA_TOP/lib"
  79         $ your-vk-app
  80
  81 Alternatively, to use the driver with LunarG's loader:
  82
  83         $ export VK_ICD_FILENAMES="$MESA_TOP/src/vulkan/anv_icd.json"
  84         $ your-vk-app
  85
  86
  87 File Structure and Naming
  88 =========================
  89 The core code of Intel's Mesa Vulkan driver lives in src/vulkan. Files prefixed
  90 with "gen8" support Broadwell; files prefixed with "gen7" support Ivybridge;
  91 files prefixed with "anv" are common to all hardware generations.
  92
  93 Mesa is an umbrella open source project containing many drivers for multiple
  94 APIs. The codename for Intel's Mesa Vulkan driver is "Anvil", hence the filename
  95 prefix "anv".
  96
  97
  98 Feature Status
  99 ==============
 100 The driver is still a work-in-progress. We do our best to keep the below list of
 101 features up-to-date.
 102
 103 Supported Features:
 104   - Index buffers, instanced draw, indirect draw
 105   - Nested command buffers
 106   - Consumes SPIR-V (no GLSL "backdoor")
 107   - Fragment, vertex, and geometry shaders
 108   - Uniform buffers, sampled images, dynamic uniform buffers
 109   - Push constants (to the extent they're supported by SPIR-V v32)
 110   - Color, depth and stencil attachments
 111   - 1D, 2D, 3D textures, texture arrays
 112   - Memory barrier
 113   - Optionally integrates with LunarGs loader
 114   - WSI extension for X11
 115   - Fences
 116   - Most copy/blit commands for color and depth buffers,
 117     vkCmdCopyImageToBuffer for stencil buffers
 118   - Occlution query and timestamps
 119
 120 Unsupported Features:
 121    - Shader storage buffers
 122    - Shader specialization
 123    - Storage images
 124    - Compute and tesselation stages
 125    - Sparse resources
 126    - MSAA
 127    - VkkSemaphore and VkEvent
 128    - vkCmdClear commands
 129    - Input attachments