Home Original page

Script  |  API reference  |  Android Developers

public class Script
extends BaseObj

Known direct subclasses

ScriptC This class was deprecated in API level 31. Renderscript has been deprecated in API level 31. Please refer to the migration guide for the proposed alternatives. 
ScriptIntrinsic This class was deprecated in API level 31. Renderscript has been deprecated in API level 31. Please refer to the migration guide for the proposed alternatives. 

This class was deprecated in API level 31.
Renderscript has been deprecated in API level 31. Please refer to the migration guide for the proposed alternatives.

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

Summary

Nested classes

class Script.Builder

Only intended for use by generated reflected code. 

class Script.FieldBase

Only intended for use by generated reflected code. 

class Script.FieldID

FieldID is an identifier for a Script + exported field pair. 

class Script.InvokeID

InvokeID is an identifier for an invoke function. 

class Script.KernelID

KernelID is an identifier for a Script + root function pair. 

class Script.LaunchOptions

Class for specifying the specifics about how a kernel will be launched. 

Public methods

void bindAllocation(Allocation va, int slot)

Only intended for use by generated reflected code.

boolean getVarB(int index)
double getVarD(int index)
float getVarF(int index)
int getVarI(int index)
long getVarJ(int index)
void getVarV(int index, FieldPacker v)

Only intended for use by generated reflected code.

void setTimeZone(String timeZone)
void setVar(int index, boolean v)

Only intended for use by generated reflected code.

void setVar(int index, int v)

Only intended for use by generated reflected code.

void setVar(int index, FieldPacker v, Element e, int[] dims)

Only intended for use by generated reflected code.

void setVar(int index, FieldPacker v)

Only intended for use by generated reflected code.

void setVar(int index, float v)

Only intended for use by generated reflected code.

void setVar(int index, double v)

Only intended for use by generated reflected code.

void setVar(int index, long v)

Only intended for use by generated reflected code.

void setVar(int index, BaseObj o)

Only intended for use by generated reflected code.

Protected methods

Script.FieldID createFieldID(int slot, Element e)

Only to be used by generated reflected classes.

Script.InvokeID createInvokeID(int slot)

Only to be used by generated reflected classes.

Script.KernelID createKernelID(int slot, int sig, Element ein, Element eout)

Only to be used by generated reflected classes.

void forEach(int slot, Allocation[] ains, Allocation aout, FieldPacker v)

Only intended for use by generated reflected code.

void forEach(int slot, Allocation ain, Allocation aout, FieldPacker v, Script.LaunchOptions sc)

Only intended for use by generated reflected code.

void forEach(int slot, Allocation ain, Allocation aout, FieldPacker v)

Only intended for use by generated reflected code.

void forEach(int slot, Allocation[] ains, Allocation aout, FieldPacker v, Script.LaunchOptions sc)

Only intended for use by generated reflected code.

void invoke(int slot)

Only intended for use by generated reflected code.

void invoke(int slot, FieldPacker v)

Only intended for use by generated reflected code.

void reduce(int slot, Allocation[] ains, Allocation aout, Script.LaunchOptions sc)

Only intended for use by generated reflected code.

Inherited methods

From class android.renderscript.BaseObj

void destroy()

Frees any native resources associated with this object.

boolean equals(Object obj)

Compare the current BaseObj with another BaseObj for equality.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

String getName()
int hashCode()

Calculates the hash code value for a BaseObj.

void setName(String name)

setName assigns a name to an object.

