Script

Kotlin |Java

open class Script : BaseObj

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

Known Direct Subclasses

ScriptC, ScriptIntrinsic

ScriptC	The superclass for all user-defined scripts.
ScriptIntrinsic	Base class for all Intrinsic scripts.

Known Indirect Subclasses

ScriptIntrinsic3DLUT, ScriptIntrinsicBLAS, ScriptIntrinsicBlend, ScriptIntrinsicBlur, ScriptIntrinsicColorMatrix, ScriptIntrinsicConvolve3x3, ScriptIntrinsicConvolve5x5, ScriptIntrinsicHistogram, ScriptIntrinsicLUT, ScriptIntrinsicResize, ScriptIntrinsicYuvToRGB

ScriptIntrinsic3DLUT	Intrinsic for converting RGB to RGBA by using a 3D lookup table.
ScriptIntrinsicBLAS	ScriptIntrinsicBLAS class provides high performance RenderScript APIs to BLAS.
ScriptIntrinsicBlend	Intrinsic kernels for blending two `android.renderscript.Allocation` objects.
ScriptIntrinsicBlur	Intrinsic Gausian blur filter.
ScriptIntrinsicColorMatrix	Intrinsic for applying a color matrix to allocations.
ScriptIntrinsicConvolve3x3	Intrinsic for applying a 3x3 convolve to an allocation.
ScriptIntrinsicConvolve5x5	Intrinsic for applying a 5x5 convolve to an allocation.
ScriptIntrinsicHistogram	Intrinsic Histogram filter.
ScriptIntrinsicLUT	Intrinsic for applying a per-channel lookup table.
ScriptIntrinsicResize	Intrinsic for performing a resize of a 2D allocation.
ScriptIntrinsicYuvToRGB	Intrinsic for converting an Android YUV buffer to RGB.

The parent class for all executable scripts. This should not be used by applications.

Summary

Nested classes
open	`Builder` Only intended for use by generated reflected code.
open	`FieldBase` Only intended for use by generated reflected code.
	`FieldID` FieldID is an identifier for a Script + exported field pair.
	`InvokeID` InvokeID is an identifier for an invoke function.
	`KernelID` KernelID is an identifier for a Script + root function pair.
	`LaunchOptions` Class for specifying the specifics about how a kernel will be launched.

Public methods
open Unit	`bindAllocation(va: Allocation!, slot: Int)` Only intended for use by generated reflected code.
open Boolean	`getVarB(index: Int)`
open Double	`getVarD(index: Int)`
open Float	`getVarF(index: Int)`
open Int	`getVarI(index: Int)`
open Long	`getVarJ(index: Int)`
open Unit	`getVarV(index: Int, v: FieldPacker!)` Only intended for use by generated reflected code.
open Unit	`setTimeZone(timeZone: String!)`
open Unit	`setVar(index: Int, v: Float)` Only intended for use by generated reflected code.
open Unit	`setVar(index: Int, v: Double)` Only intended for use by generated reflected code.
open Unit	`setVar(index: Int, v: Int)` Only intended for use by generated reflected code.
open Unit	`setVar(index: Int, v: Long)` Only intended for use by generated reflected code.
open Unit	`setVar(index: Int, v: Boolean)` Only intended for use by generated reflected code.
open Unit	`setVar(index: Int, o: BaseObj!)` Only intended for use by generated reflected code.
open Unit	`setVar(index: Int, v: FieldPacker!)` Only intended for use by generated reflected code.
open Unit	`setVar(index: Int, v: FieldPacker!, e: Element!, dims: IntArray!)` Only intended for use by generated reflected code.

Protected methods
open Script.FieldID!	`createFieldID(slot: Int, e: Element!)` Only to be used by generated reflected classes.
open Script.InvokeID!	`createInvokeID(slot: Int)` Only to be used by generated reflected classes.
open Script.KernelID!	`createKernelID(slot: Int, sig: Int, ein: Element!, eout: Element!)` Only to be used by generated reflected classes.
open Unit	`forEach(slot: Int, ain: Allocation!, aout: Allocation!, v: FieldPacker!)` Only intended for use by generated reflected code.
open Unit	`forEach(slot: Int, ain: Allocation!, aout: Allocation!, v: FieldPacker!, sc: Script.LaunchOptions!)` Only intended for use by generated reflected code.
open Unit	`forEach(slot: Int, ains: Array<Allocation!>!, aout: Allocation!, v: FieldPacker!)` Only intended for use by generated reflected code.
open Unit	`forEach(slot: Int, ains: Array<Allocation!>!, aout: Allocation!, v: FieldPacker!, sc: Script.LaunchOptions!)` Only intended for use by generated reflected code.
open Unit	`invoke(slot: Int)` Only intended for use by generated reflected code.
open Unit	`invoke(slot: Int, v: FieldPacker!)` Only intended for use by generated reflected code.
open Unit	`reduce(slot: Int, ains: Array<Allocation!>!, aout: Allocation!, sc: Script.LaunchOptions!)` Only intended for use by generated reflected code.

