Added in API level 11
Deprecated in API level 31

RenderScript

open class RenderScript
kotlin.Any
   ↳ android.renderscript.RenderScript

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.

Summary

Nested classes

ContextType specifies the specific type of context to be created.

RenderScript worker thread priority enumeration.
open

The runtime error handler base class.
open

The base class from which an application should derive in order to receive RS messages from scripts.
Constants
static Int

static Int

static Int

Public methods
open Unit

Print the currently available debugging information about the state of the RS context to the log.
open static RenderScript!
create(ctx: Context!)

calls create(ctx, ContextType.NORMAL, CREATE_FLAG_NONE) See documentation for @create for details
open static RenderScript!

calls create(ctx, ct, CREATE_FLAG_NONE) See documentation for @create for details
open static RenderScript!
create(ctx: Context!, ct: RenderScript.ContextType!, flags: Int)

Gets or creates a RenderScript context of the specified type.
open static RenderScript!
createMultiContext(ctx: Context!, ct: RenderScript.ContextType!, flags: Int, API_number: Int)

Create a RenderScript context.
open Unit

Destroys this RenderScript context.
open Unit

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

Gets the application context associated with the RenderScript context.
open RenderScript.RSErrorHandler!

open RenderScript.RSMessageHandler!

open static Long

Returns an identifier that can be used to identify a particular minor version of RS.
open static Unit

Releases all the process contexts.
open Unit
sendMessage(id: Int, data: IntArray!)

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

open Unit

open Unit

Change the priority of the worker threads for this context.
Protected methods
open Unit

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Constants

CREATE_FLAG_LOW_LATENCY

Added in API level 21
Deprecated in API level 31
static val CREATE_FLAG_LOW_LATENCY: Int

Deprecated: Deprecated in Java. 

Value: 2

CREATE_FLAG_LOW_POWER

Added in API level 21
Deprecated in API level 31
static val CREATE_FLAG_LOW_POWER: Int

Deprecated: Deprecated in Java. 

Value: 4

CREATE_FLAG_NONE

Added in API level 21
Deprecated in API level 31
static val CREATE_FLAG_NONE: Int

Deprecated: Deprecated in Java. 

Value: 0

Public methods

contextDump

Added in API level 11
open fun contextDump(): Unit

Deprecated: Deprecated in Java.

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

create

Added in API level 11
open static fun create(ctx: Context!): RenderScript!

Deprecated: Deprecated in Java.

calls create(ctx, ContextType.NORMAL, CREATE_FLAG_NONE) See documentation for @create for details

Parameters
ctx Context!: The context.
Return
RenderScript! RenderScript

create

Added in API level 18
Deprecated in API level 31
open static fun create(
    ctx: Context!, 
    ct: RenderScript.ContextType!
): RenderScript!

Deprecated: Deprecated in Java.

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

Parameters
ctx Context!: The context.
ct RenderScript.ContextType!: The type of context to be created.
Return
RenderScript! RenderScript

create

Added in API level 21
Deprecated in API level 31
open static fun create(
    ctx: Context!, 
    ct: RenderScript.ContextType!, 
    flags: Int
): RenderScript!

Deprecated: Deprecated in Java.

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. Prior to API 23 this always created a new context.

Parameters
ctx Context!: The context.
ct RenderScript.ContextType!: The type of context to be created.
flags Int: The OR of the CREATE_FLAG_* options desired
Return
RenderScript! RenderScript

createMultiContext

Added in API level 23
Deprecated in API level 31
open static fun createMultiContext(
    ctx: Context!, 
    ct: RenderScript.ContextType!, 
    flags: Int, 
    API_number: Int
): RenderScript!

Deprecated: Deprecated in Java.

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 Context!: The context.
Return
RenderScript! RenderScript

destroy

Added in API level 11
open fun destroy(): Unit

Deprecated: Deprecated in Java.

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

finish

Added in API level 11
open fun finish(): Unit

Deprecated: Deprecated in Java.

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

getApplicationContext

Added in API level 11
fun getApplicationContext(): Context!

Deprecated: Deprecated in Java.

Gets the application context associated with the RenderScript context.

Return
Context! The application context.

getErrorHandler

Added in API level 11
open fun getErrorHandler(): RenderScript.RSErrorHandler!

Deprecated: Deprecated in Java.

getMessageHandler

Added in API level 11
open fun getMessageHandler(): RenderScript.RSMessageHandler!

Deprecated: Deprecated in Java.

getMinorVersion

Added in API level 23
Deprecated in API level 31
open static fun getMinorVersion(): Long

Deprecated: Deprecated in Java.

Returns an identifier that can be used to identify a particular minor version of RS.

Return
Long The minor RenderScript version number

releaseAllContexts

Added in API level 23
Deprecated in API level 31
open static fun releaseAllContexts(): Unit

Deprecated: Deprecated in Java.

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()

sendMessage

Added in API level 18
Deprecated in API level 31
open fun sendMessage(
    id: Int, 
    data: IntArray!
): Unit

Deprecated: Deprecated in Java.

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

Parameters
id Int:
data IntArray!:

setErrorHandler

Added in API level 11
open fun setErrorHandler(msg: RenderScript.RSErrorHandler!): Unit

Deprecated: Deprecated in Java.

setMessageHandler

Added in API level 11
open fun setMessageHandler(msg: RenderScript.RSMessageHandler!): Unit

Deprecated: Deprecated in Java.

setPriority

Added in API level 11
open fun setPriority(p: RenderScript.Priority!): Unit

Deprecated: Deprecated in Java.

Change the priority of the worker threads for this context.

Parameters
p RenderScript.Priority!: New priority to be set.

Protected methods

finalize

Added in API level 11
protected open fun finalize(): Unit

Deprecated: Deprecated in Java.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Exceptions
java.lang.Throwable the Exception raised by this method