Small fixes to the documentation.
Small corrections to the documentation. This CL changes the files
used to generate the docs & the corresponding header files. The
actual .jd documentation files are fixed in another CL.
b/23190418
Change-Id: I3632a4f867cbfa7d4e0de6c3ffcb07533130531b
diff --git a/api/GenerateDocumentation.cpp b/api/GenerateDocumentation.cpp
index 565f4fb..9d399d4 100644
--- a/api/GenerateDocumentation.cpp
+++ b/api/GenerateDocumentation.cpp
@@ -322,7 +322,7 @@
if (info.minVersion <= 1) {
// No minimum
if (info.maxVersion > 0) {
- stream << "Removed from " << mid << info.maxVersion + 1 << " and beyond";
+ stream << "Removed from " << mid << info.maxVersion + 1 << " and higher";
}
} else {
if (info.maxVersion == 0) {
diff --git a/api/rs_allocation_data.spec b/api/rs_allocation_data.spec
index a1d7663..4700fd6 100644
--- a/api/rs_allocation_data.spec
+++ b/api/rs_allocation_data.spec
@@ -167,7 +167,7 @@
mono dimensional allocations.
For efficiency, this function does not validate the inputs. Trying to wrap the
- X index, exceeding the size of the allocation, or using indexes incompatible
+ X index, exceeding the size of the allocation, or using indices incompatible
with the dimensionality of the allocation yiels undefined results.
See also @rsAllocationVLoadX().
diff --git a/api/rs_convert.spec b/api/rs_convert.spec
index fbc2cf3..810ac76 100644
--- a/api/rs_convert.spec
+++ b/api/rs_convert.spec
@@ -83,10 +83,10 @@
description:
Packs three or four floating point RGBA values into a uchar4.
- The input values are typically between 0.0 and 1.0 inclusive. For input values outside
+ The input values are typically between 0.0f and 1.0f inclusive. For input values outside
of this range, the resulting outputs will be clamped to be between 0 and 255. As this
clamping may be done after the input is multiplied by 255.f and converted to an integer,
- input numbers greater than INT_MAX/255.f or less than INT_MIN/255.f can result in
+ input numbers greater than INT_MAX/255.f or less than INT_MIN/255.f result in
undefined behavior.
If the alpha component is not specified, it is assumed to be 1.0, i.e. the result will
diff --git a/api/rs_for_each.spec b/api/rs_for_each.spec
index bf5ede2..c0c09b2 100644
--- a/api/rs_for_each.spec
+++ b/api/rs_for_each.spec
@@ -20,7 +20,7 @@
The @rsForEach() function can be used to invoke the root kernel of a script.
The other functions are used to get the characteristics of the invocation of
- an executing kernel, like dimensions and current indexes. These functions take
+ an executing kernel, like dimensions and current indices. These functions take
a @rs_kernel_context as argument.
end:
@@ -48,13 +48,10 @@
summary: Handle to a kernel invocation context
description:
The kernel context contains common characteristics of the allocations being iterated
- over, like dimensions, and rarely used indexes, like the Array0 index or the current
- level of detail.
+ over, like dimensions. It also contains rarely used indices of the currently processed
+ cell, like the Array0 index or the current level of detail.
- A kernel may be executed in parallel over multiple threads. Each thread will have its
- own context.
-
- You can access the context by adding a special parameter named "context" and of type
+ You can access the kernel context by adding a special parameter named "context" of type
rs_kernel_context to your kernel function. See @rsGetDimX() and @rsGetArray0() for examples.
end:
@@ -163,21 +160,20 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Index in the Array0 dimension for the specified context
+summary: Index in the Array0 dimension for the specified kernel context
description:
Returns the index in the Array0 dimension of the cell being processed, as specified
- by the supplied context.
+ by the supplied kernel context.
- This context is created when a kernel is launched and updated at each iteration.
- It contains common characteristics of the allocations being iterated over and rarely
- used indexes, like the Array0 index.
+ The kernel context contains common characteristics of the allocations being iterated
+ over and rarely used indices, like the Array0 index.
- You can access the context by adding a special parameter named "context" and of
+ You can access the kernel context by adding a special parameter named "context" of
type rs_kernel_context to your kernel function. E.g.<br/>
<code>short RS_KERNEL myKernel(short value, uint32_t x, rs_kernel_context context) {<br/>
- // The current index in the common x, y, z, w dimensions are accessed by<br/>
- // adding these variables as arguments. For the more rarely used indexes<br/>
- // to the other dimensions, extract them from the context:<br/>
+ // The current index in the common x, y, z dimensions are accessed by<br/>
+ // adding these variables as arguments. For the more rarely used indices<br/>
+ // to the other dimensions, extract them from the kernel context:<br/>
uint32_t index_a0 = rsGetArray0(context);<br/>
//...<br/>
}<br/></code>
@@ -190,10 +186,10 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Index in the Array1 dimension for the specified context
+summary: Index in the Array1 dimension for the specified kernel context
description:
Returns the index in the Array1 dimension of the cell being processed, as specified
- by the supplied context. See @rsGetArray0() for an explanation of the context.
+ by the supplied kernel context. See @rsGetArray0() for an explanation of the context.
Returns 0 if the Array1 dimension is not present.
test: none
@@ -203,10 +199,10 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Index in the Array2 dimension for the specified context
+summary: Index in the Array2 dimension for the specified kernel context
description:
Returns the index in the Array2 dimension of the cell being processed,
- as specified by the supplied context. See @rsGetArray0() for an explanation
+ as specified by the supplied kernel context. See @rsGetArray0() for an explanation
of the context.
Returns 0 if the Array2 dimension is not present.
@@ -217,10 +213,10 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Index in the Array3 dimension for the specified context
+summary: Index in the Array3 dimension for the specified kernel context
description:
Returns the index in the Array3 dimension of the cell being processed, as specified
- by the supplied context. See @rsGetArray0() for an explanation of the context.
+ by the supplied kernel context. See @rsGetArray0() for an explanation of the context.
Returns 0 if the Array3 dimension is not present.
test: none
@@ -230,9 +226,9 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Size of the Array0 dimension for the specified context
+summary: Size of the Array0 dimension for the specified kernel context
description:
- Returns the size of the Array0 dimension for the specified context.
+ 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.
@@ -245,9 +241,9 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Size of the Array1 dimension for the specified context
+summary: Size of the Array1 dimension for the specified kernel context
description:
- Returns the size of the Array1 dimension for the specified context.
+ 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.
@@ -258,9 +254,9 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Size of the Array2 dimension for the specified context
+summary: Size of the Array2 dimension for the specified kernel context
description:
- Returns the size of the Array2 dimension for the specified context.
+ 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.
@@ -271,9 +267,9 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Size of the Array3 dimension for the specified context
+summary: Size of the Array3 dimension for the specified kernel context
description:
- Returns the size of the Array3 dimension for the specified context.
+ 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.
@@ -284,10 +280,10 @@
version: 23
ret: bool, "Returns true if more than one face is present, false otherwise."
arg: rs_kernel_context context
-summary: Presence of more than one face for the specified context
+summary: Presence of more than one face for the specified kernel context
description:
- If the context refers to 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
+ 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.
@@ -298,9 +294,9 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Number of levels of detail for the specified context
+summary: Number of levels of detail for the specified kernel context
description:
- Returns the number of levels of detail for the specified context. This is useful
+ 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.
@@ -314,15 +310,14 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Size of the X dimension for the specified context
+summary: Size of the X dimension for the specified kernel context
description:
- Returns the size of the X dimension for the specified context.
+ Returns the size of the X dimension for the specified kernel context.
- This context is created when a kernel is launched. It contains common
- characteristics of the allocations being iterated over by the kernel in
- a very efficient structure. It also contains rarely used indexes.
+ 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" and of
+ You can access it by adding a special parameter named "context" of
type rs_kernel_context to your kernel function. E.g.<br/>
<code>int4 RS_KERNEL myKernel(int4 value, rs_kernel_context context) {<br/>
uint32_t size = rsGetDimX(context); //...<br/></code>
@@ -335,9 +330,9 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Size of the Y dimension for the specified context
+summary: Size of the Y dimension for the specified kernel context
description:
- Returns the size of the X dimension for the specified context.
+ 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.
@@ -350,9 +345,9 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Size of the Z dimension for the specified context
+summary: Size of the Z dimension for the specified kernel context
description:
- Returns the size of the Z dimension for the specified context.
+ 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.
@@ -365,10 +360,10 @@
version: 23
ret: rs_allocation_cubemap_face
arg: rs_kernel_context context
-summary: Coordinate of the Face for the specified context
+summary: Coordinate of the Face for the specified kernel context
description:
Returns the face on which the cell being processed is found, as specified by the
- supplied context. See @rsGetArray0() for an explanation of the context.
+ 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.
@@ -379,10 +374,10 @@
version: 23
ret: uint32_t
arg: rs_kernel_context context
-summary: Index in the Levels of Detail dimension for the specified context
+summary: Index in the Levels of Detail dimension for the specified kernel context
description:
Returns the index in the Levels of Detail dimension of the cell being processed,
- as specified by the supplied context. See @rsGetArray0() for an explanation of
+ 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.