From 8610f837bcc70f30f0ed4a6f59b54bd1d896f305 Mon Sep 17 00:00:00 2001 From: Jason Sams Date: Mon, 30 Mar 2015 17:01:10 -0700 Subject: Update LaunchOptions description Change-Id: I7425c9ea9d82ed54950557e93aa46b69ebc02c23 --- rs/java/android/renderscript/Script.java | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'rs/java/android') diff --git a/rs/java/android/renderscript/Script.java b/rs/java/android/renderscript/Script.java index 44a8a27..6a1efee 100644 --- a/rs/java/android/renderscript/Script.java +++ b/rs/java/android/renderscript/Script.java @@ -473,7 +473,23 @@ public class Script extends BaseObj { /** - * Class used to specify clipping for a kernel launch. + * Class for specifying the specifics about how a kernel will be + * launched + * + * This class can specify a potential range of cells on which to + * run a kernel. If no set is called for a dimension then this + * class will have no impact on that dimension when the kernel + * is executed. + * + * The forEach launch will operate over the intersection of the + * dimensions. + * + * Example: + * LaunchOptions with setX(5, 15) + * Allocation with dimension X=10, Y=10 + * The resulting forEach run would execute over x = 5 to 10 and + * y = 0 to 10. + * * */ public static final class LaunchOptions { -- cgit v1.1