Join us on the livestream at Android Dev Summit on 7-8 November 2018, starting at 10AM PDT!
added in API level 17

ScriptIntrinsicConvolve5x5

public final class ScriptIntrinsicConvolve5x5
extends ScriptIntrinsic

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


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(RenderScript), Element.U8_2(RenderScript), Element.U8_3(RenderScript), Element.U8_4(RenderScript), Element.F32(RenderScript), Element.F32_2(RenderScript), Element.F32_3(RenderScript), and Element.F32_4(RenderScript).

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

Public methods

create

added in API level 17
public static ScriptIntrinsicConvolve5x5 create (RenderScript rs, 
                Element e)

Supported elements types are Element.U8(RenderScript), Element.U8_2(RenderScript), Element.U8_3(RenderScript), Element.U8_4(RenderScript), Element.F32(RenderScript), Element.F32_2(RenderScript), Element.F32_3(RenderScript), and Element.F32_4(RenderScript).

The default coefficients are:

[ 0, 0, 0, 0, 0 ]

[ 0, 0, 0, 0, 0 ]

[ 0, 0, 1, 0, 0 ]

[ 0, 0, 0, 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
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.