Added in API level 36

Summary: Ctors | Methods | Inherited Methods

RuntimeColorFilter

Kotlin |Java

public class RuntimeColorFilter
extends ColorFilter

java.lang.Object
↳	android.graphics.ColorFilter
	↳	android.graphics.RuntimeColorFilter

A RuntimeColorFilter calculates a per-pixel color based on the output of a user * defined Android Graphics Shading Language (AGSL) function.

This AGSL function takes in an input color to be operated on. This color is in sRGB and the * output is also interpreted as sRGB. The AGSL function signature expects a single input * of color (packed as a half4 or float4 or vec4).

 vec4 main(half4 in_color);

Summary

Public constructors
`RuntimeColorFilter(String agsl)` Creates a new RuntimeColorFilter.

Public methods
`void`	`setColorUniform(String uniformName, int color)` Sets the uniform color value corresponding to this color filter.
`void`	`setColorUniform(String uniformName, long color)` Sets the uniform color value corresponding to this color filter.
`void`	`setColorUniform(String uniformName, Color color)` Sets the uniform color value corresponding to this color filter.
`void`	`setFloatUniform(String uniformName, float[] values)` Sets the uniform value corresponding to this color filter.
`void`	`setFloatUniform(String uniformName, float value)` Sets the uniform value corresponding to this color filter.
`void`	`setFloatUniform(String uniformName, float value1, float value2, float value3, float value4)` Sets the uniform value corresponding to this color filter.
`void`	`setFloatUniform(String uniformName, float value1, float value2)` Sets the uniform value corresponding to this color filter.
`void`	`setFloatUniform(String uniformName, float value1, float value2, float value3)` Sets the uniform value corresponding to this color filter.
`void`	`setInputColorFilter(String filterName, ColorFilter colorFilter)` Assigns the uniform color filter to the provided color filter parameter.
`void`	`setInputShader(String shaderName, Shader shader)` Assigns the uniform shader to the provided shader parameter.
`void`	`setInputXfermode(String xfermodeName, RuntimeXfermode xfermode)` Assigns the uniform xfermode to the provided xfermode parameter.
`void`	`setIntUniform(String uniformName, int value)` Sets the uniform value corresponding to this color filter.
`void`	`setIntUniform(String uniformName, int value1, int value2, int value3)` Sets the uniform value corresponding to this color filter.
`void`	`setIntUniform(String uniformName, int value1, int value2, int value3, int value4)` Sets the uniform value corresponding to this color filter.
`void`	`setIntUniform(String uniformName, int[] values)` Sets the uniform value corresponding to this color filter.
`void`	`setIntUniform(String uniformName, int value1, int value2)` Sets the uniform value corresponding to this color filter.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

RuntimeColorFilter

Added in API level 36

public RuntimeColorFilter (String agsl)

Creates a new RuntimeColorFilter.

Parameters
`agsl`	`String`: The text of AGSL color filter program to run. This value cannot be `null`.

Public methods

setColorUniform

Added in API level 36

public void setColorUniform (String uniformName, 
                int color)

Sets the uniform color value corresponding to this color filter. If the effect does not have a uniform with that name or if the uniform is declared with a type other than vec3 or vec4 and corresponding layout(color) annotation then an IllegalArgumentException is thrown.

Parameters
`uniformName`	`String`: name matching the color uniform declared in the AGSL program This value cannot be `null`.
`color`	`int`: the provided sRGB color

setColorUniform

Added in API level 36

public void setColorUniform (String uniformName, 
                long color)

Parameters
`uniformName`	`String`: name matching the color uniform declared in the AGSL program This value cannot be `null`.
`color`	`long`: the provided sRGB color

setColorUniform

Added in API level 36

public void setColorUniform (String uniformName, 
                Color color)

Parameters
`uniformName`	`String`: name matching the color uniform declared in the AGSL program This value cannot be `null`.
`color`	`Color`: the provided sRGB color This value cannot be `null`.

setFloatUniform

Added in API level 36

public void setFloatUniform (String uniformName, 
                float[] values)

Sets the uniform value corresponding to this color filter. If the effect does not have a uniform with that name or if the uniform is declared with a type other than a float (for N=1), vecN, or float[N] where N is the length of the values param then an IllegalArgumentException is thrown.

Parameters
`uniformName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`values`	`float`: This value cannot be `null`.

setFloatUniform

Added in API level 36

public void setFloatUniform (String uniformName, 
                float value)

Sets the uniform value corresponding to this color filter. If the effect does not have a uniform with that name or if the uniform is declared with a type other than a float or float[1] then an IllegalArgumentException is thrown.

Parameters
`uniformName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`value`	`float`

