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


Set an additional alpha value multiplied into render copy operations.

Header File

Defined in <SDL3/SDL_render.h>


int 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

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.


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 -1 if alpha modulation is not supported.


This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryRender

[ edit | delete | history | feedback | raw ]

[ 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.