Added in API level 17
Deprecated in API level 31

Summary: Methods | Inherited Methods

ScriptIntrinsicColorMatrix

Kotlin |Java

public final class ScriptIntrinsicColorMatrix
extends ScriptIntrinsic

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

This class was deprecated in API level 31.
Renderscript has been deprecated in API level 31. Please refer to the migration guide for the proposed alternatives.

Intrinsic for applying a color matrix to allocations. If the element type is Element.DataType.UNSIGNED_8, it is converted to Element.DataType.FLOAT_32 and normalized from (0-255) to (0-1). If the incoming vector size is less than four, a Element.F32_4 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 Element.F32_4, 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 Element.U8, Element.U8_2(RenderScript), Element.U8_3, Element.U8_4, Element.F32, Element.F32_2, Element.F32_3(RenderScript), and Element.F32_4.

Summary

Public methods
`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.
`static ScriptIntrinsicColorMatrix`	`create(RenderScript rs)` Create an intrinsic for applying a color matrix to an allocation.
`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`.
`void`	`forEach(Allocation ain, Allocation aout, Script.LaunchOptions opt)` 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.

Inherited methods

From class


        
          android.renderscript.Script

`void`	`bindAllocation(Allocation va, int slot)` Only intended for use by generated reflected code.
`Script.FieldID`	`createFieldID(int slot, Element e)` Only to be used by generated reflected classes.
`Script.InvokeID`	`createInvokeID(int slot)` Only to be used by generated reflected classes.
`Script.KernelID`	`createKernelID(int slot, int sig, Element ein, Element eout)` Only to be used by generated reflected classes.
`void`	`forEach(int slot, Allocation[] ains, Allocation aout, FieldPacker v)` Only intended for use by generated reflected code.
`void`	`forEach(int slot, Allocation ain, Allocation aout, FieldPacker v, Script.LaunchOptions sc)` Only intended for use by generated reflected code.
`void`	`forEach(int slot, Allocation ain, Allocation aout, FieldPacker v)` Only intended for use by generated reflected code.
`void`	`forEach(int slot, Allocation[] ains, Allocation aout, FieldPacker v, Script.LaunchOptions sc)` Only intended for use by generated reflected code.
`boolean`	`getVarB(int index)`
`double`	`getVarD(int index)`
`float`	`getVarF(int index)`
`int`	`getVarI(int index)`
`long`	`getVarJ(int index)`
`void`	`getVarV(int index, FieldPacker v)` Only intended for use by generated reflected code.
`void`	`invoke(int slot)` Only intended for use by generated reflected code.
`void`	`invoke(int slot, FieldPacker v)` Only intended for use by generated reflected code.
`void`	`reduce(int slot, Allocation[] ains, Allocation aout, Script.LaunchOptions sc)` Only intended for use by generated reflected code.
`void`	`setTimeZone(String timeZone)`
`void`	`setVar(int index, boolean v)` Only intended for use by generated reflected code.
`void`	`setVar(int index, int v)` Only intended for use by generated reflected code.
`void`	`setVar(int index, FieldPacker v, Element e, int[] dims)` Only intended for use by generated reflected code.
`void`	`setVar(int index, FieldPacker v)` Only intended for use by generated reflected code.
`void`	`setVar(int index, float v)` Only intended for use by generated reflected code.
`void`	`setVar(int index, double v)` Only intended for use by generated reflected code.
`void`	`setVar(int index, long v)` Only intended for use by generated reflected code.
`void`	`setVar(int index, BaseObj o)` Only intended for use by generated reflected code.

From class


        
          android.renderscript.BaseObj

`void`	`destroy()` Frees any native resources associated with this object.
`boolean`	`equals(Object obj)` Compare the current BaseObj with another BaseObj for equality.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`String`	`getName()`
`int`	`hashCode()` Calculates the hash code value for a BaseObj.
`void`	`setName(String name)` setName assigns a name to an object.

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 methods

create

Added in API level 17
Deprecated in API level 19

public 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.

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

Parameters
`rs`	`RenderScript`: The RenderScript context
`e`	`Element`: 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`	ScriptIntrinsicColorMatrix

create

Added in API level 19
Deprecated in API level 31

public static ScriptIntrinsicColorMatrix create (RenderScript rs)

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

Parameters
`rs`	`RenderScript`: The RenderScript context

Returns
`ScriptIntrinsicColorMatrix`	ScriptIntrinsicColorMatrix

forEach

Added in API level 17

public 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. 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`	`Allocation`: Input allocation
`aout`	`Allocation`: Output allocation

forEach

Added in API level 21
Deprecated in API level 31

public void forEach (Allocation ain, 
                Allocation aout, 
                Script.LaunchOptions opt)

Parameters
`ain`	`Allocation`: Input allocation
`aout`	`Allocation`: Output allocation
`opt`	`Script.LaunchOptions`: LaunchOptions for clipping

getKernelID

Added in API level 17

public Script.KernelID getKernelID ()

Get a KernelID for this intrinsic kernel.

Returns
`Script.KernelID`	Script.KernelID The KernelID object.

setAdd

Added in API level 19
Deprecated in API level 31

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

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

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

setAdd

Added in API level 19
Deprecated in API level 31

public void setAdd (Float4 f)

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

Parameters
`f`	`Float4`: The float4 value to be added.

setColorMatrix

Added in API level 17

public void setColorMatrix (Matrix3f m)

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`	`Matrix3f`: The 3x3 matrix to set.

setColorMatrix

Added in API level 17

public void setColorMatrix (Matrix4f m)

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

Parameters
`m`	`Matrix4f`: The 4x4 matrix to set.

setGreyscale

Added in API level 17

public void setGreyscale ()

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

setRGBtoYUV

Added in API level 17

public void setRGBtoYUV ()

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

setYUVtoRGB

Added in API level 17

public void setYUVtoRGB ()

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