SDL_Vulkan_DestroySurface(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

💖 SDL_Vulkan_DestroySurface 💖

okay bestie, this one lives in the SDL3 FUNCTIONS section of the manual, and it's about one very specific little chore: destroying the Vulkan rendering surface of a window. yes that's the whole vibe. let's get into it 🦋

✨ NAME ✨

SDL_Vulkan_DestroySurface — Destroy the Vulkan rendering surface of a window.

like. it destroys it. it's in the name. 💅

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_vulkan.h>

void SDL_Vulkan_DestroySurface(VkInstance instance,
                           VkSurfaceKHR surface,
                           const struct VkAllocationCallbacks *allocator);

look at her. three lil arguments. so tidy. so iconic. 👑

🎀 DESCRIPTION 🎀

okay so here's the tea, and this part actually matters, don't skip it:

This should be called before SDL_DestroyWindow, if SDL_Vulkan_CreateSurface was called after SDL_CreateWindow. order is literally everything here, bestie, don't do it backwards 😭

Also — and this is a requirement, not a suggestion — the instance must have been created with extensions returned by SDL_Vulkan_GetInstanceExtensions() enabled, and surface must have been created successfully by an SDL_Vulkan_CreateSurface() call. no shortcuts, no improvised instances, that's the rule fr fr 🫶

and about allocator: if it's NULL, Vulkan will use the system default allocator. this argument gets passed directly to Vulkan and isn't used by SDL itself at all — SDL is just the messenger, handing it over. 💌

🌈 FUNCTION PARAMETERS 🌈

  • instance — the Vulkan instance handle. the main character of this parameter list, honestly. ✨
  • surface — the vkSurfaceKHR handle to destroy. this is the thing getting yeeted. 💀
  • allocator — a VkAllocationCallbacks struct, which lets the app set the allocator that destroys the surface. Can be NULL. so like, optional bestie, no pressure. 🎀

⭐ AVAILABILITY ⭐

This function is available since SDL 3.2.0. so if you're on something older, no surface-destroying for you, sorry babe 🙈

👑 SEE ALSO 👑

iykyk — the create side and the extensions side. this destroy function is the third member of that little trio. 🌸

lowkey reminder: clean up your surfaces before you destroy the window, or the order police will come for you. no cap. 🚨

kisses, this page came to you from the Simple Directmedia Layer girlies, running SDL 3.4.18, and filed under SDL_Vulkan_DestroySurface(3) — mwah, go free your surfaces bestie 💜✨

📦 where this page comes from