Add a section to list default kernels

3 files changed, 22 insertions, 0 deletions

diff --git a/docs/filters.rst b/docs/filters.rst
index 3f6cc92..8701783 100644
--- a/docs/filters.rst
+++ b/docs/filters.rst
@@ -106,6 +106,8 @@ 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.
 
     .. gobj:prop:: filename:string
 
diff --git a/docs/index.rst b/docs/index.rst
index 7e3883e..f7c59e1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -22,6 +22,7 @@ Reference
     filters
     sinks
     piv
+    kernels
     contrib/index
 
 
diff --git a/docs/kernels.rst b/docs/kernels.rst
new file mode 100644
index 0000000..f2f77e1
--- /dev/null
+++ b/docs/kernels.rst
@@ -0,0 +1,19 @@
+.. _opencl-default-kernels:
+
+OpenCL default kernels
+======================
+
+This section lists all kernel functions that are available to the
+:gobj:class:`opencl` filter if no filename is specified.
+
+.. c:function:: void fix_nan_and_inf ()
+
+    Sets element to 0.0 if it is NaN or Inf.
+
+.. c:function:: void absorptivity ()
+
+    Computes :math:`f(x) = -log(x)`.
+
+.. c:function:: void nlm_noise_reduction ()
+
+    Smooths data within a local neighbourhood.