From cb4491ca603def5f66709569dda7c361f50c6fcc Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Wed, 10 Nov 2021 16:05:03 -0500
Subject: [PATCH] Sync wiki -> header
---
include/SDL_hidapi.h | 4 ++++
include/SDL_render.h | 15 +++++----------
include/SDL_system.h | 2 ++
include/SDL_timer.h | 2 ++
include/SDL_video.h | 7 +++++--
5 files changed, 18 insertions(+), 12 deletions(-)
diff --git a/include/SDL_hidapi.h b/include/SDL_hidapi.h
index e72e464d72..555211198c 100644
--- a/include/SDL_hidapi.h
+++ b/include/SDL_hidapi.h
@@ -167,6 +167,8 @@ extern DECLSPEC SDL_hid_device_info * SDLCALL SDL_hid_enumerate(unsigned short v
*
* \param devs Pointer to a list of struct_device returned from
* SDL_hid_enumerate().
+ *
+ * \since This function is available since SDL 2.0.18.
*/
extern DECLSPEC void SDLCALL SDL_hid_free_enumeration(SDL_hid_device_info *devs);
@@ -338,6 +340,8 @@ extern DECLSPEC int SDLCALL SDL_hid_get_feature_report(SDL_hid_device *dev, unsi
* Close a HID device.
*
* \param dev A device handle returned from SDL_hid_open().
+ *
+ * \since This function is available since SDL 2.0.18.
*/
extern DECLSPEC void SDLCALL SDL_hid_close(SDL_hid_device *dev);
diff --git a/include/SDL_render.h b/include/SDL_render.h
index 26e906f418..eed480b522 100644
--- a/include/SDL_render.h
+++ b/include/SDL_render.h
@@ -530,8 +530,7 @@ extern DECLSPEC int SDLCALL SDL_GetTextureScaleMode(SDL_Texture * texture,
* \param userdata the pointer to associate with the texture.
* \returns 0 on success, or -1 if the texture is not valid.
*
- * \since This function is available since SDL git HEAD (in development, not
- * in an official release yet).
+ * \since This function is available since SDL 2.0.18.
*
* \sa SDL_GetTextureUserData
*/
@@ -545,8 +544,7 @@ extern DECLSPEC int SDLCALL SDL_SetTextureUserData(SDL_Texture * texture,
* \return the pointer associated with the texture, or NULL if the texture is
* not valid.
*
- * \since This function is available since SDL git HEAD (in development, not
- * in an official release yet).
+ * \since This function is available since SDL 2.0.18.
*
* \sa SDL_SetTextureUserData
*/
@@ -1614,8 +1612,7 @@ extern DECLSPEC int SDLCALL SDL_RenderCopyExF(SDL_Renderer * renderer,
* \param num_indices Number of indices.
* \return 0 on success, or -1 if the operation is not supported
*
- * \since This function is available since SDL git HEAD (in development, not
- * in an official release yet).
+ * \since This function is available since SDL 2.0.18.
*
* \sa SDL_Vertex
*/
@@ -1643,8 +1640,7 @@ extern DECLSPEC int SDLCALL SDL_RenderGeometry(SDL_Renderer *renderer,
* \param size_indices Index size: 1 (byte), 2 (short), 4 (int)
* \return 0 on success, or -1 if the operation is not supported
*
- * \since This function is available since SDL git HEAD (in development, not
- * in an official release yet).
+ * \since This function is available since SDL 2.0.18.
*/
extern DECLSPEC int SDLCALL SDL_RenderGeometryRaw(SDL_Renderer *renderer,
SDL_Texture *texture,
@@ -1875,8 +1871,7 @@ extern DECLSPEC void *SDLCALL SDL_RenderGetMetalCommandEncoder(SDL_Renderer * re
* \param vsync 1 for on, 0 for off. All other values are reserved
* \returns a 0 int on success, or non-zero on failure
*
- * \since This function is available since SDL git HEAD (in development, not
- * in an official release yet).
+ * \since This function is available since SDL 2.0.18.
*/
extern DECLSPEC int SDLCALL SDL_RenderSetVSync(SDL_Renderer* renderer, int vsync);
diff --git a/include/SDL_system.h b/include/SDL_system.h
index e22a23c0c6..937e622f98 100644
--- a/include/SDL_system.h
+++ b/include/SDL_system.h
@@ -151,6 +151,8 @@ extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriority(Sint64 threadID, int prio
* \param schedPolicy The new scheduling policy (SCHED_FIFO, SCHED_RR,
* SCHED_OTHER, etc...)
* \returns 0 on success, or -1 on error.
+ *
+ * \since This function is available since SDL 2.0.18.
*/
extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriorityAndPolicy(Sint64 threadID, int sdlPriority, int schedPolicy);
diff --git a/include/SDL_timer.h b/include/SDL_timer.h
index 389f640c21..1315b5f9aa 100644
--- a/include/SDL_timer.h
+++ b/include/SDL_timer.h
@@ -76,6 +76,8 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetTicks(void);
*
* \returns an unsigned 64-bit value representing the number of milliseconds
* since the SDL library initialized.
+ *
+ * \since This function is available since SDL 2.0.18.
*/
extern DECLSPEC Uint64 SDLCALL SDL_GetTicks64(void);
diff --git a/include/SDL_video.h b/include/SDL_video.h
index 8af719aa1f..260cd8dfbb 100644
--- a/include/SDL_video.h
+++ b/include/SDL_video.h
@@ -651,8 +651,7 @@ extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,
* \returns the raw ICC profile data on success or NULL on failure; call
* SDL_GetError() for more information.
*
- * \since This function is available since SDL git HEAD (in development, not
- * in an official release yet).
+ * \since This function is available since SDL 2.0.18.
*/
extern DECLSPEC void* SDLCALL SDL_GetWindowICCProfile(SDL_Window * window, size_t* size);
@@ -1393,6 +1392,8 @@ extern DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void);
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
+ * \since This function is available since SDL 2.0.18.
+ *
* \sa SDL_GetWindowMouseRect
* \sa SDL_SetWindowGrab
*/
@@ -1405,6 +1406,8 @@ extern DECLSPEC int SDLCALL SDL_SetWindowMouseRect(SDL_Window * window, const SD
* \returns A pointer to the mouse confinement rectangle of a window, or NULL
* if there isn't one.
*
+ * \since This function is available since SDL 2.0.18.
+ *
* \sa SDL_SetWindowMouseRect
*/
extern DECLSPEC const SDL_Rect * SDLCALL SDL_GetWindowMouseRect(SDL_Window * window);