Clarify how the draw blend mode is used in the 2D renderer

Fixes https://github.com/libsdl-org/SDL/issues/16109
This commit is contained in:
Sam Lantinga
2026-08-06 08:47:50 -07:00
parent ad19bafd12
commit 81afb82f2d

View File

@@ -1277,6 +1277,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureAlphaModFloat(SDL_Texture *textur
/**
* Set the blend mode for a texture, used by SDL_RenderTexture().
*
* This blend mode is used for any drawing that involves this texture.
*
* If the blend mode is not supported, the closest supported mode is chosen
* and this function returns false.
*
@@ -1290,6 +1292,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTextureAlphaModFloat(SDL_Texture *textur
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetTextureBlendMode
* \sa SDL_SetRenderDrawBlendMode
*/
extern SDL_DECLSPEC bool SDLCALL SDL_SetTextureBlendMode(SDL_Texture *texture, SDL_BlendMode blendMode);
@@ -2110,7 +2113,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderColorScale(SDL_Renderer *renderer,
extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderColorScale(SDL_Renderer *renderer, float *scale);
/**
* Set the blend mode used for drawing operations (Fill and Line).
* Set the blend mode used for drawing operations.
*
* This blend mode is used for any drawing that doesn't involve textures.
*
* If the blend mode is not supported, the closest supported mode is chosen.
*
@@ -2124,6 +2129,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetRenderColorScale(SDL_Renderer *renderer,
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetRenderDrawBlendMode
* \sa SDL_SetTextureBlendMode
*/
extern SDL_DECLSPEC bool SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer *renderer, SDL_BlendMode blendMode);