Merge changes Iaa88ac02,Ic6f8d1da,Idd07db5d

* changes:
  [RenderScript] Update documentation for Allocation.setAutoPadding().
  [RenderScript] Fix IntrinsicConvolve documentation.
  [RenderScript] Update the documentation of Script.LaunchOptions
This commit is contained in:
Miao Wang
2016-03-30 01:02:28 +00:00
committed by Gerrit Code Review
4 changed files with 30 additions and 25 deletions

View File

@@ -296,8 +296,13 @@ public class Allocation extends BaseObj {
}
/**
* Enable/Disable AutoPadding for Vec3 elements.
* By default: Diabled.
* Enable/Disable AutoPadding for Vec3 Elements.
*
* <p> Vec3 Elements, such as {@link Element#U8_3} are treated as Vec4 Elements
* with the fourth vector element used as padding. Enabling the AutoPadding feature
* will automatically add/remove the padding when you copy to/from an Allocation
* with a Vec3 Element.
* <p> By default: Disabled.
*
* @param useAutoPadding True: enable AutoPadding; False: disable AutoPadding
*

View File

@@ -542,21 +542,22 @@ public class Script extends BaseObj {
/**
* Class for specifying the specifics about how a kernel will be
* launched
* 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.
* The forEach kernel 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.
* The resulting forEach run would execute over:
* x = 5 to 9 (inclusive) and
* y = 0 to 9 (inclusive).
*
*
*/
@@ -570,11 +571,11 @@ public class Script extends BaseObj {
private int strategy;
/**
* Set the X range. If the end value is set to 0 the X dimension is not
* clipped.
* Set the X range. xstartArg is the lowest coordinate of the range,
* and xendArg-1 is the highest coordinate of the range.
*
* @param xstartArg Must be >= 0
* @param xendArg Must be >= xstartArg
* @param xendArg Must be > xstartArg
*
* @return LaunchOptions
*/
@@ -588,11 +589,11 @@ public class Script extends BaseObj {
}
/**
* Set the Y range. If the end value is set to 0 the Y dimension is not
* clipped.
* Set the Y range. ystartArg is the lowest coordinate of the range,
* and yendArg-1 is the highest coordinate of the range.
*
* @param ystartArg Must be >= 0
* @param yendArg Must be >= ystartArg
* @param yendArg Must be > ystartArg
*
* @return LaunchOptions
*/
@@ -606,11 +607,11 @@ public class Script extends BaseObj {
}
/**
* Set the Z range. If the end value is set to 0 the Z dimension is not
* clipped.
* Set the Z range. zstartArg is the lowest coordinate of the range,
* and zendArg-1 is the highest coordinate of the range.
*
* @param zstartArg Must be >= 0
* @param zendArg Must be >= zstartArg
* @param zendArg Must be > zstartArg
*
* @return LaunchOptions
*/

View File

@@ -32,10 +32,9 @@ public final class ScriptIntrinsicConvolve3x3 extends ScriptIntrinsic {
* Supported elements types are {@link Element#U8}, {@link
* Element#U8_2}, {@link Element#U8_3}, {@link Element#U8_4},
* {@link Element#F32}, {@link Element#F32_2}, {@link
* Element#F32_3}, and {@link Element#F32_4}
*
* The default coefficients are.
* Element#F32_3}, and {@link Element#F32_4}.
*
* <p> The default coefficients are:
* <code>
* <p> [ 0, 0, 0 ]
* <p> [ 0, 1, 0 ]
@@ -67,7 +66,7 @@ public final class ScriptIntrinsicConvolve3x3 extends ScriptIntrinsic {
}
/**
* Set the input of the blur.
* Set the input of the 3x3 convolve.
* Must match the element type supplied during create.
*
* @param ain The input allocation.
@@ -80,7 +79,7 @@ public final class ScriptIntrinsicConvolve3x3 extends ScriptIntrinsic {
/**
* Set the coefficients for the convolve.
*
* The convolve layout is
* <p> The convolve layout is:
* <code>
* <p> [ 0, 1, 2 ]
* <p> [ 3, 4, 5 ]

View File

@@ -32,9 +32,9 @@ public final class ScriptIntrinsicConvolve5x5 extends ScriptIntrinsic {
* Supported elements types are {@link Element#U8}, {@link
* Element#U8_2}, {@link Element#U8_3}, {@link Element#U8_4},
* {@link Element#F32}, {@link Element#F32_2}, {@link
* Element#F32_3}, and {@link Element#F32_4}
* Element#F32_3}, and {@link Element#F32_4}.
*
* The default coefficients are.
* <p> The default coefficients are:
* <code>
* <p> [ 0, 0, 0, 0, 0 ]
* <p> [ 0, 0, 0, 0, 0 ]
@@ -66,7 +66,7 @@ public final class ScriptIntrinsicConvolve5x5 extends ScriptIntrinsic {
}
/**
* Set the input of the blur.
* Set the input of the 5x5 convolve.
* Must match the element type supplied during create.
*
* @param ain The input allocation.
@@ -79,7 +79,7 @@ public final class ScriptIntrinsicConvolve5x5 extends ScriptIntrinsic {
/**
* Set the coefficients for the convolve.
*
* The convolve layout is
* <p> The convolve layout is:
* <code>
* <p> [ 0, 1, 2, 3, 4 ]
* <p> [ 5, 6, 7, 8, 9 ]