From class java.lang.Object

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(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(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()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

bindAllocation

Added in API level 11 

public void bindAllocation (Allocation va, 
                int slot)

Only intended for use by generated reflected code.

Parameters
va Allocation
slot int

getVarB

Added in API level 18
Deprecated in API level 31 

public boolean getVarB (int index)
Parameters
index int
Returns
boolean

getVarD

Added in API level 18
Deprecated in API level 31 

public double getVarD (int index)
Parameters
index int
Returns
double

getVarF

Added in API level 18
Deprecated in API level 31 

public float getVarF (int index)
Parameters
index int
Returns
float

getVarI

Added in API level 18
Deprecated in API level 31 

public int getVarI (int index)
Parameters
index int
Returns
int

getVarJ

Added in API level 18
Deprecated in API level 31 

public long getVarJ (int index)
Parameters
index int
Returns
long

getVarV

Added in API level 18
Deprecated in API level 31 

public void getVarV (int index, 
                FieldPacker v)

Only intended for use by generated reflected code.

Parameters
index int
v FieldPacker

setTimeZone

Added in API level 11 

public void setTimeZone (String timeZone)
Parameters
timeZone String

setVar

Added in API level 11 

public void setVar (int index, 
                boolean v)

Only intended for use by generated reflected code.

Parameters
index int
v boolean

setVar

Added in API level 11 

public void setVar (int index, 
                int v)

Only intended for use by generated reflected code.

Parameters
index int
v int

setVar

Added in API level 16
Deprecated in API level 31 

public void setVar (int index, 
                FieldPacker v, 
                Element e, 
                int[] dims)

Only intended for use by generated reflected code.

Parameters
index int
v FieldPacker
e Element
dims int

setVar

Added in API level 11 

public void setVar (int index, 
                FieldPacker v)

Only intended for use by generated reflected code.

Parameters
index int
v FieldPacker

setVar

Added in API level 11 

public void setVar (int index, 
                float v)

Only intended for use by generated reflected code.

Parameters
index int
v float

setVar

Added in API level 11 

public void setVar (int index, 
                double v)

Only intended for use by generated reflected code.

Parameters
index int
v double

setVar

Added in API level 11 

public void setVar (int index, 
                long v)

Only intended for use by generated reflected code.

Parameters
index int
v long

setVar

Added in API level 11 

public void setVar (int index, 
                BaseObj o)

Only intended for use by generated reflected code.

Parameters
index int
o BaseObj

Protected methods

createFieldID

Added in API level 17
Deprecated in API level 31 

protected Script.FieldID createFieldID (int slot, 
                Element e)

Only to be used by generated reflected classes.

Parameters
slot int
e Element
Returns
Script.FieldID

createInvokeID

Added in API level 23
Deprecated in API level 31 

protected Script.InvokeID createInvokeID (int slot)

Only to be used by generated reflected classes.

Parameters
slot int
Returns
Script.InvokeID

createKernelID

Added in API level 17
Deprecated in API level 31 

protected Script.KernelID createKernelID (int slot, 
                int sig, 
                Element ein, 
                Element eout)

Only to be used by generated reflected classes.

Parameters
slot int
sig int
ein Element
eout Element
Returns
Script.KernelID

forEach

Added in API level 23
Deprecated in API level 31 

protected void forEach (int slot, 
                Allocation[] ains, 
                Allocation aout, 
                FieldPacker v)

Only intended for use by generated reflected code.

Parameters
slot int
ains Allocation
aout Allocation
v FieldPacker

forEach

Added in API level 18
Deprecated in API level 31 

protected void forEach (int slot, 
                Allocation ain, 
                Allocation aout, 
                FieldPacker v, 
                Script.LaunchOptions sc)

Only intended for use by generated reflected code.

Parameters
slot int
ain Allocation
aout Allocation
v FieldPacker
sc Script.LaunchOptions

forEach

Added in API level 14
Deprecated in API level 31 

protected void forEach (int slot, 
                Allocation ain, 
                Allocation aout, 
                FieldPacker v)

Only intended for use by generated reflected code.

Parameters
slot int
ain Allocation
aout Allocation
v FieldPacker

forEach

Added in API level 23
Deprecated in API level 31 

protected void forEach (int slot, 
                Allocation[] ains, 
                Allocation aout, 
                FieldPacker v, 
                Script.LaunchOptions sc)

Only intended for use by generated reflected code.

Parameters
slot int
ains Allocation
aout Allocation
v FieldPacker
sc Script.LaunchOptions

invoke

Added in API level 11 

protected void invoke (int slot)

Only intended for use by generated reflected code.

Parameters
slot int

invoke

Added in API level 11 

protected void invoke (int slot, 
                FieldPacker v)

Only intended for use by generated reflected code.

Parameters
slot int
v FieldPacker

reduce

Added in API level 24
Deprecated in API level 31 

protected void reduce (int slot, 
                Allocation[] ains, 
                Allocation aout, 
                Script.LaunchOptions sc)

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

Parameters
slot int
ains Allocation
aout Allocation
sc Script.LaunchOptions