Added in API level 17
Deprecated in API level 31

Summary: Nested Classes | Methods | Inherited Methods

ScriptGroup

---

Kotlin |Java

public final class ScriptGroup
extends BaseObj

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

---

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.

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 Builder2 instead.
class	ScriptGroup.Builder2 The builder class for creating script groups A script group is created using closures (see class 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 Builder2#addInput method.

Public methods
void	destroy() Destroy this ScriptGroup and all Closures in it
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(java.lang.Object) instead.
void	setOutput(Script.KernelID s, Allocation a) This method was deprecated in API level 23. Use return value of execute(java.lang.Object) instead.

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

destroy

Added in API level 17

public void destroy ()

Destroy this ScriptGroup and all Closures in it

execute

Added in API level 23
Deprecated in API level 31

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

Executes a script group

Parameters
inputs	Object: Values for inputs to the script group, in the order as the inputs are added via Builder2#addInput.

Returns
Object[]	Outputs of the script group as an array of objects, in the order as futures are passed to Builder2#create.

execute

Added in API level 17
Deprecated in API level 23

public void execute ()

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.

setInput

Added in API level 17
Deprecated in API level 23

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

This method was deprecated in API level 23.
Set arguments to execute(java.lang.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	Script.KernelID: The ID of the kernel where the allocation should be connected.
a	Allocation: The allocation to connect.

setOutput

Added in API level 17
Deprecated in API level 23

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

This method was deprecated in API level 23.
Use return value of execute(java.lang.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	Script.KernelID: The ID of the kernel where the allocation should be connected.
a	Allocation: The allocation to connect.