程序包 ohos.agp.render

类 ColorMatrix

java.lang.Object

ohos.agp.render.ColorMatrix

public class ColorMatrix
extends Object

Transforms the alpha and color values of a PixelMap object.

This class provides a 4 x 5 matrix of floating-point numbers to implement translation, scaling, or saturation adjustment on color vectors. The following is an example of ColorMatrix instance:

 M = [ m00, m01, m02, m03, m04,
       m10, m11, m12, m13, m14,
       m20, m21, m22, m23, m24,
       m30, m31, m32, m33, m34 ] 

A color vector is represented as [R, G, B, A, 1]. R, G, and B indicate the color value, and A indicates the alpha value. By adding vector 1, you will be able to represent translation of the color vector by matrix multiplication. After the transformation, the color vector is as follows:

 R = m00*R + m01*G + m02*B + m03*A + m04
 G = m10*R + m11*G + m12*B + m13*A + m14
 B = m20*R + m21*G + m22*B + m23*A + m24
 A = m30*R + m31*G + m32*B + m33*A + m34 

从以下版本开始:

1

构造器概要

构造器

构造器	说明
ColorMatrix()	Default constructor used to create a ColorMatrix instance.
ColorMatrix(float[] srcMatrix)	A constructor used to create a row major ColorMatrix instance and initialize it using a specified array.
ColorMatrix(ColorMatrix srcMatrix)	A constructor used to create and initialize a ColorMatrix instance.

方法概要

限定符和类型	方法	说明
float[]	getMatrix()	Obtains the floating point array of a colorMatrix instance.
void	modify(float[] src)	Modifies this ColorMatrix.
void	postConcat(ColorMatrix colorMatrix)	Post-multiplies this ColorMatrix by a specified color matrix, and saves the result to this ColorMatrix.
void	postTranslate(float redOffset, float greenOffset, float blueOffset, float alphaOffset)	Sets a ColorMatrix instance to translate according to a specified value.
void	reset()	Resets a colorMatrix instance to an identity matrix.
void	setMatrix(float[] colorArray)	Changes a ColorMatrix instance.
void	setSaturation(float saturation)	Sets the saturation of a ColorMatrix instance.
void	setScale(float redScale, float greenScale, float blueScale, float alphaScale)	Sets a ColorMatrix instance to scale according to a specified value.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ColorMatrix

public ColorMatrix()

Default constructor used to create a ColorMatrix instance.

This method creates a ColorMatrix instance and initializes it to an identity matrix.

ColorMatrix

public ColorMatrix(float[] srcMatrix)

A constructor used to create a row major ColorMatrix instance and initialize it using a specified array.

ColorMatrix

public ColorMatrix(ColorMatrix srcMatrix)

A constructor used to create and initialize a ColorMatrix instance.

方法详细资料

getMatrix

public final float[] getMatrix()

Obtains the floating point array of a colorMatrix instance.

返回:

Returns the floating point array of the colorMatrix instance.

reset

public void reset()

Resets a colorMatrix instance to an identity matrix.

The identity matrix is defined as follows:

 [ 1 0 0 0 0 - red vector
   0 1 0 0 0 - green vector
   0 0 1 0 0 - blue vector
   0 0 0 1 0 ] - alpha vector 

setMatrix

public void setMatrix(float[] colorArray)

Changes a ColorMatrix instance.

The values in the floating point array are copied to the ColorMatrix instance to change the color matrix.

参数:

colorArray - Indicates the floating point array, whose length is 20.

setScale

public void setScale(float redScale,
                     float greenScale,
                     float blueScale,
                     float alphaScale)

Sets a ColorMatrix instance to scale according to a specified value.

参数:

redScale - Indicates the scaling coefficient of red.

greenScale - Indicates the scaling coefficient of green.

blueScale - Indicates the scaling coefficient of blue.

alphaScale - Indicates the scaling coefficient of alpha value.

postTranslate

public void postTranslate(float redOffset,
                          float greenOffset,
                          float blueOffset,
                          float alphaOffset)

Sets a ColorMatrix instance to translate according to a specified value.

参数:

redOffset - Indicates the offset of red.

greenOffset - Indicates the offset of green.

blueOffset - Indicates the offset of blue.

alphaOffset - Indicates the offset of alpha value.

setSaturation

public void setSaturation(float saturation)

Sets the saturation of a ColorMatrix instance.

The saturation of the ColorMatrix instance can be set to a specified value.

参数:

saturation - Indicates the saturation value, which ranges from 0 to 1.0. The value 1.0 indicates the identity matrix.

modify

public void modify(float[] src)

Modifies this ColorMatrix.

参数:

src - Indicates the array of values used to modify this ColorMatrix.

从以下版本开始:

3

postConcat

public void postConcat(ColorMatrix colorMatrix)

Post-multiplies this ColorMatrix by a specified color matrix, and saves the result to this ColorMatrix.

参数:

colorMatrix - Indicates the color matrix for post-multiplication.

从以下版本开始:

4