(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_Vulkan_CreateSurface

Create a Vulkan rendering surface for a window.

Header File

Syntax

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

Function Parameters

SDL_Window *	window	The window to which to attach the Vulkan surface.
VkInstance	instance	The Vulkan instance handle.
VkSurfaceKHR *	surface	A pointer to a VkSurfaceKHR handle to output the newly created surface.

Return Value

(SDL_bool) Returns SDL_TRUE on success, SDL_FALSE on error.

Remarks

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.

Version

This function is available since SDL 2.0.6.