Sync wiki -> headers.

This commit is contained in:
Ryan C. Gordon 2023-02-24 11:47:13 -05:00
parent 858ae9900e
commit 7abb748134
No known key found for this signature in database
GPG key ID: FA148B892AB48044
3 changed files with 13 additions and 13 deletions

View file

@ -389,8 +389,8 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
/** /**
* Get the default cursor. * Get the default cursor.
* *
* You do not have to call SDL_FreeCursor() on the return value, * You do not have to call SDL_FreeCursor() on the return value, but it is
* but it is safe to do so. * safe to do so.
* *
* \returns the default cursor on success or NULL on failure. * \returns the default cursor on success or NULL on failure.
* *

View file

@ -64,12 +64,12 @@ typedef enum
* It's possible a platform can only report battery percentage or time left * It's possible a platform can only report battery percentage or time left
* but not both. * but not both.
* *
* \param seconds seconds of battery life left, you can pass a NULL here if you * \param seconds seconds of battery life left, you can pass a NULL here if
* don't care, will return -1 if we can't determine a value, or * you don't care, will return -1 if we can't determine a
* we're not running on a battery * value, or we're not running on a battery
* \param percent percentage of battery life left, between 0 and 100, you can pass * \param percent percentage of battery life left, between 0 and 100, you can
* a NULL here if you don't care, will return -1 if we can't * pass a NULL here if you don't care, will return -1 if we
* determine a value, or we're not running on a battery * can't determine a value, or we're not running on a battery
* \returns an SDL_PowerState enum representing the current battery state. * \returns an SDL_PowerState enum representing the current battery state.
* *
* \since This function is available since SDL 2.0.0. * \since This function is available since SDL 2.0.0.

View file

@ -1731,12 +1731,12 @@ extern DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer * renderer,
* *
* \param renderer the rendering context * \param renderer the rendering context
* *
* \since This function is available since SDL 2.0.0. * \threadsafety You may only call this function on the main thread. If this
* happens to work on a background thread on any given platform
* or backend, it's purely by luck and you should not rely on it
* to work next time.
* *
* \threadsafety You may only call this function on the main thread. If * \since This function is available since SDL 2.0.0.
* this happens to work on a background thread on any given
* platform or backend, it's purely by luck and you should
* not rely on it to work next time.
* *
* \sa SDL_RenderClear * \sa SDL_RenderClear
* \sa SDL_RenderDrawLine * \sa SDL_RenderDrawLine