Skip to content

Commit

Permalink
docs: Wrote CategoryVulkan.
Browse files Browse the repository at this point in the history
  • Loading branch information
icculus committed Oct 4, 2024
1 parent 369b937 commit 8c3f88b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions include/SDL3/SDL_vulkan.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,19 @@
* # CategoryVulkan
*
* Functions for creating Vulkan surfaces on SDL windows.
*
* For the most part, Vulkan operates independent of SDL, but it benefits from
* a little support during setup.
*
* Use SDL_Vulkan_GetInstanceExtensions() to get platform-specific bits for
* creating a VkInstance, then SDL_Vulkan_GetVkGetInstanceProcAddr() to get
* the appropriate function for querying Vulkan entry points. Then
* SDL_Vulkan_CreateSurface() will get you the final pieces you need to
* prepare for rendering into an SDL_Window with Vulkan.
*
* Unlike OpenGL, most of the details of "context" creation and window buffer
* swapping are handled by the Vulkan API directly, so SDL doesn't provide
* Vulkan equivalents of SDL_GL_SwapWindow(), etc; they aren't necessary.
*/

#ifndef SDL_vulkan_h_
Expand Down

0 comments on commit 8c3f88b

Please sign in to comment.