Android APIs
public final class

ScriptIntrinsicColorMatrix

extends ScriptIntrinsic
java.lang.Object
   ↳ android.renderscript.BaseObj
     ↳ android.renderscript.Script
       ↳ android.renderscript.ScriptIntrinsic
         ↳ android.renderscript.ScriptIntrinsicColorMatrix

Class Overview

Intrinsic for applying a color matrix to allocations. If the element type is UNSIGNED_8, it is converted to FLOAT_32 and normalized from (0-255) to (0-1). If the incoming vector size is less than four, a F32_4(RenderScript) is created by filling the missing vector channels with zero. This value is then multiplied by the 4x4 color matrix as performed by rsMatrixMultiply(), adding a F32_4(RenderScript), and then writing it to the output Allocation. If the ouptut type is unsigned, the value is normalized from (0-1) to (0-255) and converted. If the output vector size is less than four, the unused channels are discarded. Supported elements types are U8(RenderScript), U8_2(RenderScript), U8_3(RenderScript), U8_4(RenderScript), F32(RenderScript), F32_2(RenderScript), F32_3(RenderScript), and F32_4(RenderScript).

Summary

Public Methods
static ScriptIntrinsicColorMatrix create(RenderScript rs)
Create an intrinsic for applying a color matrix to an allocation.
static ScriptIntrinsicColorMatrix create(RenderScript rs, Element e)
This method was deprecated in API level 19. Use the single argument version as Element is now ignored.
void forEach(Allocation ain, Allocation aout)
Invoke the kernel and apply the matrix to each cell of input Allocation and copy to the output Allocation.
Script.KernelID getKernelID()
Get a KernelID for this intrinsic kernel.
void setAdd(float r, float g, float b, float a)
Set the value to be added after the color matrix has been applied.
void setAdd(Float4 f)
Set the value to be added after the color matrix has been applied.
void setColorMatrix(Matrix3f m)
Set the color matrix which will be applied to each cell of the image.
void setColorMatrix(Matrix4f m)
Set the color matrix which will be applied to each cell of the image.
void setGreyscale()
Set a color matrix to convert from RGB to luminance.
void setRGBtoYUV()
Set the matrix to convert from RGB to YUV with a direct copy of the 4th channel.
void setYUVtoRGB()
Set the matrix to convert from YUV to RGB with a direct copy of the 4th channel.
[Expand]
Inherited Methods
From class android.renderscript.Script
From class android.renderscript.BaseObj
From class java.lang.Object

Public Methods

public static ScriptIntrinsicColorMatrix create (RenderScript rs)

Added in API level 19

Create an intrinsic for applying a color matrix to an allocation.

Parameters
rs The RenderScript context
Returns
  • ScriptIntrinsicColorMatrix

public static ScriptIntrinsicColorMatrix create (RenderScript rs, Element e)

Added in API level 17

This method was deprecated in API level 19.
Use the single argument version as Element is now ignored.

Create an intrinsic for applying a color matrix to an allocation.

Parameters
rs The RenderScript context
e Element type for inputs and outputs, As of API 19, this parameter is ignored. The Element type check is performed in the kernel launch.
Returns
  • ScriptIntrinsicColorMatrix

public void forEach (Allocation ain, Allocation aout)

Added in API level 17

Invoke the kernel and apply the matrix to each cell of input Allocation and copy to the output Allocation. If the vector size of the input is less than four, the remaining components are treated as zero for the matrix multiply. If the output vector size is less than four, the unused vector components are discarded.

Parameters
ain Input allocation
aout Output allocation

public Script.KernelID getKernelID ()

Added in API level 17

Get a KernelID for this intrinsic kernel.

Returns
  • Script.KernelID The KernelID object.

public void setAdd (float r, float g, float b, float a)

Added in API level 19

Set the value to be added after the color matrix has been applied. The default value is {0, 0, 0, 0}

Parameters
r The red add value.
g The green add value.
b The blue add value.
a The alpha add value.

public void setAdd (Float4 f)

Added in API level 19

Set the value to be added after the color matrix has been applied. The default value is {0, 0, 0, 0}

Parameters
f The float4 value to be added.

public void setColorMatrix (Matrix3f m)

Added in API level 17

Set the color matrix which will be applied to each cell of the image. This will set the alpha channel to be a copy.

Parameters
m The 3x3 matrix to set.

public void setColorMatrix (Matrix4f m)

Added in API level 17

Set the color matrix which will be applied to each cell of the image.

Parameters
m The 4x4 matrix to set.

public void setGreyscale ()

Added in API level 17

Set a color matrix to convert from RGB to luminance. The alpha channel will be a copy.

public void setRGBtoYUV ()

Added in API level 17

Set the matrix to convert from RGB to YUV with a direct copy of the 4th channel.

public void setYUVtoRGB ()

Added in API level 17

Set the matrix to convert from YUV to RGB with a direct copy of the 4th channel.