(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetTextureAlphaModFloat

Set an additional alpha value multiplied into render copy operations.

Header File

Defined in <SDL3/SDL_render.h>

Syntax

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

(bool) Returns true on success or 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 false if alpha modulation is not supported.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

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.