SDL_SetSurfaceAlphaMod - Man Page

Set an additional alpha value used in blit operations.

Synopsis

#include <SDL3/SDL_surface.h>

bool SDL_SetSurfaceAlphaMod(SDL_Surface *surface, Uint8 alpha);

Description

When this surface is blitted, during the blit operation the source alpha value is modulated by this alpha value according to the following formula:

srcA = srcA * (alpha / 255)

Function Parameters

surface

the SDL_Surface structure to update.

alpha

the alpha value multiplied into blit operations.

Return Value

Returns true on success or false on failure; call SDL_GetError() for more information.

Thread Safety

This function can be called on different threads with different surfaces.

Availability

This function is available since SDL 3.2.0.

See Also

SDL_GetSurfaceAlphaMod(3), SDL_SetSurfaceColorMod(3)

Referenced By

SDL_GetSurfaceAlphaMod(3), SDL_SetSurfaceColorMod(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS