From 0b6ad8bf623fc4921da394c7ab248986c124fc09 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Mon, 14 Oct 2024 09:02:04 -0700 Subject: [PATCH] Improved the documentation for SDL_SetWindowShape() Fixes https://github.com/libsdl-org/SDL/issues/11199 --- include/SDL3/SDL_video.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/include/SDL3/SDL_video.h b/include/SDL3/SDL_video.h index d443b61cfc..8afaab3472 100644 --- a/include/SDL3/SDL_video.h +++ b/include/SDL3/SDL_video.h @@ -2459,12 +2459,12 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_Hi * * This sets the alpha channel of a transparent window and any fully * transparent areas are also transparent to mouse clicks. If you are using - * something besides the SDL render API, then you are responsible for setting - * the alpha channel of the window yourself. + * something besides the SDL render API, then you are responsible for drawing + * the alpha channel of the window to match the shape alpha channel to get consistent cross-platform results. * * The shape is copied inside this function, so you can free it afterwards. If * your shape surface changes, you should call SDL_SetWindowShape() again to - * update the window. + * update the window. This is an expensive operation, so should be done sparingly. * * The window must have been created with the SDL_WINDOW_TRANSPARENT flag. *