Skip to content

Most visited

Recently visited

navigation
Added in API level 17

ScriptGroup

public final class ScriptGroup
extends BaseObj

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


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. 

Public methods

void destroy()

Destroy this ScriptGroup and all Closures in it

void execute()

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

Object[] execute(Object... inputs)

Executes a script group

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.

Inherited methods

From class android.renderscript.BaseObj
From class java.lang.Object

Public methods

destroy

Added in API level 17
void destroy ()

Destroy this ScriptGroup and all Closures in it

execute

Added in API level 17
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.

execute

Added in API level 23
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 addInput().
Returns
Object[] Outputs of the script group as an array of objects, in the order as futures are passed to create(String, ScriptGroup.Future...).

setInput

Added in API level 17
void setInput (Script.KernelID s, 
                Allocation a)

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 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
void setOutput (Script.KernelID s, 
                Allocation a)

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 Script.KernelID: The ID of the kernel where the allocation should be connected.
a Allocation: The allocation to connect.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.