Zengtudor/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-29 13:32:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve Vulkan guide header section

Browse Source
This commit is contained in:
Camilla Löwy 2021-10-21 23:49:03 +02:00
parent db91507956
commit 393eac458b
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/vulkan.dox
View File

@ -50,7 +50,7 @@ documentation. This is explained in more detail in the
@section vulkan_include Including the Vulkan header file @section vulkan_include Including the Vulkan header file
To include the Vulkan header, define @ref GLFW_INCLUDE_VULKAN before including To have GLFW include the Vulkan header, define @ref GLFW_INCLUDE_VULKAN before including
the GLFW header. the GLFW header.
@code @code
@ -66,8 +66,12 @@ your own custom Vulkan header then do this before the GLFW header.
#include <GLFW/glfw3.h> #include <GLFW/glfw3.h>
@endcode @endcode
Unless a Vulkan header is included, either by the GLFW header or above it, any Unless a Vulkan header is included, either by the GLFW header or above it, the following
GLFW functions that take or return Vulkan types will not be declared. GLFW functions will not be declared, as depend on Vulkan types.
- @ref glfwGetInstanceProcAddress
- @ref glfwGetPhysicalDevicePresentationSupport
- @ref glfwCreateWindowSurface
The `VK_USE_PLATFORM_*_KHR` macros do not need to be defined for the Vulkan part The `VK_USE_PLATFORM_*_KHR` macros do not need to be defined for the Vulkan part
of GLFW to work. Define them only if you are using these extensions directly. of GLFW to work. Define them only if you are using these extensions directly.