Function sdl2_sys::SDL_Vulkan_GetInstanceExtensions

pub unsafe extern "C" fn SDL_Vulkan_GetInstanceExtensions(
    window: *mut SDL_Window,
    pCount: *mut c_uint,
    pNames: *mut *const c_char
) -> SDL_bool

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

\param [in] window Window for which the required Vulkan instance extensions should be retrieved \param [in,out] count pointer to an \c unsigned related to the number of required Vulkan instance extensions \param [out] names \c NULL or a pointer to an array to be filled with the required Vulkan instance extensions

\return \c SDL_TRUE on success, \c SDL_FALSE on error.

If \a pNames is \c NULL, then the number of required Vulkan instance extensions is returned in pCount. Otherwise, \a pCount must point to a variable set to the number of elements in the \a pNames array, and on return the variable is overwritten with the number of names actually written to \a pNames. If \a pCount is less than the number of required extensions, at most \a pCount structures will be written. If \a pCount is smaller than the number of required extensions, \c SDL_FALSE will be returned instead of \c SDL_TRUE, to indicate that not all the required extensions were returned.

\note The returned list of extensions will contain \c VK_KHR_surface and zero or more platform specific extensions

\note The extension names queried here must be enabled when calling VkCreateInstance, otherwise surface creation will fail.

\note \c window should have been created with the \c SDL_WINDOW_VULKAN flag.

\code unsigned int count; // get count of required extensions if(!SDL_Vulkan_GetInstanceExtensions(window, &count, NULL)) 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 if(!SDL_Vulkan_GetInstanceExtensions(window, &count, names)) 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); free(names); \endcode

\sa SDL_Vulkan_CreateSurface()