SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_Vulkan_CreateSurface

Create a Vulkan rendering surface for a window.

Header File

Defined in <SDL3/SDL_vulkan.h>

Syntax

int SDL_Vulkan_CreateSurface(SDL_Window *window,
                              VkInstance instance,
                              const struct VkAllocationCallbacks *allocator,
                              VkSurfaceKHR* surface);

Function Parameters

SDL_Window * window the window to which to attach the Vulkan surface.
VkInstance instance the Vulkan instance handle.
const struct VkAllocationCallbacks * allocator a VkAllocationCallbacks struct, which lets the app set the allocator that creates the surface. Can be NULL.
VkSurfaceKHR * surface a pointer to a VkSurfaceKHR handle to output the newly created surface.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

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.

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.

Version

This function is available since SDL 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryVulkan


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.