SDL_FlashWindow(3)

πŸ’– SDL_FlashWindow(3) πŸ’–

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, where today's main character is SDL_FlashWindow ✨


🌸 NAME 🌸

SDL_FlashWindow β€” it's literally how you ask a window to demand attention from the user. like, "hey babe, look over here" energy, but for your app 🫢


πŸŽ€ SYNOPSIS πŸŽ€

#include <SDL3/SDL_video.h>

bool SDL_FlashWindow(SDL_Window *window, SDL_FlashOperation operation);

πŸ’… FUNCTION PARAMETERS πŸ’…

  • window β€” the window that's gonna get flashed, bestie. that's the one doing the attention-grabbing.
  • operation β€” the operation you wanna perform. the vibe of the flash, if you will.

⭐ RETURN VALUE ⭐

Returns true on success or false on failure 😭 and if it flops, pls call SDL_GetError() for more information, she'll tell you what went wrong.


πŸ”₯ THREAD SAFETY πŸ”₯

This function should only be called on the main thread. no cap. don't try to sneak it in from a side thread, it's giving main character energy only πŸ‘‘


πŸ¦‹ AVAILABILITY πŸ¦‹

This function is available since SDL 3.2.0. so if you're on anything older... yeah, no. upgrade time 🌈


✨ reminder: every option, param and return value above is canon, i didn't make any of it up. go flash responsibly πŸ’–

and that's the whole page, bestie!! πŸŽ€ source is Simple Directmedia Layer, running SDL 3.4.18, dated SDL_FlashWindow(3) β€” mwah, periodt πŸ’…πŸ’œ

πŸ“¦ where this page comes from