RenderScript - Android SDK

Summary: Nested Classes | Constants | Methods | Inherited Methods | [Expand All]

public class

RenderScript

extends Object

java.lang.Object
↳	android.support.v8.renderscript.RenderScript

Class Overview

This class provides access to a RenderScript context, which controls RenderScript initialization, resource management, and teardown. An instance of the RenderScript class must be created before any other RS objects can be created.

Developer Guides

For more information about creating an application that uses RenderScript, read the RenderScript developer guide.

Summary

Nested Classes
enum	RenderScript.ContextType	ContextType specifies the specific type of context to be created.
enum	RenderScript.Priority	RenderScript worker thread priority enumeration.
class	RenderScript.RSErrorHandler	The runtime error handler base class.
class	RenderScript.RSMessageHandler	The base class from which an application should derive in order to receive RS messages from scripts.

Constants
int	CREATE_FLAG_NONE

Public Methods
void	contextDump() Print the currently available debugging information about the state of the RS context to the log.
static RenderScript	create(Context ctx, RenderScript.ContextType ct) calls create(ctx, ct, CREATE_FLAG_NONE) See documentation for @create for details
static RenderScript	create(Context ctx) Create a RenderScript context.
static RenderScript	create(Context ctx, int sdkVersion, RenderScript.ContextType ct, int flags) Gets or creates a RenderScript context of the specified type.
static RenderScript	create(Context ctx, RenderScript.ContextType ct, int flags) Gets or creates a RenderScript context of the specified type.
static RenderScript	createMultiContext(Context ctx, RenderScript.ContextType ct, int flags, int API_number) Create a RenderScript context.
void	destroy() Destroys this RenderScript context.
void	finish() Wait for any pending asynchronous opeations (such as copies to a RS allocation or RS script executions) to complete.
static void	forceCompat() Force using support lib runtime.
final Context	getApplicationContext() Gets the application context associated with the RenderScript context.
RenderScript.RSErrorHandler	getErrorHandler()
RenderScript.RSMessageHandler	getMessageHandler()
static void	releaseAllContexts() Releases all the process contexts.
void	sendMessage(int id, int[] data) Place a message into the message queue to be sent back to the message handler once all previous commands have been executed.
static void	setBlackList(String blackList) Sets the blackList of Models to only use support lib runtime.
void	setErrorHandler(RenderScript.RSErrorHandler msg)
void	setMessageHandler(RenderScript.RSMessageHandler msg)
void	setPriority(RenderScript.Priority p) Change the priority of the worker threads for this context.

[Expand]

Inherited Methods

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.

Constants

public static final int CREATE_FLAG_NONE

Constant Value: 0 (0x00000000)

Public Methods

public void contextDump ()

Print the currently available debugging information about the state of the RS context to the log.

public static RenderScript create (Context ctx, RenderScript.ContextType ct)

calls create(ctx, ct, CREATE_FLAG_NONE) See documentation for @create for details

Parameters

ctx	The context.
ct	The type of context to be created.

Returns

RenderScript

public static RenderScript create (Context ctx)

Create a RenderScript context. See documentation for @create for details

Parameters

ctx	The context.

Returns

RenderScript

public static RenderScript create (Context ctx, int sdkVersion, RenderScript.ContextType ct, int flags)

Gets or creates a RenderScript context of the specified type.

Parameters

ctx	The context.
sdkVersion	The target SDK Version.
ct	The type of context to be created.
flags	The OR of the CREATE_FLAG_* options desired

Returns

RenderScript

public static RenderScript create (Context ctx, RenderScript.ContextType ct, int flags)

Gets or creates a RenderScript context of the specified type. The returned context will be cached for future reuse within the process. When an application is finished using RenderScript it should call releaseAllContexts() A process context is a context designed for easy creation and lifecycle management. Multiple calls to this function will return the same object provided they are called with the same options. This allows it to be used any time a RenderScript context is needed.

Parameters

ctx	The context.
ct	The type of context to be created.
flags	The OR of the CREATE_FLAG_* options desired

Returns

RenderScript

public static RenderScript createMultiContext (Context ctx, RenderScript.ContextType ct, int flags, int API_number)

Create a RenderScript context. This is an advanced function intended for applications which need to create more than one RenderScript context to be used at the same time. If you need a single context please use create()

Parameters

ctx	The context.

Returns

RenderScript

public void destroy ()

Destroys this RenderScript context. Once this function is called, using this context or any objects belonging to this context is illegal. This function is a NOP if the context was created with create(). Please use releaseAllContexts() to clean up contexts created with the create function.

public void finish ()

Wait for any pending asynchronous opeations (such as copies to a RS allocation or RS script executions) to complete.

public static void forceCompat ()

Force using support lib runtime. Should be used before context create.

public final Context getApplicationContext ()

Gets the application context associated with the RenderScript context.

Returns

The application context.

public RenderScript.RSErrorHandler getErrorHandler ()

public RenderScript.RSMessageHandler getMessageHandler ()

public static void releaseAllContexts ()

Releases all the process contexts. This is the same as calling .destroy() on each unique context retreived with create(...). If no contexts have been created this function does nothing. Typically you call this when your application is losing focus and will not be using a context for some time. This has no effect on a context created with createMultiContext()

public void sendMessage (int id, int[] data)

Place a message into the message queue to be sent back to the message handler once all previous commands have been executed.

public static void setBlackList (String blackList)

Sets the blackList of Models to only use support lib runtime. Should be used before context create.

Parameters

blackList	User provided black list string. Format: "(MANUFACTURER1:PRODUCT1:MODEL1), (MANUFACTURER2:PRODUCT2:MODEL2)..." e.g. : To Blacklist Nexus 7(2013) and Nexus 5. mBlackList = "(asus:razor:Nexus 7), (LGE:hammerhead:Nexus 5)";

public void setErrorHandler (RenderScript.RSErrorHandler msg)

public void setMessageHandler (RenderScript.RSMessageHandler msg)

public void setPriority (RenderScript.Priority p)

Change the priority of the worker threads for this context.

Parameters

p	New priority to be set.

Results

Classes

Enums

Exceptions

RenderScript

Class Overview

Developer Guides

Summary

Constants

public static final int CREATE_FLAG_NONE

Public Methods

public void contextDump ()

public static RenderScript create (Context ctx, RenderScript.ContextType ct)

Parameters

Returns

public static RenderScript create (Context ctx)

Parameters

Returns

public static RenderScript create (Context ctx, int sdkVersion, RenderScript.ContextType ct, int flags)

Parameters

Returns

public static RenderScript create (Context ctx, RenderScript.ContextType ct, int flags)

Parameters

Returns

public static RenderScript createMultiContext (Context ctx, RenderScript.ContextType ct, int flags, int API_number)

Parameters

Returns

public void destroy ()

public void finish ()

public static void forceCompat ()

public final Context getApplicationContext ()

Returns

public RenderScript.RSErrorHandler getErrorHandler ()

public RenderScript.RSMessageHandler getMessageHandler ()

public static void releaseAllContexts ()

public void sendMessage (int id, int[] data)

public static void setBlackList (String blackList)

Parameters

public void setErrorHandler (RenderScript.RSErrorHandler msg)

public void setMessageHandler (RenderScript.RSMessageHandler msg)

public void setPriority (RenderScript.Priority p)

Parameters