Added in API level 17
Deprecated in API level 31

ScriptIntrinsicConvolve5x5

public final class ScriptIntrinsicConvolve5x5
extends ScriptIntrinsic

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

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 5x5 convolve to an allocation.

Summary

Public methods
`static ScriptIntrinsicConvolve5x5`	`create(RenderScript rs, Element e)` 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`.
`void`	`forEach(Allocation aout)` Apply the filter to the input and save to the specified allocation.
`void`	`forEach(Allocation aout, Script.LaunchOptions opt)` Apply the filter to the input and save to the specified allocation.
`Script.FieldID`	`getFieldID_Input()` Get a FieldID for the input field of this intrinsic.
`Script.KernelID`	`getKernelID()` Get a KernelID for this intrinsic kernel.
`void`	`setCoefficients(float[] v)` Set the coefficients for the convolve.
`void`	`setInput(Allocation ain)` Set the input of the 5x5 convolve.

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

 public static ScriptIntrinsicConvolve5x5 create (RenderScript rs, Element e)

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.

The default coefficients are:

[ 0, 0, 0, 0, 0 ]

[ 0, 0, 1, 0, 0 ]

[ 0, 0, 0, 0, 0 ]

Parameters
`rs`	`RenderScript`: The RenderScript context
`e`	`Element`: Element type for intputs and outputs

Returns
`ScriptIntrinsicConvolve5x5`	ScriptIntrinsicConvolve5x5

forEach

Added in API level 17

 public void forEach (Allocation aout)

Apply the filter to the input and save to the specified allocation.

Parameters
`aout`	`Allocation`: Output allocation. Must match creation element type.

forEach

Added in API level 21
Deprecated in API level 31

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

Apply the filter to the input and save to the specified allocation.

Parameters
`aout`	`Allocation`: Output allocation. Must match creation element type.
`opt`	`Script.LaunchOptions`: LaunchOptions for clipping

getFieldID_Input

Added in API level 17

 public Script.FieldID getFieldID_Input ()

Get a FieldID for the input field of this intrinsic.

Returns
`Script.FieldID`	Script.FieldID The FieldID object.

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.

setCoefficients

Added in API level 17

 public void setCoefficients (float[] v)

Set the coefficients for the convolve.

The convolve layout is:

[ 0, 1, 2, 3, 4 ]

[ 5, 6, 7, 8, 9 ]

[ 10, 11, 12, 13, 14 ]

[ 15, 16, 17, 18, 19 ]

[ 20, 21, 22, 23, 24 ]

Parameters
`v`	`float`: The array of coefficients to set

setInput

Added in API level 17

 public void setInput (Allocation ain)

Set the input of the 5x5 convolve. Must match the element type supplied during create.

Parameters
`ain`	`Allocation`: The input allocation.