SDL 2.0
SDL_vulkan.h File Reference
#include "SDL_video.h"
#include "begin_code.h"
#include "close_code.h"
+ Include dependency graph for SDL_vulkan.h:
+ This graph shows which files directly or indirectly include this file:

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
Note
SDL_Vulkan_GetInstanceExtensions & SDL_Vulkan_CreateSurface API is compatable with Tizen's implementation of Vulkan in SDL.
int SDL_Vulkan_LoadLibrary (const char *path)
 Dynamically load a Vulkan loader library. More...
 
voidSDL_Vulkan_GetVkGetInstanceProcAddr (void)
 Get the address of the vkGetInstanceProcAddr function. More...
 
void SDL_Vulkan_UnloadLibrary (void)
 Unload the Vulkan loader library previously loaded by SDL_Vulkan_LoadLibrary(). More...
 
SDL_bool SDL_Vulkan_GetInstanceExtensions (SDL_Window *window, unsigned int *pCount, const char **pNames)
 Get the names of the Vulkan instance extensions needed to create a surface with SDL_Vulkan_CreateSurface(). More...
 
SDL_bool SDL_Vulkan_CreateSurface (SDL_Window *window, VkInstance instance, VkSurfaceKHR *surface)
 Create a Vulkan rendering surface for a window. More...
 
void SDL_Vulkan_GetDrawableSize (SDL_Window *window, int *w, int *h)
 Get the size of a window's underlying drawable in pixels (for use with setting viewport, scissor & etc). More...
 

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 
)

Create a Vulkan rendering surface for a window.

Parameters
[in]windowSDL_Window to which to attach the rendering surface.
[in]instancehandle to the Vulkan instance to use.
[out]surfacepointer to a VkSurfaceKHR handle to receive the handle of the newly created surface.
Returns
SDL_TRUE on success, SDL_FALSE on error.
VkInstance instance;
// create instance and window
// create the Vulkan surface
VkSurfaceKHR surface;
handle_error();
#define SDL_Vulkan_CreateSurface
EGLSurface surface
Definition: eglext.h:248
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
The type used to identify a window.
Definition: SDL_sysvideo.h:74
Note
window should have been created with the SDL_WINDOW_VULKAN flag.
instance should have been created with the extensions returned by SDL_Vulkan_CreateSurface() enabled.
See also
SDL_Vulkan_GetInstanceExtensions()

Definition at line 4151 of file SDL_video.c.

4154{
4156
4157 if (!(window->flags & SDL_WINDOW_VULKAN)) {
4159 return SDL_FALSE;
4160 }
4161
4162 if (!instance) {
4163 SDL_InvalidParamError("instance");
4164 return SDL_FALSE;
4165 }
4166
4167 if (!surface) {
4168 SDL_InvalidParamError("surface");
4169 return SDL_FALSE;
4170 }
4171
4172 return _this->Vulkan_CreateSurface(_this, window, instance, surface);
4173}
#define SDL_SetError
#define SDL_InvalidParamError(param)
Definition: SDL_error.h:54
@ SDL_FALSE
Definition: SDL_stdinc.h:163
#define NOT_A_VULKAN_WINDOW
Definition: SDL_video.c:4074
static SDL_VideoDevice * _this
Definition: SDL_video.c:118
#define CHECK_WINDOW_MAGIC(window, retval)
Definition: SDL_video.c:120
@ SDL_WINDOW_VULKAN
Definition: SDL_video.h:122
SDL_bool(* Vulkan_CreateSurface)(_THIS, SDL_Window *window, VkInstance instance, VkSurfaceKHR *surface)
Definition: SDL_sysvideo.h:274

References _this, CHECK_WINDOW_MAGIC, NOT_A_VULKAN_WINDOW, SDL_FALSE, SDL_InvalidParamError, SDL_SetError, SDL_WINDOW_VULKAN, and SDL_VideoDevice::Vulkan_CreateSurface.

◆ SDL_Vulkan_GetDrawableSize()

void SDL_Vulkan_GetDrawableSize ( SDL_Window window,
int *  w,
int *  h 
)

Get the size of a window's underlying drawable in pixels (for use with setting viewport, scissor & etc).

Parameters
windowSDL_Window from which the drawable size should be queried
wPointer to variable for storing the width in pixels, may be NULL
hPointer to variable for storing the height in pixels, may be NULL

This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with high-DPI support (Apple calls this "Retina"), and not disabled by the SDL_HINT_VIDEO_HIGHDPI_DISABLED hint.

Note
On macOS high-DPI support must be enabled for an application by setting NSHighResolutionCapable to true in its Info.plist.
See also
SDL_GetWindowSize()
SDL_CreateWindow()

Definition at line 4175 of file SDL_video.c.

4176{
4178
4181 } else {
4183 }
4184}
GLfloat GLfloat GLfloat GLfloat h
GLubyte GLubyte GLubyte GLubyte w
void SDL_GetWindowSize(SDL_Window *window, int *w, int *h)
Get the size of a window's client area.
Definition: SDL_video.c:2034
void(* Vulkan_GetDrawableSize)(_THIS, SDL_Window *window, int *w, int *h)
Definition: SDL_sysvideo.h:275

References _this, CHECK_WINDOW_MAGIC, SDL_GetWindowSize(), and SDL_VideoDevice::Vulkan_GetDrawableSize.

◆ SDL_Vulkan_GetInstanceExtensions()

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

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

Parameters
[in]

c NULL or window Window for which the required Vulkan instance extensions should be retrieved

