Explorar o código

Sync SDL3 wiki -> header

[ci skip]
SDL Wiki Bot hai 1 semana
pai
achega
03fcc037d9
Modificáronse 1 ficheiros con 6 adicións e 1 borrados
  1. 6 1
      include/SDL3/SDL_main.h

+ 6 - 1
include/SDL3/SDL_main.h

@@ -664,7 +664,10 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnregisterApp(void);
 /**
 /**
  * Callback from the application to let the suspend continue.
  * Callback from the application to let the suspend continue.
  *
  *
- * When using SDL_Render or SDL_GPU, this function should be called _after_
+ * This should be called from an event watch in response to an
+ * `SDL_EVENT_DID_ENTER_BACKGROUND` event.
+ *
+ * When using SDL_Render or SDL_GPU, your event watch should be added _after_
  * creating the `SDL_Renderer` or `SDL_GPUDevice`; this allows the timing of
  * creating the `SDL_Renderer` or `SDL_GPUDevice`; this allows the timing of
  * the D3D12 command queue suspension to execute in the correct order.
  * the D3D12 command queue suspension to execute in the correct order.
  *
  *
@@ -677,6 +680,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnregisterApp(void);
  * \threadsafety This function is not thread safe.
  * \threadsafety This function is not thread safe.
  *
  *
  * \since This function is available since SDL 3.2.0.
  * \since This function is available since SDL 3.2.0.
+ *
+ * \sa SDL_AddEventWatch
  */
  */
 extern SDL_DECLSPEC void SDLCALL SDL_GDKSuspendComplete(void);
 extern SDL_DECLSPEC void SDLCALL SDL_GDKSuspendComplete(void);