RenderScript Kernel Invocation Functions and Types

Invoke the kernel named "root" of the specified script. Like other kernels, this root() function will be invoked repeatedly over the cells of the specificed allocation, filling the output allocation with the results.

When rsForEach is called, the root script is launched immediately. rsForEach returns only when the script has completed and the output allocation is ready to use.

The rs_script argument is typically initialized using a global variable set from Java.

The kernel can be invoked with just an input allocation or just an output allocation. This can be done by defining an rs_allocation variable and not initializing it. E.g.
rs_script gCustomScript;
void specializedProcessing(rs_allocation in) {
  rs_allocation ignoredOut;
  rsForEach(gCustomScript, in, ignoredOut);
}


If both input and output allocations are specified, they must have the same dimensions.

Returns the index in the Array0 dimension of the cell being processed, as specified by the supplied kernel context.

The kernel context contains common characteristics of the allocations being iterated over and rarely used indices, like the Array0 index.

You can access the kernel context by adding a special parameter named "context" of type rs_kernel_context to your kernel function. E.g.
short RS_KERNEL myKernel(short value, uint32_t x, rs_kernel_context context) {
  // The current index in the common x, y, z dimensions are accessed by
  // adding these variables as arguments. For the more rarely used indices
  // to the other dimensions, extract them from the kernel context:
  uint32_t index_a0 = rsGetArray0(context);
  //...
}


This function returns 0 if the Array0 dimension is not present.

Returns the index in the Array1 dimension of the cell being processed, as specified by the supplied kernel context. See rsGetArray0() for an explanation of the context.

Returns 0 if the Array1 dimension is not present.

Returns the index in the Array2 dimension of the cell being processed, as specified by the supplied kernel context. See rsGetArray0() for an explanation of the context.

Returns 0 if the Array2 dimension is not present.

Returns the index in the Array3 dimension of the cell being processed, as specified by the supplied kernel context. See rsGetArray0() for an explanation of the context.

Returns 0 if the Array3 dimension is not present.

Returns the size of the Array0 dimension for the specified kernel context. See rsGetDimX() for an explanation of the context.

Returns 0 if the Array0 dimension is not present.

Returns the size of the Array1 dimension for the specified kernel context. See rsGetDimX() for an explanation of the context.

Returns 0 if the Array1 dimension is not present.

Returns the size of the Array2 dimension for the specified kernel context. See rsGetDimX() for an explanation of the context.

Returns 0 if the Array2 dimension is not present.

Returns the size of the Array3 dimension for the specified kernel context. See rsGetDimX() for an explanation of the context.

Returns 0 if the Array3 dimension is not present.

If the kernel is iterating over a cubemap, this function returns true if there's more than one face present. In all other cases, it returns false. See rsGetDimX() for an explanation of the context.

rsAllocationGetDimFaces() is similar but returns 0 or 1 instead of a bool.

Returns the number of levels of detail for the specified kernel context. This is useful for mipmaps. See rsGetDimX() for an explanation of the context.

Returns 0 if Level of Detail is not used.

rsAllocationGetDimLOD() is similar but returns 0 or 1 instead the actual number of levels.

Returns the size of the X dimension for the specified kernel context.

The kernel context contains common characteristics of the allocations being iterated over and rarely used indices, like the Array0 index.

You can access it by adding a special parameter named "context" of type rs_kernel_context to your kernel function. E.g.
int4 RS_KERNEL myKernel(int4 value, rs_kernel_context context) {
  uint32_t size = rsGetDimX(context); //...


To get the dimension of specific allocation, use rsAllocationGetDimX().

Returns the size of the X dimension for the specified kernel context. See rsGetDimX() for an explanation of the context.

Returns 0 if the Y dimension is not present.

To get the dimension of specific allocation, use rsAllocationGetDimY().

Returns the size of the Z dimension for the specified kernel context. See rsGetDimX() for an explanation of the context.

Returns 0 if the Z dimension is not present.

To get the dimension of specific allocation, use rsAllocationGetDimZ().

Returns the face on which the cell being processed is found, as specified by the supplied kernel context. See rsGetArray0() for an explanation of the context.

Returns RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_X if the face dimension is not present.

Returns the index in the Levels of Detail dimension of the cell being processed, as specified by the supplied kernel context. See rsGetArray0() for an explanation of the context.

Returns 0 if the Levels of Detail dimension is not present.