gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add missing \returns, change "return" to "returns" to have same naming

Browse Source
This commit is contained in:
Sylvain
2023-02-10 22:26:35 +01:00
committed by Sylvain Becker
parent b728de788e
commit ce366facaa
16 changed files with 81 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
include/SDL3/SDL_surface.h
View File

@@ -351,7 +351,7 @@ extern DECLSPEC int SDLCALL SDL_SetSurfaceColorKey(SDL_Surface *surface,
* It is safe to pass a NULL `surface` here; it will return SDL_FALSE.
*
* \param surface the SDL_Surface structure to query
* \return SDL_TRUE if the surface has a color key, SDL_FALSE otherwise.
* \returns SDL_TRUE if the surface has a color key, SDL_FALSE otherwise.
*
* \since This function is available since SDL 3.0.0.
*
@@ -795,6 +795,9 @@ extern DECLSPEC int SDLCALL SDL_BlitSurfaceUnchecked
* Perform a fast, low quality, stretch blit between two surfaces of the same
* format.
*
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* Please use SDL_BlitScaled() instead.
*
* \since This function is available since SDL 3.0.0.
@@ -807,6 +810,9 @@ extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface *src,
/**
* Perform bilinear scaling between two surfaces of the same format, 32BPP.
*
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*/
extern DECLSPEC int SDLCALL SDL_SoftStretchLinear(SDL_Surface *src,
@@ -868,6 +874,8 @@ extern DECLSPEC void SDLCALL SDL_SetYUVConversionMode(SDL_YUV_CONVERSION_MODE mo
/**
* Get the YUV conversion mode
*
* \returns YUV conversion mode
*
* \since This function is available since SDL 3.0.0.
*/
extern DECLSPEC SDL_YUV_CONVERSION_MODE SDLCALL SDL_GetYUVConversionMode(void);
@@ -876,6 +884,8 @@ extern DECLSPEC SDL_YUV_CONVERSION_MODE SDLCALL SDL_GetYUVConversionMode(void);
* Get the YUV conversion mode, returning the correct mode for the resolution
* when the current conversion mode is SDL_YUV_CONVERSION_AUTOMATIC
*
* \returns YUV conversion mode
*
* \since This function is available since SDL 3.0.0.
*/
extern DECLSPEC SDL_YUV_CONVERSION_MODE SDLCALL SDL_GetYUVConversionModeForResolution(int width, int height);