Parameters
[in,out]pCountpointer to an unsigned related to the number of required Vulkan instance extensions
[out]pNamesNULL or a pointer to an array to be filled with the required Vulkan instance extensions
Returns
SDL_TRUE on success, SDL_FALSE on error.

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.

Note
If window is not NULL, it will be checked against its creation flags to ensure that the Vulkan flag is present. This parameter will be removed in a future major release.
The returned list of extensions will contain VK_KHR_surface and zero or more platform specific extensions
The extension names queried here must be enabled when calling VkCreateInstance, otherwise surface creation will fail.
window should have been created with the SDL_WINDOW_VULKAN flag or be NULL
unsigned int count;
// get count of required extensions
handle_error();
static const char *const additionalExtensions[] =
{
VK_EXT_DEBUG_REPORT_EXTENSION_NAME, // example additional extension
};
size_t additionalExtensionsCount = sizeof(additionalExtensions) / sizeof(additionalExtensions[0]);
size_t extensionCount = count + additionalExtensionsCount;
const char **names = malloc(sizeof(const char *) * extensionCount);
if(!names)
handle_error();
// get names of required extensions
handle_error();
// copy additional extensions after required extensions
for(size_t i = 0; i < additionalExtensionsCount; i++)
names[i + count] = additionalExtensions[i];
VkInstanceCreateInfo instanceCreateInfo = {};
instanceCreateInfo.enabledExtensionCount = extensionCount;
instanceCreateInfo.ppEnabledExtensionNames = names;
// fill in rest of instanceCreateInfo
VkInstance instance;
// create the Vulkan instance
VkResult result = vkCreateInstance(&instanceCreateInfo, NULL, &instance);
#define SDL_Vulkan_GetInstanceExtensions
SDL_EventEntry * free
Definition: SDL_events.c:82
GLuint GLuint GLsizei count
Definition: SDL_opengl.h:1571
GLuint64EXT * result
GLuint GLuint * names
#define malloc
Definition: SDL_qsort.c:47
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
#define NULL
Definition: begin_code.h:167
const char *const * ppEnabledExtensionNames
Definition: vulkan_core.h:1752
uint32_t enabledExtensionCount
Definition: vulkan_core.h:1751
VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance(const VkInstanceCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkInstance *pInstance)
#define VK_EXT_DEBUG_REPORT_EXTENSION_NAME
Definition: vulkan_core.h:6145
VkResult
Definition: vulkan_core.h:120
See also
SDL_Vulkan_CreateSurface()

◆ SDL_Vulkan_GetVkGetInstanceProcAddr()

void * SDL_Vulkan_GetVkGetInstanceProcAddr ( void  )

Get the address of the vkGetInstanceProcAddr function.

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

Definition at line 4102 of file SDL_video.c.

4103{
4104 if (!_this) {
4106 return NULL;
4107 }
4109 SDL_SetError("No Vulkan loader has been loaded");
4110 return NULL;
4111 }
4113}
static int SDL_UninitializedVideo()
Definition: SDL_video.c:437
PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr
Definition: SDL_sysvideo.h:372
struct SDL_VideoDevice::@263 vulkan_config

References _this, SDL_VideoDevice::loader_loaded, NULL, SDL_SetError, SDL_UninitializedVideo(), SDL_VideoDevice::vkGetInstanceProcAddr, and SDL_VideoDevice::vulkan_config.

◆ SDL_Vulkan_LoadLibrary()

int SDL_Vulkan_LoadLibrary ( const char *  path)

Dynamically load a Vulkan loader library.

Parameters
[in]pathThe platform dependent Vulkan loader library name, or NULL.
Returns
0 on success, or -1 if the library couldn't be loaded.

If path is NULL SDL will use the value of the environment variable SDL_VULKAN_LIBRARY, if set, otherwise it loads the default 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.

Note
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 then, on macOS, SDL will attempt to load vulkan.framework/vulkan, libvulkan.1.dylib, followed by libvulkan.dylib, in that order. On iOS SDL will attempt to load libvulkan.dylib only. 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.
This function will fail if there are no working Vulkan drivers installed.
See also
SDL_Vulkan_GetVkGetInstanceProcAddr()
SDL_Vulkan_UnloadLibrary()

Definition at line 4076 of file SDL_video.c.

4077{
4078 int retval;
4079 if (!_this) {
4081 return -1;
4082 }
4085 return SDL_SetError("Vulkan loader library already loaded");
4086 }
4087 retval = 0;
4088 } else {
4089 if (!_this->Vulkan_LoadLibrary) {
4090 return SDL_SetError("Vulkan support is either not configured in SDL "
4091 "or not available in current SDL video driver "
4092 "(%s) or platform", _this->name);
4093 }
4095 }
4096 if (retval == 0) {
4098 }
4099 return retval;
4100}
#define SDL_strcmp
GLsizei const GLchar *const * path
const char * name
Definition: SDL_sysvideo.h:152
int(* Vulkan_LoadLibrary)(_THIS, const char *path)
Definition: SDL_sysvideo.h:271
char loader_path[256]
Definition: SDL_sysvideo.h:375
SDL_bool retval

References _this, SDL_VideoDevice::loader_loaded, SDL_VideoDevice::loader_path, SDL_VideoDevice::name, retval, SDL_SetError, SDL_strcmp, SDL_UninitializedVideo(), SDL_VideoDevice::vulkan_config, and SDL_VideoDevice::Vulkan_LoadLibrary.

Referenced by SDL_CreateWindow().

◆ SDL_Vulkan_UnloadLibrary()

void SDL_Vulkan_UnloadLibrary ( void  )