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

Sync SDL2 wiki -> header

Browse Source 
[ci skip]
This commit is contained in:
SDL Wiki Bot
2024-10-19 18:04:39 +00:00
parent 86fd4ed83c
commit 4ca7a19348
1 changed files with 5 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
include/SDL_surface.h
View File

@@ -806,59 +806,17 @@ extern DECLSPEC int SDLCALL SDL_FillRects
/** /**
* Performs a fast blit from the source surface to the destination surface. * Performs a fast blit from the source surface to the destination surface.
* *
* This assumes that the source and destination rectangles are the same size. * This is defined as a macro to SDL_UpperBlit to be less confusing.This
* If either `srcrect` or `dstrect` are NULL, the entire surface (`src` or * assumes that the source and destination rectangles are the same size. If
* `dst`) is copied. The final blit rectangles are saved in `srcrect` and * either `srcrect` or `dstrect` are NULL, the entire surface (`src` or `dst`)
* `dstrect` after all clipping is performed. * is copied. The final blit rectangles are saved in `srcrect` and `dstrect`
* after all clipping is performed.
* *
* The blit function should not be called on a locked surface. * The blit function should not be called on a locked surface.
* *
* The blit semantics for surfaces with and without blending and colorkey are * The blit semantics for surfaces with and without blending and colorkey are
* defined as follows: * defined as follows:
* *
* ```
* RGBA->RGB:
* Source surface blend mode set to SDL_BLENDMODE_BLEND:
* alpha-blend (using the source alpha-channel and per-surface alpha)
* SDL_SRCCOLORKEY ignored.
* Source surface blend mode set to SDL_BLENDMODE_NONE:
* copy RGB.
* if SDL_SRCCOLORKEY set, only copy the pixels matching the
* RGB values of the source color key, ignoring alpha in the
* comparison.
*
* RGB->RGBA:
* Source surface blend mode set to SDL_BLENDMODE_BLEND:
* alpha-blend (using the source per-surface alpha)
* Source surface blend mode set to SDL_BLENDMODE_NONE:
* copy RGB, set destination alpha to source per-surface alpha value.
* both:
* if SDL_SRCCOLORKEY set, only copy the pixels matching the
* source color key.
*
* RGBA->RGBA:
* Source surface blend mode set to SDL_BLENDMODE_BLEND:
* alpha-blend (using the source alpha-channel and per-surface alpha)
* SDL_SRCCOLORKEY ignored.
* Source surface blend mode set to SDL_BLENDMODE_NONE:
* copy all of RGBA to the destination.
* if SDL_SRCCOLORKEY set, only copy the pixels matching the
* RGB values of the source color key, ignoring alpha in the
* comparison.
*
* RGB->RGB:
* Source surface blend mode set to SDL_BLENDMODE_BLEND:
* alpha-blend (using the source per-surface alpha)
* Source surface blend mode set to SDL_BLENDMODE_NONE:
* copy RGB.
* both:
* if SDL_SRCCOLORKEY set, only copy the pixels matching the
* source color key.
* ```
*
* You should call SDL_BlitSurface() unless you know exactly how SDL blitting
* works internally and how to use the other blit functions.
*
* \returns 0 if the blit is successful, otherwise it returns -1. * \returns 0 if the blit is successful, otherwise it returns -1.
*/ */
#define SDL_BlitSurface SDL_UpperBlit #define SDL_BlitSurface SDL_UpperBlit