Script | API reference | Android Developers

open class Script : BaseObj

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, 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.
open Unit	`setVar(index: Int, v: Boolean)` 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: Float)` 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.

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()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the `finalize` method to dispose of system resources or to perform other cleanup. The general contract of `finalize` is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The `finalize` method may take any action, including making this object available again to other threads; the usual purpose of `finalize`, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded. The `finalize` method of class `Object` performs no special action; it simply returns normally. Subclasses of `Object` may override this definition. The Java programming language does not guarantee which thread will invoke the `finalize` method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates. After the `finalize` method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded. The `finalize` method is never invoked more than once by a Java virtual machine for any given object. Any exception thrown by the `finalize` method causes the finalization of this object to be halted, but is otherwise ignored.
`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.