Man page - sdl_settexturealphamodfloat(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_SetTextureAlphaModFloat

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
THREAD SAFETY
AVAILABILITY
SEE ALSO

NAME

SDL_SetTextureAlphaModFloat - Set an additional alpha value multiplied into render copy operations.

HEADER FILE

Defined in SDL3/SDL_render.h

SYNOPSIS

#include "SDL3/SDL.h"

bool SDL_SetTextureAlphaModFloat(SDL_Texture *texture, float alpha);

DESCRIPTION

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.

FUNCTION PARAMETERS

texture

the texture to update.

alpha

the source alpha value multiplied into copy operations.

RETURN VALUE

Returns true on success or false on failure; call

SDL_GetError () for more information.

THREAD SAFETY

This function should only be called on the main thread.

AVAILABILITY

This function is available since SDL 3.2.0.