eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-06-01 09:27:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

include: A ton of little documentation tweaks, fixes, and improvements.

Browse source 
This is just stuff I noticed while working on the wikiheaders updates. A
thorough pass over all the docs would not be terrible, and maybe a simple
script to check for consistency (does everything have a `\since` on it? etc)
might be nice, too.
This commit is contained in:
Ryan C. Gordon 2024-04-08 22:36:57 -04:00
parent 645073961d
commit ad090d2444
No known key found for this signature in database
GPG key ID: FA148B892AB48044
45 changed files with 1565 additions and 833 deletions
Download patch file Download diff file Expand all files Collapse all files

27
include/SDL3/SDL_blendmode.h
View file

@ -35,9 +35,15 @@ extern "C" {
#endif
/**
* The blend mode used in SDL_RenderTexture() and drawing operations.
* An enumeration of blend modes used in drawing operations.
*
* Note that additional values may be obtained from SDL_ComposeCustomBlendMode.
*
* \sa SDL_ComposeCustomBlendMode
*
* \since This enum is available since SDL 3.0.0.
*/
typedef enum
typedef enum SDL_BlendMode
{
SDL_BLENDMODE_NONE = 0x00000000, /**< no blending
dstRGBA = srcRGBA */
@ -60,9 +66,11 @@ typedef enum
} SDL_BlendMode;
/**
* The blend operation used when combining source and destination pixel components
* The blend operation used when combining source and destination pixel components.
*
* \since This enum is available since SDL 3.0.0.
*/
typedef enum
typedef enum SDL_BlendOperation
{
SDL_BLENDOPERATION_ADD = 0x1, /**< dst + src: supported by all renderers */
SDL_BLENDOPERATION_SUBTRACT = 0x2, /**< src - dst : supported by D3D9, D3D11, OpenGL, OpenGLES */
@ -72,9 +80,16 @@ typedef enum
} SDL_BlendOperation;
/**
* The normalized factor used to multiply pixel components
* The normalized factor used to multiply pixel components.
*
* The blend factors are multiplied with the pixels from a drawing
* operation (src) and the pixels from the render target (dst) before
* the blend operation. The comma-separated factors listed above are always
* applied in the component order red, green, blue, and alpha.
*
* \since This enum is available since SDL 3.0.0.
*/
typedef enum
typedef enum SDL_BlendFactor
{
SDL_BLENDFACTOR_ZERO = 0x1, /**< 0, 0, 0, 0 */
SDL_BLENDFACTOR_ONE = 0x2, /**< 1, 1, 1, 1 */