mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-10-03 00:18:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot
2024-07-18 01:04:46 +00:00
parent 38a301a3f9
commit e949f12f63
1 changed files with 18 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
include/SDL3/SDL_surface.h
View File

@@ -806,7 +806,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_ConvertPixelsAndColorspace(int width, int he
* \param dst_format an SDL_PixelFormat value of the `dst` pixels format. * \param dst_format an SDL_PixelFormat value of the `dst` pixels format.
* \param dst a pointer to be filled in with premultiplied pixel data. * \param dst a pointer to be filled in with premultiplied pixel data.
* \param dst_pitch the pitch of the destination pixels, in bytes. * \param dst_pitch the pitch of the destination pixels, in bytes.
* \param linear SDL_TRUE to convert from sRGB to linear space for the alpha multiplication, SDL_FALSE to do multiplication in sRGB space. * \param linear SDL_TRUE to convert from sRGB to linear space for the alpha
* multiplication, SDL_FALSE to do multiplication in sRGB space.
* \returns 0 on success or a negative error code on failure; call * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
@@ -820,7 +821,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_PremultiplyAlpha(int width, int height, SDL_
* This is safe to use with src == dst, but not for other overlapping areas. * This is safe to use with src == dst, but not for other overlapping areas.
* *
* \param surface the surface to modify. * \param surface the surface to modify.
* \param linear SDL_TRUE to convert from sRGB to linear space for the alpha multiplication, SDL_FALSE to do multiplication in sRGB space. * \param linear SDL_TRUE to convert from sRGB to linear space for the alpha
* multiplication, SDL_FALSE to do multiplication in sRGB space.
* \returns 0 on success or a negative error code on failure; call * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
@@ -833,13 +835,14 @@ extern SDL_DECLSPEC int SDLCALL SDL_PremultiplySurfaceAlpha(SDL_Surface *surface
* *
* This function handles all surface formats, and ignores any clip rectangle. * This function handles all surface formats, and ignores any clip rectangle.
* *
* If the surface is YUV, the color is assumed to be in the sRGB colorspace, otherwise the color is assumed to be in the colorspace of the suface. * If the surface is YUV, the color is assumed to be in the sRGB colorspace,
* otherwise the color is assumed to be in the colorspace of the suface.
* *
* \param surface the SDL_Surface to clear. * \param surface the SDL_Surface to clear.
* \param r the red component of the pixel, normally in the range 0-1 * \param r the red component of the pixel, normally in the range 0-1.
* \param g the green component of the pixel, normally in the range 0-1 * \param g the green component of the pixel, normally in the range 0-1.
* \param b the blue component of the pixel, normally in the range 0-1 * \param b the blue component of the pixel, normally in the range 0-1.
* \param a the alpha component of the pixel, normally in the range 0-1 * \param a the alpha component of the pixel, normally in the range 0-1.
* \returns 0 on success or a negative error code on failure; call * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
@@ -1166,14 +1169,14 @@ extern SDL_DECLSPEC int SDLCALL SDL_ReadSurfacePixel(SDL_Surface *surface, int x
* \param surface the surface to read. * \param surface the surface to read.
* \param x the horizontal coordinate, 0 <= x < width. * \param x the horizontal coordinate, 0 <= x < width.
* \param y the vertical coordinate, 0 <= y < height. * \param y the vertical coordinate, 0 <= y < height.
* \param r a pointer filled in with the red channel, normally in the range 0-1, or NULL to ignore * \param r a pointer filled in with the red channel, normally in the range
* this channel. * 0-1, or NULL to ignore this channel.
* \param g a pointer filled in with the green channel, normally in the range 0-1, or NULL to * \param g a pointer filled in with the green channel, normally in the range
* ignore this channel. * 0-1, or NULL to ignore this channel.
* \param b a pointer filled in with the blue channel, normally in the range 0-1, or NULL to * \param b a pointer filled in with the blue channel, normally in the range
* ignore this channel. * 0-1, or NULL to ignore this channel.
* \param a a pointer filled in with the alpha channel, normally in the range 0-1, or NULL to * \param a a pointer filled in with the alpha channel, normally in the range
* ignore this channel. * 0-1, or NULL to ignore this channel.
* \returns 0 on success or a negative error code on failure; call * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *