video: Document that renderer lifetimes are tied to their associated windows

main
Frank Praznik 2024-03-27 12:45:51 -04:00 committed by Sam Lantinga
parent 02c63667c7
commit 5abcfad352
2 changed files with 5 additions and 1 deletions

View File

@ -2020,6 +2020,10 @@ extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture *texture);
* If `renderer` is NULL, this function will return immediately after setting
* the SDL error message to "Invalid renderer". See SDL_GetError().
*
* Note that destroying a window implicitly destroys the associated renderer,
* so this should not be called if the window associated with the renderer has
* already been destroyed.
*
* \param renderer the rendering context
*
* \since This function is available since SDL 3.0.0.

View File

@ -2110,7 +2110,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window, SDL_Surface *
extern DECLSPEC int SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOperation operation);
/**
* Destroy a window.
* Destroy a window. If the window has an associated SDL_Renderer, it will be implicitly destroyed as well.
*
* If `window` is NULL, this function will return immediately after setting
* the SDL error message to "Invalid window". See SDL_GetError().