Added in API level 17
Deprecated in API level 31

ScriptIntrinsicConvolve3x3

Kotlin |Java

class ScriptIntrinsicConvolve3x3 : ScriptIntrinsic

kotlin.Any
↳	android.renderscript.BaseObj
	↳	android.renderscript.Script
		↳	android.renderscript.ScriptIntrinsic
			↳	android.renderscript.ScriptIntrinsicConvolve3x3

Intrinsic for applying a 3x3 convolve to an allocation.

Summary

Public methods
static ScriptIntrinsicConvolve3x3!	`create(rs: RenderScript!, e: Element!)` Supported elements types are `Element.U8`, `android.renderscript.Element#U8_2`, `Element.U8_3`, `Element.U8_4`, `Element.F32`, `Element.F32_2`, `android.renderscript.Element#F32_3`, and `Element.F32_4`.
Unit	`forEach(aout: Allocation!)` Apply the filter to the input and save to the specified allocation.
Unit	`forEach(aout: Allocation!, opt: Script.LaunchOptions!)` 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.
Unit	`setCoefficients(v: FloatArray!)` Set the coefficients for the convolve.
Unit	`setInput(ain: Allocation!)` Set the input of the 3x3 convolve.

Public methods

create

Added in API level 17

static fun create(
    rs: RenderScript!, 
    e: Element!
): ScriptIntrinsicConvolve3x3!

Deprecated: Deprecated in Java.

Supported elements types are Element.U8, android.renderscript.Element#U8_2, Element.U8_3, Element.U8_4, Element.F32, Element.F32_2, android.renderscript.Element#F32_3, and Element.F32_4.

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

Return
`ScriptIntrinsicConvolve3x3!`	ScriptIntrinsicConvolve3x3

forEach

Added in API level 17

fun forEach(aout: Allocation!): Unit

Deprecated: Deprecated in Java.

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

fun forEach(
    aout: Allocation!, 
    opt: Script.LaunchOptions!
): Unit

Deprecated: Deprecated in Java.

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

fun getFieldID_Input(): Script.FieldID!

Deprecated: Deprecated in Java.

Get a FieldID for the input field of this intrinsic.

Return
`Script.FieldID!`	Script.FieldID The FieldID object.

getKernelID

Added in API level 17

fun getKernelID(): Script.KernelID!

Deprecated: Deprecated in Java.

Get a KernelID for this intrinsic kernel.

Return
`Script.KernelID!`	Script.KernelID The KernelID object.

setCoefficients

Added in API level 17

fun setCoefficients(v: FloatArray!): Unit

Deprecated: Deprecated in Java.

Set the coefficients for the convolve.

The convolve layout is:

[ 0, 1, 2 ]

[ 3, 4, 5 ]

[ 6, 7, 8 ]

Parameters
`v`	FloatArray!: The array of coefficients to set

setInput

Added in API level 17

fun setInput(ain: Allocation!): Unit

Deprecated: Deprecated in Java.

Set the input of the 3x3 convolve. Must match the element type supplied during create.

Parameters
`ain`	Allocation!: The input allocation.