(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_SetTextureAlphaModFloat

Set an additional alpha value multiplied into render copy operations.

Header File

Defined in <SDL3/SDL_render.h>

Syntax

SDL_bool SDL_SetTextureAlphaModFloat(SDL_Texture *texture, float alpha);

Function Parameters

SDL_Texture *	texture	the texture to update.
float	alpha	the source alpha value multiplied into copy operations.

Return Value

(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.

Remarks

When this texture is rendered, during the copy operation the source alpha value is modulated by this alpha value according to the following formula:

srcA = srcA * alpha

Alpha modulation is not always supported by the renderer; it will return SDL_FALSE if alpha modulation is not supported.

Version

This function is available since SDL 3.0.0.

See Also

• SDL_GetTextureAlphaModFloat
• SDL_SetTextureAlphaMod
• SDL_SetTextureColorModFloat

---

CategoryAPI, CategoryAPIFunction, CategoryRender

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.