ScriptGroup.Builder2
public
static
final
class
ScriptGroup.Builder2
extends Object
java.lang.Object | |
↳ | android.renderscript.ScriptGroup.Builder2 |
The builder class for creating script groups
A script group is created using closures (see class Closure
).
A closure is a function call to a kernel or
invocable function. Each function argument or global variable accessed inside
the function is bound to 1) a known value, 2) a script group input
(see class Input
), or 3) a
future (see class Future
).
A future is the output of a closure, either the return value of the
function or a global variable written by that function.
Closures are created using the addKernel(KernelID, Type, Object)
or addInvoke(InvokeID, Object)
methods.
When a closure is created, futures from previously created closures
can be used as its inputs.
External script group inputs can be used as inputs to individual closures as well.
An external script group input is created using the addInput()
method.
A script group is created by a call to the create(String, Future)
method, which
accepts an array of futures as the outputs for the script group.
Closures in a script group can be evaluated in any order as long as the following conditions are met: 1) a closure must be evaluated before any other closures that take its futures as inputs; 2) all closures added before an invoke closure must be evaluated before it; and 3) all closures added after an invoke closure must be evaluated after it. As a special case, the order that the closures are added is a legal evaluation order. However, other evaluation orders are possible, including concurrently evaluating independent closures.
Summary
Public constructors | |
---|---|
Builder2(RenderScript rs)
Returns a Builder object |
Public methods | |
---|---|
ScriptGroup.Input
|
addInput()
Adds a script group input |
ScriptGroup.Closure
|
addInvoke(Script.InvokeID invoke, Object... argsAndBindings)
Adds a closure for an invocable function |
ScriptGroup.Closure
|
addKernel(Script.KernelID k, Type returnType, Object... argsAndBindings)
Adds a closure for a kernel |
ScriptGroup
|
create(String name, Future... outputs)
Creates a script group |
Inherited methods | |
---|---|
Public constructors
Builder2
public Builder2 (RenderScript rs)
Returns a Builder object
Parameters | |
---|---|
rs |
RenderScript : the RenderScript context |
Public methods
addInput
public ScriptGroup.Input addInput ()
Adds a script group input
Returns | |
---|---|
ScriptGroup.Input |
a script group input, which can be used as an argument or a value to a global variable for creating closures |
addInvoke
public ScriptGroup.Closure addInvoke (Script.InvokeID invoke, Object... argsAndBindings)
Adds a closure for an invocable function
Parameters | |
---|---|
invoke |
Script.InvokeID : Invoke ID for the invocable function |
argsAndBindings |
Object : arguments followed by bindings for global variables |
Returns | |
---|---|
ScriptGroup.Closure |
a closure |
addKernel
public ScriptGroup.Closure addKernel (Script.KernelID k, Type returnType, Object... argsAndBindings)
Adds a closure for a kernel
Parameters | |
---|---|
k |
Script.KernelID : Kernel ID for the kernel function |
returnType |
Type |
argsAndBindings |
Object : arguments followed by bindings for global variables |
Returns | |
---|---|
ScriptGroup.Closure |
a closure |
create
public ScriptGroup create (String name, Future... outputs)
Creates a script group
Parameters | |
---|---|
name |
String : name for the script group. Legal names can only contain letters, digits,
'-', or '_'. The name can be no longer than 100 characters.
Try to use unique names, to avoid name conflicts and reduce
the cost of group creation. |
outputs |
Future : futures intended as outputs of the script group |
Returns | |
---|---|
ScriptGroup |
a script group |