setFloatUniform

Added in API level 36

public void setFloatUniform (String uniformName, 
                float value1, 
                float value2, 
                float value3, 
                float value4)

Sets the uniform value corresponding to this color filter. If the effect does not have a uniform with that name or if the uniform is declared with a type other than a vec4 or float[4] then an IllegalArgumentException is thrown.

Parameters
`uniformName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`value1`	`float`
`value2`	`float`
`value3`	`float`
`value4`	`float`

setFloatUniform

Added in API level 36

public void setFloatUniform (String uniformName, 
                float value1, 
                float value2)

Sets the uniform value corresponding to this color filter. If the effect does not have a uniform with that name or if the uniform is declared with a type other than a vec2 or float[2] then an IllegalArgumentException is thrown.

Parameters
`uniformName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`value1`	`float`
`value2`	`float`

setFloatUniform

Added in API level 36

public void setFloatUniform (String uniformName, 
                float value1, 
                float value2, 
                float value3)

Sets the uniform value corresponding to this color filter. If the effect does not have a uniform with that name or if the uniform is declared with a type other than a vec3 or float[3] then an IllegalArgumentException is thrown.

Parameters
`uniformName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`value1`	`float`
`value2`	`float`
`value3`	`float`

setInputColorFilter

Added in API level 36

public void setInputColorFilter (String filterName, 
                ColorFilter colorFilter)

Assigns the uniform color filter to the provided color filter parameter. If the shader program does not have a uniform color filter with that name then an IllegalArgumentException is thrown.

Parameters
`filterName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`colorFilter`	`ColorFilter`: filter passed into the AGSL program for sampling This value cannot be `null`.

setInputShader

Added in API level 36

public void setInputShader (String shaderName, 
                Shader shader)

Assigns the uniform shader to the provided shader parameter. If the shader program does not have a uniform shader with that name then an IllegalArgumentException is thrown.

Parameters
`shaderName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`shader`	`Shader`: shader passed into the AGSL program for sampling This value cannot be `null`.

setInputXfermode

Added in API level 36

public void setInputXfermode (String xfermodeName, 
                RuntimeXfermode xfermode)

Assigns the uniform xfermode to the provided xfermode parameter. If the shader program does not have a uniform xfermode with that name then an IllegalArgumentException is thrown.

Parameters
`xfermodeName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`xfermode`	`RuntimeXfermode`: filter passed into the AGSL program for sampling This value cannot be `null`.

setIntUniform

Added in API level 36

public void setIntUniform (String uniformName, 
                int value)

Sets the uniform value corresponding to this color filter. If the effect does not have a uniform with that name or if the uniform is declared with a type other than an int or int[1] then an IllegalArgumentException is thrown.

Parameters
`uniformName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`value`	`int`

setIntUniform

Added in API level 36

public void setIntUniform (String uniformName, 
                int value1, 
                int value2, 
                int value3)

Sets the uniform value corresponding to this color filter. If the effect does not have a uniform with that name or if the uniform is declared with a type other than an ivec3 or int[3] then an IllegalArgumentException is thrown.

Parameters
`uniformName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`value1`	`int`
`value2`	`int`
`value3`	`int`

setIntUniform

Added in API level 36

public void setIntUniform (String uniformName, 
                int value1, 
                int value2, 
                int value3, 
                int value4)

Sets the uniform value corresponding to this color filter. If the effect does not have a uniform with that name or if the uniform is declared with a type other than an ivec4 or int[4] then an IllegalArgumentException is thrown.

Parameters
`uniformName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`value1`	`int`
`value2`	`int`
`value3`	`int`
`value4`	`int`

setIntUniform

Added in API level 36

public void setIntUniform (String uniformName, 
                int[] values)

Sets the uniform value corresponding to this color filter. If the effect does not have a uniform with that name or if the uniform is declared with a type other than an int (for N=1), ivecN, or int[N] where N is the length of the values param then an IllegalArgumentException is thrown.

Parameters
`uniformName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`values`	`int`: This value cannot be `null`.

setIntUniform

Added in API level 36

public void setIntUniform (String uniformName, 
                int value1, 
                int value2)

Sets the uniform value corresponding to this color filter. If the effect does not have a uniform with that name or if the uniform is declared with a type other than an ivec2 or int[2] then an IllegalArgumentException is thrown.

Parameters
`uniformName`	`String`: name matching the uniform declared in the AGSL program This value cannot be `null`.
`value1`	`int`
`value2`	`int`