Browse Source

Sync SDL3 wiki -> header

SDL Wiki Bot 11 months ago
parent
commit
66fbbdf46a
1 changed files with 10 additions and 0 deletions
  1. 10 0
      include/SDL3/SDL_video.h

+ 10 - 0
include/SDL3/SDL_video.h

@@ -991,6 +991,16 @@ extern SDL_DECLSPEC SDL_Window *SDLCALL SDL_CreatePopupWindow(SDL_Window *parent
  * Windows with the "tooltip" and "menu" properties are popup windows and have
  * the behaviors and guidelines outlined in SDL_CreatePopupWindow().
  *
+ * If this window is being created to be used with an SDL_Renderer, you should
+ * not add a graphics API specific property
+ * (`SDL_PROP_WINDOW_CREATE_OPENGL_BOOLEAN`, etc), as SDL will handle that
+ * internally when it chooses a renderer. However, SDL might need to recreate
+ * your window at that point, which may cause the window to appear briefly,
+ * and then flicker as it is recreated. The correct approach to this is to
+ * create the window with the `SDL_PROP_WINDOW_CREATE_HIDDEN_BOOLEAN` property
+ * set to true, then create the renderer, then show the window with
+ * SDL_ShowWindow().
+ *
  * \param props the properties to use
  * \returns the window that was created or NULL on failure; call
  *          SDL_GetError() for more information.