SDL 3.0
SDL_vulkan.h File Reference

Header file for functions to creating Vulkan surfaces on SDL windows. More...

+ Include dependency graph for SDL_vulkan.h:

Go to the source code of this file.

Macros

#define VK_DEFINE_HANDLE(object)   typedef struct object##_T* object;
 
#define VK_DEFINE_NON_DISPATCHABLE_HANDLE(object)   typedef uint64_t object;
 

Typedefs

typedef VkInstance SDL_vulkanInstance
 
typedef VkSurfaceKHR SDL_vulkanSurface
 

Functions

Vulkan support functions
int SDL_Vulkan_LoadLibrary (const char *path)
 
SDL_FunctionPointer SDL_Vulkan_GetVkGetInstanceProcAddr (void)
 
void SDL_Vulkan_UnloadLibrary (void)
 
SDL_bool SDL_Vulkan_GetInstanceExtensions (unsigned int *pCount, const char **pNames)
 
SDL_bool SDL_Vulkan_CreateSurface (SDL_Window *window, VkInstance instance, VkSurfaceKHR *surface)
 

Detailed Description

Header file for functions to creating Vulkan surfaces on SDL windows.

Definition in file SDL_vulkan.h.

Macro Definition Documentation

◆ VK_DEFINE_HANDLE

#define VK_DEFINE_HANDLE (   object)    typedef struct object##_T* object;

Definition at line 44 of file SDL_vulkan.h.

◆ VK_DEFINE_NON_DISPATCHABLE_HANDLE

#define VK_DEFINE_NON_DISPATCHABLE_HANDLE (   object)    typedef uint64_t object;

Definition at line 49 of file SDL_vulkan.h.

Typedef Documentation

◆ SDL_vulkanInstance

typedef VkInstance SDL_vulkanInstance

Definition at line 57 of file SDL_vulkan.h.

◆ SDL_vulkanSurface

typedef VkSurfaceKHR SDL_vulkanSurface

Definition at line 58 of file SDL_vulkan.h.

Function Documentation

◆ SDL_Vulkan_CreateSurface()

SDL_bool SDL_Vulkan_CreateSurface ( SDL_Window window,
VkInstance  instance,
VkSurfaceKHR *  surface 
)
extern

Create a Vulkan rendering surface for a window.

The window must have been created with the SDL_WINDOW_VULKAN flag and instance must have been created with extensions returned by SDL_Vulkan_GetInstanceExtensions() enabled.

Parameters
windowThe window to which to attach the Vulkan surface
instanceThe Vulkan instance handle
surfaceA pointer to a VkSurfaceKHR handle to output the newly created surface
Returns
SDL_TRUE on success, SDL_FALSE on error.
Since
This function is available since SDL 3.0.0.
See also
SDL_Vulkan_GetInstanceExtensions

◆ SDL_Vulkan_GetInstanceExtensions()

SDL_bool SDL_Vulkan_GetInstanceExtensions ( unsigned int *  pCount,
const char **  pNames 
)
extern

Get the names of the Vulkan instance extensions needed to create a surface with SDL_Vulkan_CreateSurface.

This should be called after either calling SDL_Vulkan_LoadLibrary() or creating an SDL_Window with the SDL_WINDOW_VULKAN flag.

If pNames is NULL, then the number of required Vulkan instance extensions is returned in pCount. Otherwise, pCount must point to a variable set to the number of elements in the pNames array, and on return the variable is overwritten with the number of names actually written to pNames. If pCount is less than the number of required extensions, at most pCount structures will be written. If pCount is smaller than the number of required extensions, SDL_FALSE will be returned instead of SDL_TRUE, to indicate that not all the required extensions were returned.

Parameters
pCountA pointer to an unsigned int corresponding to the number of extensions to be returned
pNamesNULL or a pointer to an array to be filled with required Vulkan instance extensions
Returns
SDL_TRUE on success, SDL_FALSE on error.
Since
This function is available since SDL 3.0.0.
See also
SDL_Vulkan_CreateSurface

◆ SDL_Vulkan_GetVkGetInstanceProcAddr()

SDL_FunctionPointer SDL_Vulkan_GetVkGetInstanceProcAddr ( void  )
extern

Get the address of the vkGetInstanceProcAddr function.

This should be called after either calling SDL_Vulkan_LoadLibrary() or creating an SDL_Window with the SDL_WINDOW_VULKAN flag.

The actual type of the returned function pointer is PFN_vkGetInstanceProcAddr, but that isn't available because the Vulkan headers are not included here. You should cast the return value of this function to that type, e.g.

vkGetInstanceProcAddr = (PFN_vkGetInstanceProcAddr)SDL_Vulkan_GetVkGetInstanceProcAddr();

Returns
the function pointer for vkGetInstanceProcAddr or NULL on error.
Since
This function is available since SDL 3.0.0.

◆ SDL_Vulkan_LoadLibrary()

int SDL_Vulkan_LoadLibrary ( const char *  path)
extern

Dynamically load the Vulkan loader library.

This should be called after initializing the video driver, but before creating any Vulkan windows. If no Vulkan loader library is loaded, the default library will be loaded upon creation of the first Vulkan window.

It is fairly common for Vulkan applications to link with libvulkan instead of explicitly loading it at run time. This will work with SDL provided the application links to a dynamic library and both it and SDL use the same search path.

If you specify a non-NULL path, an application should retrieve all of the Vulkan functions it uses from the dynamic library using SDL_Vulkan_GetVkGetInstanceProcAddr unless you can guarantee path points to the same vulkan loader library the application linked to.

On Apple devices, if path is NULL, SDL will attempt to find the vkGetInstanceProcAddr address within all the Mach-O images of the current process. This is because it is fairly common for Vulkan applications to link with libvulkan (and historically MoltenVK was provided as a static library). If it is not found, on macOS, SDL will attempt to load vulkan.framework/vulkan, libvulkan.1.dylib, MoltenVK.framework/MoltenVK, and libMoltenVK.dylib, in that order. On iOS, SDL will attempt to load libMoltenVK.dylib. Applications using a dynamic framework or .dylib must ensure it is included in its application bundle.

On non-Apple devices, application linking with a static libvulkan is not supported. Either do not link to the Vulkan loader or link to a dynamic library version.

Parameters
pathThe platform dependent Vulkan loader library name or NULL
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_Vulkan_GetVkInstanceProcAddr
SDL_Vulkan_UnloadLibrary

◆ SDL_Vulkan_UnloadLibrary()

void SDL_Vulkan_UnloadLibrary ( void  )
extern

Unload the Vulkan library previously loaded by SDL_Vulkan_LoadLibrary()

Since
This function is available since SDL 3.0.0.
See also
SDL_Vulkan_LoadLibrary