(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_SetTextureAlphaMod

Set an additional alpha value multiplied into render copy operations.

Header File

Defined in SDL_render.h

Syntax

int SDL_SetTextureAlphaMod(SDL_Texture * texture,
                           Uint8 alpha);

Function Parameters

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

Return Value

(int) Returns 0 on success or a negative error code 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 / 255)

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

Version

This function is available since SDL 2.0.0.

See Also

• SDL_GetTextureAlphaMod
• SDL_SetTextureColorMod

---

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.