Android APIs
public class

ColorMatrixColorFilter

extends ColorFilter
java.lang.Object
   ↳ android.graphics.ColorFilter
     ↳ android.graphics.ColorMatrixColorFilter

Class Overview

A color filter that transforms colors through a 4x5 color matrix. This filter can be used to change the saturation of pixels, convert from YUV to RGB, etc.

See Also

Summary

Public Constructors
ColorMatrixColorFilter(ColorMatrix matrix)
Create a color filter that transforms colors through a 4x5 color matrix.
ColorMatrixColorFilter(float[] array)
Create a color filter that transforms colors through a 4x5 color matrix.
Public Methods
ColorMatrix getColorMatrix()
Returns the ColorMatrix used by this filter.
void setColorMatrix(float[] array)
Specifies the color matrix used by this filter.
void setColorMatrix(ColorMatrix matrix)
Specifies the color matrix used by this filter.
[Expand]
Inherited Methods
From class android.graphics.ColorFilter
From class java.lang.Object

Public Constructors

public ColorMatrixColorFilter (ColorMatrix matrix)

Added in API level 1

Create a color filter that transforms colors through a 4x5 color matrix.

Parameters
matrix 4x5 matrix used to transform colors. It is copied into the filter, so changes made to the matrix after the filter is constructed will not be reflected in the filter.

public ColorMatrixColorFilter (float[] array)

Added in API level 1

Create a color filter that transforms colors through a 4x5 color matrix.

Parameters
array Array of floats used to transform colors, treated as a 4x5 matrix. The first 20 entries of the array are copied into the filter. See ColorMatrix.

Public Methods

public ColorMatrix getColorMatrix ()

Returns the ColorMatrix used by this filter. The returned value is never null. Modifying the returned matrix does not have any effect until you call setColorMatrix(ColorMatrix).

public void setColorMatrix (float[] array)

Specifies the color matrix used by this filter. If the specified color matrix is null, this filter's color matrix will be reset to the identity matrix.

Parameters
array Array of floats used to transform colors, treated as a 4x5 matrix. The first 20 entries of the array are copied into the filter. See ColorMatrix.
Throws
ArrayIndexOutOfBoundsException if the specified array's length is < 20

public void setColorMatrix (ColorMatrix matrix)

Specifies the color matrix used by this filter. If the specified color matrix is null, this filter's color matrix will be reset to the identity matrix.

Parameters
matrix A ColorMatrix or null