ScriptGroup

Class Overview

A group of kernels that are executed together with one execution call as if they were a single kernel

In addition to kernels, a script group may contain invocable functions as well. A script group may take inputs and generate outputs, which are consumed and produced by its member kernels. Inside a script group, outputs from one kernel can be passed to another kernel as inputs. The API disallows cyclic dependencies among kernels in a script group, effectively making it a directed acyclic graph (DAG) of kernels.

Grouping kernels together allows for more efficient execution. For example, runtime and compiler optimization can be applied to reduce computation and communication overhead, and to make better use of the CPU and the GPU.

Summary

Nested Classes
class	ScriptGroup.Binding	Represents a binding of a value to a global variable in a kernel or invocable function.
class	ScriptGroup.Builder	This class was deprecated in API level 23. Use `ScriptGroup.Builder2` instead.
class	ScriptGroup.Builder2	The builder class for creating script groups A script group is created using closures (see class `ScriptGroup.Closure`).
class	ScriptGroup.Closure	An opaque class for closures A closure represents a function call to a kernel or invocable function, combined with arguments and values for global variables.
class	ScriptGroup.Future	An opaque class for futures A future represents an output of a closure, either the return value of the function, or the value of a global variable written by the function.
class	ScriptGroup.Input	An opaque class for script group inputs Created by calling the `addInput()` method.

Nested Classes

class

ScriptGroup.Binding

Represents a binding of a value to a global variable in a kernel or invocable function.

class

ScriptGroup.Builder

This class was deprecated in API level 23. Use ScriptGroup.Builder2 instead.

class

ScriptGroup.Builder2

The builder class for creating script groups

A script group is created using closures (see class ScriptGroup.Closure).

class

ScriptGroup.Closure

An opaque class for closures

A closure represents a function call to a kernel or invocable function, combined with arguments and values for global variables.

class

ScriptGroup.Future

An opaque class for futures

A future represents an output of a closure, either the return value of the function, or the value of a global variable written by the function.

class

ScriptGroup.Input

An opaque class for script group inputs

Created by calling the addInput() method.

Public Methods
Object[]	execute(Object... inputs) Executes a script group
void	execute() This method was deprecated in API level 23. Use `execute()` instead.
void	setInput(Script.KernelID s, Allocation a) This method was deprecated in API level 23. Set arguments to `execute(Object)` instead.
void	setOutput(Script.KernelID s, Allocation a) This method was deprecated in API level 23. Use return value of `execute(Object)` instead.

Public Methods

Object[]

execute(Object... inputs)

Executes a script group

void

execute()

This method was deprecated in API level 23. Use execute() instead.

void

setInput(Script.KernelID s, Allocation a)

This method was deprecated in API level 23. Set arguments to execute(Object) instead.

void

setOutput(Script.KernelID s, Allocation a)

This method was deprecated in API level 23. Use return value of execute(Object) instead.

[Expand]

Inherited Methods

From class android.renderscript.BaseObj

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public Object[] execute (Object... inputs)

Added in API level 23

Executes a script group

Parameters

inputs	Values for inputs to the script group, in the order as the inputs are added via `addInput()`.

Returns

Outputs of the script group as an array of objects, in the order as futures are passed to create(String, ScriptGroup.Future...).

public void execute ()

Added in API level 17

This method was deprecated in API level 23.
Use execute() instead.

Execute the ScriptGroup. This will run all the kernels in the ScriptGroup. No internal connection results will be visible after execution of the ScriptGroup.

public void setInput (Script.KernelID s, Allocation a)

Added in API level 17

This method was deprecated in API level 23.
Set arguments to execute(Object) instead.

Sets an input of the ScriptGroup. This specifies an Allocation to be used for kernels that require an input Allocation provided from outside of the ScriptGroup.

Parameters

s	The ID of the kernel where the allocation should be connected.
a	The allocation to connect.

public void setOutput (Script.KernelID s, Allocation a)

Added in API level 17

This method was deprecated in API level 23.
Use return value of execute(Object) instead.

Sets an output of the ScriptGroup. This specifies an Allocation to be used for the kernels that require an output Allocation visible after the ScriptGroup is executed.

Parameters

s	The ID of the kernel where the allocation should be connected.
a	The allocation to connect.

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

Results

Interfaces

Classes

Enums

Exceptions

Class Overview

Summary

Public Methods

public Object[] execute (Object... inputs)

Parameters

Returns

public void execute ()

public void setInput (Script.KernelID s, Allocation a)

Parameters

public void setOutput (Script.KernelID s, Allocation a)

Parameters