IContext

TODO:Do we need to define "selectors"? It may be a property of the "adapted allocation" that's returned.

Creates an arbitrary window into the base allocation.The type describes the shape of the window.Any dimensions present in the type must be equal to or smaller than the dimensions in the source allocation.A dimension present in the allocation that is not present in the type must be constrained away with the selectors.If a dimension is present in both the type and allocation, one of two things must happen.If the type is smaller than the allocation, a window must be created, the selected value in the adapter for that dimension must act as the base address, and the type must describe the size of the view starting at that point.If the type and allocation dimension are of the same size, then setting the selector for the dimension must be an error.

TODO:Need to relate "offset" back to the terminology in allocationAdapterCreate() -- the latter uses the terms "selector" and "selected value".Can we use consistent terminology? Are "offset" and "selector" actually two different things?

TODO:Explain the flattened layout in the offsets vec

Sets the offsets for an Allocation Adapter.

TODO:add more explanation here.

Returns the Type of the Allocation.

TODO:more clarification needed describing if the pointer can be aliased or if the data can outlive the allocation.

Creates an Allocation for use by scripts with a given Type and a backing pointer.For use with ALLOCATION_USAGE_SHARED.

Creates an Allocation from a Bitmap.

Creates a Cubemapped Allocation from a Bitmap.

Returns the handle to a raw buffer that is being managed by the screen compositor.This operation is only valid for Allocations with USAGE_IO_INPUT.

TODO:more clarification needed

Sets the NativeWindow of an Allocation.This operation is only valid for Allocations with USAGE_IO_INPUT.

Initialize BufferQueue with specified max number of buffers.

TODO:clearly define baseAlloc vs subAlloc

Shares the BufferQueue with another Allocation.Both must be USAGE_IO_INPUT Allocations.

Copies from the Allocation into a Bitmap.The bitmap must match the dimensions of the Allocation.

HIDL is always running in Passthrough mode for RenderScript, so the buffer is modified directly by the driver.

TODO:should we consolidate all[123]DWrite functions or[123]DRead functions into the same API call? Our current plan is to be very similar to the dispatch table API.How much should we deviate from the original API? TODO:better description on Vec3/Vec4 and padding.

Copies data into a 1D region of this Allocation.

When this HAL entry is executed, all Vec3 elements have been explicitly padded as Vec4 elements.

The size of the region is:count * Element's size.

Copies a value into a single sub-Element of this Allocation.

Copies from an array into a rectangular region in this Allocation.

When this HAL entry is executed, all Vec3 elements have been explicitly padded as Vec4 elements.

The size of the region is:w * h * Element's size.

Copies from an array into a 3D region in this Allocation.

When this HAL entry is executed, all Vec3 elements have been explicitly padded as Vec4 elements.

The size of the region is:w * h * d * Element's size.

Generates a mipmap chain.This is only valid if the Type of the Allocation includes mipmaps.

This function generates a complete set of mipmaps from the top level LOD.

If the Allocation is also using other memory spaces, a call to allocationSyncAll(context, allocation, usage)is required.

Copies all of an Allocation's data into an array.

All Vec3 elements of an Allocation are padded to be Vec4, so the data returned by this function automatically includes padding.

HIDL is always running in Passthrough mode for RenderScript, so the buffer is modified directly by the driver.

Copies a 1D region of this Allocation into an array.

All Vec3 elements of an Allocation are padded to be Vec4, so the data returned by this function automatically includes padding.

The size of the region is:count * Element's size.

HIDL is always running in Passthrough mode for RenderScript, so the buffer is modified directly by the driver.

Returns the value of a single sub-Element of this Allocation.

HIDL is always running in Passthrough mode for RenderScript, so the buffer is modified directly by the driver.

Copies from a rectangular region in this Allocation to an array.

All Vec3 elements of an Allocation are padded to be Vec4, so the data returned by this function automatically includes padding.

The size of the region is:w * h * Element's size.

HIDL is always running in Passthrough mode for RenderScript, so the buffer is modified directly by the driver.

Copies from a rectangular cuboid region in this Allocation to an array.

All Vec3 elements of an Allocation are padded to be Vec4, so the data returned by this function automatically includes padding.

The size of the region is:w * h * d * Element's size.

HIDL is always running in Passthrough mode for RenderScript, so the buffer is modified directly by the driver.

Propagates changes from one usage of the Allocation to the other usages of the Allocation.

TODO:describe the functionality of resize1D better TODO:original Java Doc description seems to contradict itself("with null contents and the region is otherwise undefined")TODO:should "new elements" be "new cells"? TODO:what does "objects are created" mean? TODO:what does "new dimension" mean? IS the type of the resized allocation different than the type before resizing?

Resizes a 1D allocation.The contents of the allocation are preserved.If new elements are allocated, objects are created with null contents and the new region is otherwise undefined.

If the new region is smaller, the references of any object outside the new region must be released.

A new type must be created with the new dimension.

TODO:There are allocationCopy2DRange and 3DRange, but no 1DRange.Should the interface be cleaned up more?

Copies a rectangular region from an Allocation into a rectangular region in this Allocation.

Copies a rectangular cuboid region into the allocation from another Allocation.

TODO:define buffer and output stream

