summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2018-01-09 10:40:22 +0100
committerMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2018-01-09 10:40:22 +0100
commit9928a41c9abeeb60de7acf77f4dbb42359ef81b6 (patch)
tree68880c3c2970bfea57e249c947526c91be70d811 /docs
parent2a13650ab03077b79bc318beee29cd3aa7712f29 (diff)
downloadufo-filters-9928a41c9abeeb60de7acf77f4dbb42359ef81b6.tar.gz
ufo-filters-9928a41c9abeeb60de7acf77f4dbb42359ef81b6.tar.bz2
ufo-filters-9928a41c9abeeb60de7acf77f4dbb42359ef81b6.tar.xz
ufo-filters-9928a41c9abeeb60de7acf77f4dbb42359ef81b6.zip
Fix #152: clarify usage of opencl filter
Diffstat (limited to 'docs')
-rw-r--r--docs/filters.rst11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/filters.rst b/docs/filters.rst
index 719719f..77f4f0a 100644
--- a/docs/filters.rst
+++ b/docs/filters.rst
@@ -94,7 +94,7 @@ Generic OpenCL
.. gobj:class:: opencl
- Load an arbitrary :gobj:prop:`kernel` from :gobj:prop:`filename` or
+ Load an arbitrary OpenCL :gobj:prop:`kernel` from :gobj:prop:`filename` or
:gobj:prop:`source` and execute it on each input. The kernel must accept as
many global float array parameters as connected to the filter and one
additional as an output. For example, to compute the difference between two
@@ -106,8 +106,13 @@ Generic OpenCL
c[idx] = a[idx] - b[idx];
}
- If :gobj:prop:`filename` is not set, a default kernel file is loaded. See
- :ref:`opencl-default-kernels` for a list of possible kernels.
+ and could be used like so if defined in a file named ``diff.cl``::
+
+ $ ufo-launch [read, read] ! opencl kernel=difference filename=diff.cl ! null
+
+ If :gobj:prop:`filename` is not set, a default kernel file (``opencl.cl``)
+ is loaded. See :ref:`opencl-default-kernels` for a list of kernel names
+ defined in that file.
.. gobj:prop:: filename:string