SDL_Vulkan_CreateSurface - Man Page
Create a Vulkan rendering surface for a window.
Header File
Defined in SDL3/SDL_vulkan.h
Synopsis
#include "SDL3/SDL.h" bool SDL_Vulkan_CreateSurface(SDL_Window *window, VkInstance instance, const struct VkAllocationCallbacks *allocator, VkSurfaceKHR* surface);
Description
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.
Function Parameters
- window
the window to which to attach the Vulkan surface.
- instance
the Vulkan instance handle.
- allocator
a VkAllocationCallbacks struct, which lets the app set the allocator that creates the surface. Can be NULL.
- surface
a pointer to a VkSurfaceKHR handle to output the newly created surface.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
Availability
This function is available since SDL 3.2.0.
See Also
·(3), SDL_Vulkan_GetInstanceExtensions(3), ·(3), SDL_Vulkan_DestroySurface(3)
Referenced By
SDL_Vulkan_DestroySurface(3), SDL_Vulkan_GetInstanceExtensions(3).