Inherited functions

From class BaseObj

`Unit`	`destroy()` Frees any native resources associated with this object. The primary use is to force immediate cleanup of resources when it is believed the GC will not respond quickly enough.
`Boolean`	`equals(other: Any?)` Compare the current BaseObj with another BaseObj for equality.
`Unit`	`finalize()`
`String!`	`getName()`
`Int`	`hashCode()` Calculates the hash code value for a BaseObj.
`Unit`	`setName(name: String!)` setName assigns a name to an object. This object can later be looked up by this name.

Public methods

bindAllocation

Added in API level 11

open fun bindAllocation(
    va: Allocation!, 
    slot: Int
): Unit

Only intended for use by generated reflected code.

getVarB

Added in API level 18

open fun getVarB(index: Int): Boolean

getVarD

Added in API level 18

open fun getVarD(index: Int): Double

getVarF

Added in API level 18

open fun getVarF(index: Int): Float

getVarI

Added in API level 18

open fun getVarI(index: Int): Int

getVarJ

Added in API level 18

open fun getVarJ(index: Int): Long

getVarV

Added in API level 18

open fun getVarV(
    index: Int, 
    v: FieldPacker!
): Unit

Only intended for use by generated reflected code.

setTimeZone

Added in API level 11

open fun setTimeZone(timeZone: String!): Unit

setVar

Added in API level 11

open fun setVar(
    index: Int, 
    v: Float
): Unit

Only intended for use by generated reflected code.

setVar

Added in API level 11

open fun setVar(
    index: Int, 
    v: Double
): Unit

Only intended for use by generated reflected code.

setVar

Added in API level 11

open fun setVar(
    index: Int, 
    v: Int
): Unit

Only intended for use by generated reflected code.

setVar

Added in API level 11

open fun setVar(
    index: Int, 
    v: Long
): Unit

Only intended for use by generated reflected code.

setVar

Added in API level 11

open fun setVar(
    index: Int, 
    v: Boolean
): Unit

Only intended for use by generated reflected code.

setVar

Added in API level 11

open fun setVar(
    index: Int, 
    o: BaseObj!
): Unit

Only intended for use by generated reflected code.

setVar

Added in API level 11

open fun setVar(
    index: Int, 
    v: FieldPacker!
): Unit

Only intended for use by generated reflected code.

setVar

Added in API level 16

open fun setVar(
    index: Int, 
    v: FieldPacker!, 
    e: Element!, 
    dims: IntArray!
): Unit

Only intended for use by generated reflected code.

Protected methods

createFieldID

Added in API level 17

protected open fun createFieldID(
    slot: Int, 
    e: Element!
): Script.FieldID!

Only to be used by generated reflected classes.

createInvokeID

Added in API level 23

protected open fun createInvokeID(slot: Int): Script.InvokeID!

Only to be used by generated reflected classes.

createKernelID

Added in API level 17

protected open fun createKernelID(
    slot: Int, 
    sig: Int, 
    ein: Element!, 
    eout: Element!
): Script.KernelID!

Only to be used by generated reflected classes.

forEach

Added in API level 14

protected open fun forEach(
    slot: Int, 
    ain: Allocation!, 
    aout: Allocation!, 
    v: FieldPacker!
): Unit

Only intended for use by generated reflected code.

forEach

Added in API level 18

protected open fun forEach(
    slot: Int, 
    ain: Allocation!, 
    aout: Allocation!, 
    v: FieldPacker!, 
    sc: Script.LaunchOptions!
): Unit

Only intended for use by generated reflected code.

forEach

Added in API level 23

protected open fun forEach(
    slot: Int, 
    ains: Array<Allocation!>!, 
    aout: Allocation!, 
    v: FieldPacker!
): Unit

Only intended for use by generated reflected code.

forEach

Added in API level 23

protected open fun forEach(
    slot: Int, 
    ains: Array<Allocation!>!, 
    aout: Allocation!, 
    v: FieldPacker!, 
    sc: Script.LaunchOptions!
): Unit

Only intended for use by generated reflected code.

invoke

Added in API level 11

protected open fun invoke(slot: Int): Unit

Only intended for use by generated reflected code.

invoke

Added in API level 11

protected open fun invoke(
    slot: Int, 
    v: FieldPacker!
): Unit

Only intended for use by generated reflected code.

reduce

Added in API level 24

protected open fun reduce(
    slot: Int, 
    ains: Array<Allocation!>!, 
    aout: Allocation!, 
    sc: Script.LaunchOptions!
): Unit

Only intended for use by generated reflected code. (General reduction)