From 7f70f6e1e295da04f153a107a9e95f8523b807e4 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Thu, 18 Nov 2021 15:30:36 -0500
Subject: [PATCH] include: Note that several rwops functions used to be macros
before 2.0.10.
---
include/SDL_rwops.h | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/include/SDL_rwops.h b/include/SDL_rwops.h
index b29c32bb6a..5d6a9db194 100644
--- a/include/SDL_rwops.h
+++ b/include/SDL_rwops.h
@@ -387,6 +387,8 @@ extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops * area);
/**
* Use this macro to get the size of the data stream in an SDL_RWops.
*
+ * Prior to SDL 2.0.10, this function was a macro.
+ *
* \param context the SDL_RWops to get the size of the data stream from
* \returns the size of the data stream in the SDL_RWops on success, -1 if
* unknown or a negative error code on failure; call SDL_GetError()
@@ -412,6 +414,8 @@ extern DECLSPEC Sint64 SDLCALL SDL_RWsize(SDL_RWops *context);
* SDL_RWseek() is actually a wrapper function that calls the SDL_RWops's
* `seek` method appropriately, to simplify application development.
*
+ * Prior to SDL 2.0.10, this function was a macro.
+ *
* \param context a pointer to an SDL_RWops structure
* \param offset an offset in bytes, relative to **whence** location; can be
* negative
@@ -439,6 +443,8 @@ extern DECLSPEC Sint64 SDLCALL SDL_RWseek(SDL_RWops *context,
* method, with an offset of 0 bytes from `RW_SEEK_CUR`, to simplify
* application development.
*
+ * Prior to SDL 2.0.10, this function was a macro.
+ *
* \param context a SDL_RWops data stream object from which to get the current
* offset
* \returns the current offset in the stream, or -1 if the information can not
@@ -468,6 +474,8 @@ extern DECLSPEC Sint64 SDLCALL SDL_RWtell(SDL_RWops *context);
* SDL_RWread() is actually a function wrapper that calls the SDL_RWops's
* `read` method appropriately, to simplify application development.
*
+ * Prior to SDL 2.0.10, this function was a macro.
+ *
* \param context a pointer to an SDL_RWops structure
* \param ptr a pointer to a buffer to read data into
* \param size the size of each object to read, in bytes
@@ -500,6 +508,8 @@ extern DECLSPEC size_t SDLCALL SDL_RWread(SDL_RWops *context,
* SDL_RWwrite is actually a function wrapper that calls the SDL_RWops's
* `write` method appropriately, to simplify application development.
*
+ * Prior to SDL 2.0.10, this function was a macro.
+ *
* \param context a pointer to an SDL_RWops structure
* \param ptr a pointer to a buffer containing data to write
* \param size the size of an object to write, in bytes
@@ -535,6 +545,8 @@ extern DECLSPEC size_t SDLCALL SDL_RWwrite(SDL_RWops *context,
* SDL_RWclose() is actually a macro that calls the SDL_RWops's `close` method
* appropriately, to simplify application development.
*
+ * Prior to SDL 2.0.10, this function was a macro.
+ *
* \param context SDL_RWops structure to close
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
@@ -580,6 +592,9 @@ extern DECLSPEC void *SDLCALL SDL_LoadFile_RW(SDL_RWops *src,
*
* The data should be freed with SDL_free().
*
+ * Prior to SDL 2.0.10, this function was a macro wrapping around
+ * SDL_LoadFile_RW.
+ *
* \param file the path to read all available data from
* \param datasize if not NULL, will store the number of bytes read
* \returns the data, or NULL if there was an error.