@UnstableApi
public final class AlphaScale implements GlEffect


Scales the alpha value (i.e. the translucency) of a frame.

Summary

Public constructors

AlphaScale(@FloatRange(from = 0) float alphaScale)

Creates a new instance to scale the entire frame's alpha values by alphaScale, to modify translucency.

Public methods

boolean
isNoOp(int inputWidth, int inputHeight)

Returns whether a GlEffect applies no change at every timestamp.

AlphaScaleShaderProgram
toGlShaderProgram(Context context, boolean useHdr)

Returns a GlShaderProgram that applies the effect.

Inherited methods

From androidx.media3.common.Effect
long

Returns the expected duration of the output stream when the effect is applied given a input durationUs.

Public constructors

AlphaScale

public AlphaScale(@FloatRange(from = 0) float alphaScale)

Creates a new instance to scale the entire frame's alpha values by alphaScale, to modify translucency.

An alphaScale value of 1 means no change is applied. A value below 1 increases translucency, and a value above 1 reduces translucency.

Public methods

isNoOp

public boolean isNoOp(int inputWidth, int inputHeight)

Returns whether a GlEffect applies no change at every timestamp.

This can be used as a hint to skip this instance.

Parameters
int inputWidth

The input frame width, in pixels.

int inputHeight

The input frame height, in pixels.

toGlShaderProgram

public AlphaScaleShaderProgram toGlShaderProgram(Context context, boolean useHdr)

Returns a GlShaderProgram that applies the effect.

Parameters
Context context

A Context.

boolean useHdr

Whether input textures come from an HDR source. If true, colors will be in linear RGB BT.2020. If false, colors will be in linear RGB BT.709.

Throws
androidx.media3.common.VideoFrameProcessingException

If an error occurs while creating the .