Sends a buffer to the output stream.The contents of the Allocation may be undefined after this operation.This operation is only valid if USAGE_IO_OUTPUT is set on the Allocation.

Receives the latest input into the Allocation.This operation is only valid if USAGE_IO_INPUT is set on the Allocation, otherwise an error must be reported and no operations may be executed.

TODO:describe default values for lod, face, and z better.TODO:what cases can invalidate the pointer? Resize? It should be clarified that this method should always return a valid pointer, but the returned pointer might become invalid later.

Retrieves the pointer to the actual data an Allocation contains as well as the data's stride.

If Allocation lacks the corresponding dimension for lod, face, or z, an error message must be sent to the message queue and nullptr must be returned for dataPtr and 0 for stride.All missing values must be 0 or NONE in the corresponding enum.

Retrieves an Element's metadata from native code.

TODO:define Sub-Element handles better.

Retrieves an Element's sub Elements, specifically their identifiers, names, and sizes.

TODO:can normalization flag be removed?

Creates an Element.

Creates a complex Element.

Retrives a Type's metadata from native code.

Creates a new Type.

If Type is 1D, Y and Z must be 0.If Type is 2D, Z must be 0.

Destroys provided RenderScript context, including all objects created in this context.

TODO:provide overview of messaging model and figure out if this should be part of HAL or not.TODO:what is the "client" for purposes of this interface? TODO:consider using send/receive to be more similar to other calls TODO:define the purpose of size more

Fills the provided buffer with message data."size" should be at least as large as the message size.Returns the MessageType and size of the message are returned.

TODO:define subID better.

Gets the metadata of a message to ensure entire message can be properly received.Can be used to determine size of data to allocate when calling contextGetMessage.

TODO:Define "previous commands" better TODO:Is the message identifier the same as subID?

Places a message into the message queue to be sent back to the message handler once all previous commands have been executed.The message data is copied into the queue and can be discarded by the client after this call.

TODO:Can this be done automatically as part of context creation? What happens if we perform message operations before doing this?

Initializes the messaging thread, so that the front-end API can receive messages from the driver.This call also waits for the messaging FIFO to start up.

TODO:Why doesn't this happen automatically as part of context destruction? What happens if the FIFO is not empty?

Deinitializes a the messaging thread.Shuts down the FIFO.

TODO:do we need to mark asynchronous operations in this interface definition?

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

Prints the currently available debugging information about the state of the RS context to the logcat.

TODO:full path? relative path? Investigate further.

Sets the cache directory of the context.

TODO:does this apply to the GPU as well?

Changes the priority of the cpu worker threads for this context.

TODO:does this need to be part of the HAL? What if the object already has a name?

Assigns a name to a base object.

TODO:what if the object has no name?

Returns the name of an object.

TODO:starting here we have a set of interfaces for use with ScriptGroups.At the very least we should indicate for each one that's what it's for.Should we include ScriptGroup in the interface names? TODO:sweep whole file and remove prefix "v" from all parameter names TODO:there are some places where we use Size for size, and others where we use int32_t.Is there a reason it's int32_t? In some cases, it requires a negative value.

Creates a Closure which represents a function call to a ForEach Kernel combined with arguments and values for global variables.

Creates a Closure which represents a function call to a invocable function, combined with arguments and values for global variables.

Sets the argument of a Closure at specified index and size to provided value.

Sets a global variable in a Closure.

TODO:should slot be unsigned?(applies to other two ID interfaces, too)

Creates a Script Kernel ID.

Creates a Script Invoke ID.

TODO:describe the return value better.What is it?

Creates a Script Field ID.

TODO:add more description

Creates a Script Group.

Creates a Script Group.

TODO:if SetInput/Output corresponds to the Java API setInput() and setOutput(), which are documented as deprecated in API 23, do we need to support them? Or can we fallback to the CPU when they're used? Or can't we tell whether they're used early enough to do fallback?

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.

Sets an input of the Script Group.This specifies an Allocation to be used for kernels that require an input Allocation provided from outside of the Script Group.

Executes a Script Group.

Frees any native resources associated with this object.The primary use is to force immediate cleanup of resources when it is believed the GC may not respond quickly enough.

Creates a Sampler.

Binds an Allocation to a global pointer in the Script.

TODO:is this necessary?

Sets the timezone of a Script.

TODO:can scriptInvoke be combined with scriptInvokeV?

Launches an invokable function.

Invokes a Script with values.

TODO:add documentation for params TODO:Should we rename "ScriptCall" to "LaunchOptions"?

Launches a ForEach kernel.

Launches a Reduction kernel.

Sets a Script's integer variable to a value.

Sets a Script's Object variable to a value

Sets a Script's long variable to a value.

Sets a Script's float variable to a value.

Sets a Script's double variable to a value.

Sets a Script's struct variable to a value.

TODO:Why do we have typed setters but only untyped getter?

Retrieves the value from a global variable in a script.

TODO:Is this a value to be replicated for each member of the array? Or is there a representation for each separate member?

Sets the value of a global array of structs, given the Element and dimension.

TODO:is cacheDir redundant with createCache() function? Can we remove it? TODO:define resName more clearly

Creates a RenderScript C99 kernel script.

Creates a RenderScript Intrinsic script.