Lines Matching refs:Vulkan
3 @page vulkan_guide Vulkan guide
7 This guide is intended to fill the gaps between the [Vulkan
10 with Vulkan concepts like loaders, devices, queues and surfaces and leaves it to
11 the Vulkan documentation to explain the details of Vulkan functions.
13 To develop for Vulkan you should install an SDK for your platform, for example
14 the [LunarG Vulkan SDK](https://vulkan.lunarg.com/). Apart from the headers and
17 The GLFW library does not need the Vulkan SDK to enable support for Vulkan.
18 However, any Vulkan-specific test and example programs are built only if the
19 CMake files find a Vulkan SDK.
31 @section vulkan_include Including the Vulkan and GLFW header files
33 To include the Vulkan header, define [GLFW_INCLUDE_VULKAN](@ref build_macros)
41 If you instead want to include the Vulkan header from a custom location or use
42 your own custom Vulkan header then do this before the GLFW header.
49 Unless a Vulkan header is included, either by the GLFW header or above it, any
50 GLFW functions that take or return Vulkan types will not be declared.
52 The `VK_USE_PLATFORM_*_KHR` macros do not need to be defined for the Vulkan part
56 @section vulkan_support Querying for Vulkan support
58 If you are linking directly against the Vulkan loader then you can skip this
59 section. The canonical desktop loader library exports all Vulkan core and
62 If you are loading the Vulkan loader dynamically instead of linking directly
69 // Vulkan is available, at least for compute
73 This function returns `GLFW_TRUE` if the Vulkan loader was found. This check is
76 If no loader was found, calling any other Vulkan related GLFW function will
80 @subsection vulkan_proc Querying Vulkan function pointers
82 To load any Vulkan core or extension function from the found loader, call @ref
91 Once you have created an instance, you can load from it all other Vulkan core
100 function falls back to a platform-specific query of the Vulkan loader (i.e.
102 For more information about `vkGetInstanceProcAddr`, see the Vulkan
105 Vulkan also provides `vkGetDeviceProcAddr` for loading device-specific versions
106 of Vulkan function. This function can be retrieved from an instance with @ref
116 about `vkGetDeviceProcAddr`, see the Vulkan documentation.
119 @section vulkan_ext Querying required Vulkan extensions
121 To do anything useful with Vulkan you need to create an instance. If you want
122 to use Vulkan to render to a window, you must enable the instance extensions
123 GLFW requires to create Vulkan surfaces.
138 If it fails it will return `NULL` and GLFW will not be able to create Vulkan
139 window surfaces. You can still use Vulkan for off-screen rendering and compute
161 @section vulkan_present Querying for Vulkan presentation support
163 Not every queue family of every Vulkan device can present images to surfaces.
177 an existing Vulkan surface.
182 Unless you will be using OpenGL or OpenGL ES with the same window as Vulkan,
194 @section vulkan_surface Creating a Vulkan window surface
196 You can create a Vulkan surface (as defined by the `VK_KHR_surface` extension)