Script

public class Script
extends BaseObj

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


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

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