# ScriptIntrinsicConvolve3x3
Added in[API level 17](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Deprecated in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Summary:[Methods](https://developer.android.com/reference/android/renderscript/ScriptIntrinsicConvolve3x3#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/renderscript/ScriptIntrinsicConvolve3x3#inhmethods)
# ScriptIntrinsicConvolve3x3
*** ** * ** ***
[Kotlin](https://developer.android.com/reference/kotlin/android/renderscript/ScriptIntrinsicConvolve3x3 "View this page in Kotlin")\|Java
`
public
final
class
ScriptIntrinsicConvolve3x3
`
`
``
``
``
extends `[ScriptIntrinsic](https://developer.android.com/reference/android/renderscript/ScriptIntrinsic)`
``
`
|---|---|---|---|-------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||||
| ↳ | [android.renderscript.BaseObj](https://developer.android.com/reference/android/renderscript/BaseObj) ||||
| | ↳ | [android.renderscript.Script](https://developer.android.com/reference/android/renderscript/Script) |||
| | | ↳ | [android.renderscript.ScriptIntrinsic](https://developer.android.com/reference/android/renderscript/ScriptIntrinsic) ||
| | | | ↳ | android.renderscript.ScriptIntrinsicConvolve3x3 |
*** ** * ** ***
**This class was deprecated in API level 31.**
Renderscript has been deprecated in API level 31. Please refer to the[migration guide](https://developer.android.com/guide/topics/renderscript/migration-guide)for the proposed alternatives.
Intrinsic for applying a 3x3 convolve to an allocation.
## Summary
| ### Public methods ||
|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` static `[ScriptIntrinsicConvolve3x3](https://developer.android.com/reference/android/renderscript/ScriptIntrinsicConvolve3x3) | ` `[create](https://developer.android.com/reference/android/renderscript/ScriptIntrinsicConvolve3x3#create(android.renderscript.RenderScript,%20android.renderscript.Element))`(`[RenderScript](https://developer.android.com/reference/android/renderscript/RenderScript)` rs, `[Element](https://developer.android.com/reference/android/renderscript/Element)` e) ` Supported elements types are[Element.U8](https://developer.android.com/reference/android/renderscript/Element#U8(android.renderscript.RenderScript)),[Element.U8_2(RenderScript)](https://developer.android.com/reference/android/renderscript/Element#U8_2(android.renderscript.RenderScript)),[Element.U8_3](https://developer.android.com/reference/android/renderscript/Element#U8_3(android.renderscript.RenderScript)),[Element.U8_4](https://developer.android.com/reference/android/renderscript/Element#U8_4(android.renderscript.RenderScript)),[Element.F32](https://developer.android.com/reference/android/renderscript/Element#F32(android.renderscript.RenderScript)),[Element.F32_2](https://developer.android.com/reference/android/renderscript/Element#F32_2(android.renderscript.RenderScript)),[Element.F32_3(RenderScript)](https://developer.android.com/reference/android/renderscript/Element#F32_3(android.renderscript.RenderScript)), and[Element.F32_4](https://developer.android.com/reference/android/renderscript/Element#F32_4(android.renderscript.RenderScript)). |
| ` void` | ` `[forEach](https://developer.android.com/reference/android/renderscript/ScriptIntrinsicConvolve3x3#forEach(android.renderscript.Allocation))`(`[Allocation](https://developer.android.com/reference/android/renderscript/Allocation)` aout) ` Apply the filter to the input and save to the specified allocation. |
| ` void` | ` `[forEach](https://developer.android.com/reference/android/renderscript/ScriptIntrinsicConvolve3x3#forEach(android.renderscript.Allocation,%20android.renderscript.Script.LaunchOptions))`(`[Allocation](https://developer.android.com/reference/android/renderscript/Allocation)` aout, `[Script.LaunchOptions](https://developer.android.com/reference/android/renderscript/Script.LaunchOptions)` opt) ` Apply the filter to the input and save to the specified allocation. |
| ` `[Script.FieldID](https://developer.android.com/reference/android/renderscript/Script.FieldID) | ` `[getFieldID_Input](https://developer.android.com/reference/android/renderscript/ScriptIntrinsicConvolve3x3#getFieldID_Input())`() ` Get a FieldID for the input field of this intrinsic. |
| ` `[Script.KernelID](https://developer.android.com/reference/android/renderscript/Script.KernelID) | ` `[getKernelID](https://developer.android.com/reference/android/renderscript/ScriptIntrinsicConvolve3x3#getKernelID())`() ` Get a KernelID for this intrinsic kernel. |
| ` void` | ` `[setCoefficients](https://developer.android.com/reference/android/renderscript/ScriptIntrinsicConvolve3x3#setCoefficients(float[]))`(float[] v) ` Set the coefficients for the convolve. |
| ` void` | ` `[setInput](https://developer.android.com/reference/android/renderscript/ScriptIntrinsicConvolve3x3#setInput(android.renderscript.Allocation))`(`[Allocation](https://developer.android.com/reference/android/renderscript/Allocation)` ain) ` Set the input of the 3x3 convolve. |
| ### Inherited methods |
|-----------------------|---|
| From class` `[android.renderscript.Script](https://developer.android.com/reference/android/renderscript/Script)` ` |----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` void` | ` `[bindAllocation](https://developer.android.com/reference/android/renderscript/Script#bindAllocation(android.renderscript.Allocation,%20int))`(`[Allocation](https://developer.android.com/reference/android/renderscript/Allocation)` va, int slot) ` Only intended for use by generated reflected code. | | ` `[Script.FieldID](https://developer.android.com/reference/android/renderscript/Script.FieldID) | ` `[createFieldID](https://developer.android.com/reference/android/renderscript/Script#createFieldID(int,%20android.renderscript.Element))`(int slot, `[Element](https://developer.android.com/reference/android/renderscript/Element)` e) ` Only to be used by generated reflected classes. | | ` `[Script.InvokeID](https://developer.android.com/reference/android/renderscript/Script.InvokeID) | ` `[createInvokeID](https://developer.android.com/reference/android/renderscript/Script#createInvokeID(int))`(int slot) ` Only to be used by generated reflected classes. | | ` `[Script.KernelID](https://developer.android.com/reference/android/renderscript/Script.KernelID) | ` `[createKernelID](https://developer.android.com/reference/android/renderscript/Script#createKernelID(int,%20int,%20android.renderscript.Element,%20android.renderscript.Element))`(int slot, int sig, `[Element](https://developer.android.com/reference/android/renderscript/Element)` ein, `[Element](https://developer.android.com/reference/android/renderscript/Element)` eout) ` Only to be used by generated reflected classes. | | ` void` | ` `[forEach](https://developer.android.com/reference/android/renderscript/Script#forEach(int,%20android.renderscript.Allocation[],%20android.renderscript.Allocation,%20android.renderscript.FieldPacker))`(int slot, `[Allocation[]](https://developer.android.com/reference/android/renderscript/Allocation)` ains, `[Allocation](https://developer.android.com/reference/android/renderscript/Allocation)` aout, `[FieldPacker](https://developer.android.com/reference/android/renderscript/FieldPacker)` v) ` Only intended for use by generated reflected code. | | ` void` | ` `[forEach](https://developer.android.com/reference/android/renderscript/Script#forEach(int,%20android.renderscript.Allocation,%20android.renderscript.Allocation,%20android.renderscript.FieldPacker,%20android.renderscript.Script.LaunchOptions))`(int slot, `[Allocation](https://developer.android.com/reference/android/renderscript/Allocation)` ain, `[Allocation](https://developer.android.com/reference/android/renderscript/Allocation)` aout, `[FieldPacker](https://developer.android.com/reference/android/renderscript/FieldPacker)` v, `[Script.LaunchOptions](https://developer.android.com/reference/android/renderscript/Script.LaunchOptions)` sc) ` Only intended for use by generated reflected code. | | ` void` | ` `[forEach](https://developer.android.com/reference/android/renderscript/Script#forEach(int,%20android.renderscript.Allocation,%20android.renderscript.Allocation,%20android.renderscript.FieldPacker))`(int slot, `[Allocation](https://developer.android.com/reference/android/renderscript/Allocation)` ain, `[Allocation](https://developer.android.com/reference/android/renderscript/Allocation)` aout, `[FieldPacker](https://developer.android.com/reference/android/renderscript/FieldPacker)` v) ` Only intended for use by generated reflected code. | | ` void` | ` `[forEach](https://developer.android.com/reference/android/renderscript/Script#forEach(int,%20android.renderscript.Allocation[],%20android.renderscript.Allocation,%20android.renderscript.FieldPacker,%20android.renderscript.Script.LaunchOptions))`(int slot, `[Allocation[]](https://developer.android.com/reference/android/renderscript/Allocation)` ains, `[Allocation](https://developer.android.com/reference/android/renderscript/Allocation)` aout, `[FieldPacker](https://developer.android.com/reference/android/renderscript/FieldPacker)` v, `[Script.LaunchOptions](https://developer.android.com/reference/android/renderscript/Script.LaunchOptions)` sc) ` Only intended for use by generated reflected code. | | ` boolean` | ` `[getVarB](https://developer.android.com/reference/android/renderscript/Script#getVarB(int))`(int index) ` | | ` double` | ` `[getVarD](https://developer.android.com/reference/android/renderscript/Script#getVarD(int))`(int index) ` | | ` float` | ` `[getVarF](https://developer.android.com/reference/android/renderscript/Script#getVarF(int))`(int index) ` | | ` int` | ` `[getVarI](https://developer.android.com/reference/android/renderscript/Script#getVarI(int))`(int index) ` | | ` long` | ` `[getVarJ](https://developer.android.com/reference/android/renderscript/Script#getVarJ(int))`(int index) ` | | ` void` | ` `[getVarV](https://developer.android.com/reference/android/renderscript/Script#getVarV(int,%20android.renderscript.FieldPacker))`(int index, `[FieldPacker](https://developer.android.com/reference/android/renderscript/FieldPacker)` v) ` Only intended for use by generated reflected code. | | ` void` | ` `[invoke](https://developer.android.com/reference/android/renderscript/Script#invoke(int))`(int slot) ` Only intended for use by generated reflected code. | | ` void` | ` `[invoke](https://developer.android.com/reference/android/renderscript/Script#invoke(int,%20android.renderscript.FieldPacker))`(int slot, `[FieldPacker](https://developer.android.com/reference/android/renderscript/FieldPacker)` v) ` Only intended for use by generated reflected code. | | ` void` | ` `[reduce](https://developer.android.com/reference/android/renderscript/Script#reduce(int,%20android.renderscript.Allocation[],%20android.renderscript.Allocation,%20android.renderscript.Script.LaunchOptions))`(int slot, `[Allocation[]](https://developer.android.com/reference/android/renderscript/Allocation)` ains, `[Allocation](https://developer.android.com/reference/android/renderscript/Allocation)` aout, `[Script.LaunchOptions](https://developer.android.com/reference/android/renderscript/Script.LaunchOptions)` sc) ` Only intended for use by generated reflected code. | | ` void` | ` `[setTimeZone](https://developer.android.com/reference/android/renderscript/Script#setTimeZone(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` timeZone) ` | | ` void` | ` `[setVar](https://developer.android.com/reference/android/renderscript/Script#setVar(int,%20boolean))`(int index, boolean v) ` Only intended for use by generated reflected code. | | ` void` | ` `[setVar](https://developer.android.com/reference/android/renderscript/Script#setVar(int,%20int))`(int index, int v) ` Only intended for use by generated reflected code. | | ` void` | ` `[setVar](https://developer.android.com/reference/android/renderscript/Script#setVar(int,%20android.renderscript.FieldPacker,%20android.renderscript.Element,%20int[]))`(int index, `[FieldPacker](https://developer.android.com/reference/android/renderscript/FieldPacker)` v, `[Element](https://developer.android.com/reference/android/renderscript/Element)` e, int[] dims) ` Only intended for use by generated reflected code. | | ` void` | ` `[setVar](https://developer.android.com/reference/android/renderscript/Script#setVar(int,%20android.renderscript.FieldPacker))`(int index, `[FieldPacker](https://developer.android.com/reference/android/renderscript/FieldPacker)` v) ` Only intended for use by generated reflected code. | | ` void` | ` `[setVar](https://developer.android.com/reference/android/renderscript/Script#setVar(int,%20float))`(int index, float v) ` Only intended for use by generated reflected code. | | ` void` | ` `[setVar](https://developer.android.com/reference/android/renderscript/Script#setVar(int,%20double))`(int index, double v) ` Only intended for use by generated reflected code. | | ` void` | ` `[setVar](https://developer.android.com/reference/android/renderscript/Script#setVar(int,%20long))`(int index, long v) ` Only intended for use by generated reflected code. | | ` void` | ` `[setVar](https://developer.android.com/reference/android/renderscript/Script#setVar(int,%20android.renderscript.BaseObj))`(int index, `[BaseObj](https://developer.android.com/reference/android/renderscript/BaseObj)` o) ` Only intended for use by generated reflected code. | ||
| From class` `[android.renderscript.BaseObj](https://developer.android.com/reference/android/renderscript/BaseObj)` ` |-----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` void` | ` `[destroy](https://developer.android.com/reference/android/renderscript/BaseObj#destroy())`() ` Frees any native resources associated with this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/android/renderscript/BaseObj#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Compare the current BaseObj with another BaseObj for equality. | | ` void` | ` `[finalize](https://developer.android.com/reference/android/renderscript/BaseObj#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getName](https://developer.android.com/reference/android/renderscript/BaseObj#getName())`() ` | | ` int` | ` `[hashCode](https://developer.android.com/reference/android/renderscript/BaseObj#hashCode())`() ` Calculates the hash code value for a BaseObj. | | ` void` | ` `[setName](https://developer.android.com/reference/android/renderscript/BaseObj#setName(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` name) ` setName assigns a name to an object. | ||
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(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](https://developer.android.com/reference/java/lang/Object#wait(long))`(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](https://developer.android.com/reference/java/lang/Object#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static ScriptIntrinsicConvolve3x3 create (RenderScript rs,
Element e)
```
Supported elements types are[Element.U8](https://developer.android.com/reference/android/renderscript/Element#U8(android.renderscript.RenderScript)),[Element.U8_2(RenderScript)](https://developer.android.com/reference/android/renderscript/Element#U8_2(android.renderscript.RenderScript)),[Element.U8_3](https://developer.android.com/reference/android/renderscript/Element#U8_3(android.renderscript.RenderScript)),[Element.U8_4](https://developer.android.com/reference/android/renderscript/Element#U8_4(android.renderscript.RenderScript)),[Element.F32](https://developer.android.com/reference/android/renderscript/Element#F32(android.renderscript.RenderScript)),[Element.F32_2](https://developer.android.com/reference/android/renderscript/Element#F32_2(android.renderscript.RenderScript)),[Element.F32_3(RenderScript)](https://developer.android.com/reference/android/renderscript/Element#F32_3(android.renderscript.RenderScript)), and[Element.F32_4](https://developer.android.com/reference/android/renderscript/Element#F32_4(android.renderscript.RenderScript)).
The default coefficients are:`
`
` [ 0, 0, 0 ]
`
` [ 0, 1, 0 ]
`
` [ 0, 0, 0 ]
`
| Parameters ||
|------|--------------------------------------------------------|
| `rs` | `RenderScript`: The RenderScript context
|
| `e` | `Element`: Element type for intputs and outputs
|
| Returns ||
|-----------------------------------------------------------------------------------------------------------------------|-----------------------------------|
| [ScriptIntrinsicConvolve3x3](https://developer.android.com/reference/android/renderscript/ScriptIntrinsicConvolve3x3) | ScriptIntrinsicConvolve3x3
|
### forEach
Added in[API level 17](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Deprecated in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Script.FieldID getFieldID_Input ()
```
Get a FieldID for the input field of this intrinsic.
| Returns ||
|-----------------------------------------------------------------------------------------------|-------------------------------------------|
| [Script.FieldID](https://developer.android.com/reference/android/renderscript/Script.FieldID) | Script.FieldID The FieldID object.
|
### getKernelID
Added in[API level 17](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Script.KernelID getKernelID ()
```
Get a KernelID for this intrinsic kernel.
| Returns ||
|-------------------------------------------------------------------------------------------------|---------------------------------------------|
| [Script.KernelID](https://developer.android.com/reference/android/renderscript/Script.KernelID) | Script.KernelID The KernelID object.
|
### setCoefficients
Added in[API level 17](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setCoefficients (float[] v)
```
Set the coefficients for the convolve.
The convolve layout is:`
`
` [ 0, 1, 2 ]
`
` [ 3, 4, 5 ]
`
` [ 6, 7, 8 ]
`
| Parameters ||
|-----|--------------------------------------------------|
| `v` | `float`: The array of coefficients to set
|
### setInput
Added in[API level 17](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setInput (Allocation ain)
```
Set the input of the 3x3 convolve. Must match the element type supplied during create.
| Parameters ||
|-------|--------------------------------------------|
| `ain` | `Allocation`: The input allocation.
|