Clarify the lifetime of the shape surface in SDL_SetWindowShape()

main
Sam Lantinga 2024-02-10 07:08:28 -08:00
parent 69f2bd151e
commit 416803b03b
1 changed files with 2 additions and 0 deletions

View File

@ -2131,6 +2131,8 @@ extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest
* something besides the SDL render API, then you are responsible for setting
* the alpha channel of the window yourself.
*
* 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.
*
* The window must have been created with the SDL_WINDOW_TRANSPARENT flag.
*
* \param window the window