Procházet zdrojové kódy

include: Tweaked some vsync-related documentation.

Reference PR #9903.
Ryan C. Gordon před 10 měsíci
rodič
revize
e508d82f74
2 změnil soubory, kde provedl 18 přidání a 18 odebrání
  1. 9 9
      include/SDL3/SDL_render.h
  2. 9 9
      include/SDL3/SDL_video.h

+ 9 - 9
include/SDL3/SDL_render.h

@@ -2144,15 +2144,15 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddVulkanRenderSemaphores(SDL_Renderer *rend
  *
  * When a renderer is created, vsync defaults to SDL_RENDERER_VSYNC_DISABLED.
  *
- * \param renderer The renderer to toggle
- * \param vsync the vertical refresh sync interval, 1 to synchronize present
- *              with every vertical refresh, 2 to synchronize present with
- *              every second vertical refresh, etc.,
- *              SDL_RENDERER_VSYNC_ADAPTIVE for late swap tearing (adaptive
- *              vsync), or SDL_RENDERER_VSYNC_DISABLED to disable. Not every
- *              value is supported by every renderer, so you should check the
- *              return value to see whether the requested setting is
- *              supported.
+ * The `vsync` parameter can be 1 to synchronize present with every vertical
+ * refresh, 2 to synchronize present with every second vertical refresh, etc.,
+ * SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing (adaptive vsync),
+ * or SDL_WINDOW_SURFACE_VSYNC_DISABLED to disable. Not every value is
+ * supported by every driver, so you should check the return value to see
+ * whether the requested setting is supported.
+ *
+ * \param renderer The renderer to toggle.
+ * \param vsync the vertical refresh sync interval.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *

+ 9 - 9
include/SDL3/SDL_video.h

@@ -1807,15 +1807,15 @@ extern SDL_DECLSPEC SDL_Surface *SDLCALL SDL_GetWindowSurface(SDL_Window *window
  * When a window surface is created, vsync defaults to
  * SDL_WINDOW_SURFACE_VSYNC_DISABLED.
  *
- * \param window the window
- * \param vsync the vertical refresh sync interval, 1 to synchronize present
- *              with every vertical refresh, 2 to synchronize present with
- *              every second vertical refresh, etc.,
- *              SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing
- *              (adaptive vsync), or SDL_WINDOW_SURFACE_VSYNC_DISABLED to
- *              disable. Not every value is supported by every driver, so you
- *              should check the return value to see whether the requested
- *              setting is supported.
+ * The `vsync` parameter can be 1 to synchronize present with every vertical
+ * refresh, 2 to synchronize present with every second vertical refresh, etc.,
+ * SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing (adaptive vsync),
+ * or SDL_WINDOW_SURFACE_VSYNC_DISABLED to disable. Not every value is
+ * supported by every driver, so you should check the return value to see
+ * whether the requested setting is supported.
+ *
+ * \param window the window.
+ * \param vsync the vertical refresh sync interval.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *