.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_Vulkan_CreateSurface:
.\"   https://wiki.libsdl.org/SDL_Vulkan_CreateSurface
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_Vulkan_CreateSurface
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_Vulkan_CreateSurface 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_Vulkan_CreateSurface \- Create a Vulkan rendering surface for a window\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "SDL_bool SDL_Vulkan_CreateSurface(SDL_Window *window,
.BI "                                  VkInstance instance,
.BI "                                  const struct VkAllocationCallbacks *allocator,
.BI "                                  VkSurfaceKHR* surface);
.fi
.SH DESCRIPTION
The
.BR window
must have been created with the

.BR
.BR SDL_WINDOW_VULKAN
flag and
.BR instance
must have been
created with extensions returned by

.BR SDL_Vulkan_GetInstanceExtensions
()
enabled\[char46]

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

.SH FUNCTION PARAMETERS
.TP
.I window
The window to which to attach the Vulkan surface
.TP
.I instance
The Vulkan instance handle
.TP
.I allocator
A VkAllocationCallbacks struct, which lets the app set the allocator that creates the surface\[char46] Can be NULL\[char46]
.TP
.I surface
A pointer to a VkSurfaceKHR handle to output the newly created surface
.SH RETURN VALUE
Returns 
.BR SDL_TRUE
 on success, 
.BR SDL_FALSE
 on error\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_Vulkan_GetInstanceExtensions (3)