SDL 3.0
SDL_vulkan.h File Reference
+ 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)
 
char const *const * SDL_Vulkan_GetInstanceExtensions (Uint32 *count)
 
SDL_bool SDL_Vulkan_CreateSurface (SDL_Window *window, VkInstance instance, const struct VkAllocationCallbacks *allocator, 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 45 of file SDL_vulkan.h.

◆ VK_DEFINE_NON_DISPATCHABLE_HANDLE

#define VK_DEFINE_NON_DISPATCHABLE_HANDLE (   object)    typedef uint64_t object;

Definition at line 50 of file SDL_vulkan.h.

Typedef Documentation

◆ SDL_vulkanInstance

typedef VkInstance SDL_vulkanInstance

Definition at line 59 of file SDL_vulkan.h.

◆ SDL_vulkanSurface

typedef VkSurfaceKHR SDL_vulkanSurface

Definition at line 60 of file SDL_vulkan.h.

Function Documentation

◆ SDL_Vulkan_CreateSurface()

SDL_bool SDL_Vulkan_CreateSurface ( SDL_Window window,
VkInstance  instance,
const struct VkAllocationCallbacks *  allocator,
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.

If allocator is NULL, Vulkan will use the system default allocator. This argument is passed directly to Vulkan and isn't used by SDL itself.

Parameters
windowThe window to which to attach the Vulkan surface
instanceThe Vulkan instance handle
allocatorA VkAllocationCallbacks struct, which lets the app set the allocator that creates the surface. Can be NULL.
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()

char const *const * SDL_Vulkan_GetInstanceExtensions ( Uint32 count)
extern

Get the Vulkan instance extensions needed for vkCreateInstance.

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

On return, the variable pointed to by count will be set to the number of elements returned, suitable for using with VkInstanceCreateInfo::enabledExtensionCount, and the returned array can be used with VkInstanceCreateInfo::ppEnabledExtensionNames, for calling Vulkan's vkCreateInstance API.

You should not free the returned array; it is owned by SDL.

Parameters
counta pointer filled in with the number of extensions returned.
Returns
An array of extension name strings on success, NULL 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