[gimp-help/gimp-help-2-10] Add documentation for thee blur filters...

From: Jacob Boerema <jboerema src gnome org>
To: commits-list gnome org
Cc:
Subject: [gimp-help/gimp-help-2-10] Add documentation for thee blur filters...
Date: Fri, 14 Oct 2022 01:22:57 +0000 (UTC)
commit c5992809e0804d76d667b650c068abbf5ec8db77
Author: Jacob Boerema <jgboerema gmail com>
Date:   Thu Oct 13 21:22:06 2022 -0400

    Add documentation for thee blur filters...
    
    - Focus Blur
    - Lens Blur
    - Variable Blur

 images/C/filters/blur/focus-blur-dialog.png     | Bin 0 -> 34580 bytes
 images/C/filters/blur/lens-blur-dialog.png      | Bin 0 -> 28003 bytes
 images/C/filters/blur/variable-blur-dialog.png  | Bin 0 -> 25206 bytes
 images/C/filters/examples/blur-taj-focus.jpg    | Bin 0 -> 13205 bytes
 images/C/filters/examples/blur-taj-lens.jpg     | Bin 0 -> 15245 bytes
 images/C/filters/examples/blur-taj-variable.jpg | Bin 0 -> 11684 bytes
 src/filters/blur.xml                            |   3 +
 src/filters/blur/focus-blur.xml                 | 219 ++++++++++++++++++++++++
 src/filters/blur/lens-blur.xml                  | 132 ++++++++++++++
 src/filters/blur/variable-blur.xml              | 114 ++++++++++++
 10 files changed, 468 insertions(+)
---
diff --git a/images/C/filters/blur/focus-blur-dialog.png b/images/C/filters/blur/focus-blur-dialog.png
new file mode 100644
index 000000000..f15638952
Binary files /dev/null and b/images/C/filters/blur/focus-blur-dialog.png differ
diff --git a/images/C/filters/blur/lens-blur-dialog.png b/images/C/filters/blur/lens-blur-dialog.png
new file mode 100644
index 000000000..235f328fc
Binary files /dev/null and b/images/C/filters/blur/lens-blur-dialog.png differ
diff --git a/images/C/filters/blur/variable-blur-dialog.png b/images/C/filters/blur/variable-blur-dialog.png
new file mode 100644
index 000000000..a36b04b9a
Binary files /dev/null and b/images/C/filters/blur/variable-blur-dialog.png differ
diff --git a/images/C/filters/examples/blur-taj-focus.jpg b/images/C/filters/examples/blur-taj-focus.jpg
new file mode 100644
index 000000000..84ec82b3d
Binary files /dev/null and b/images/C/filters/examples/blur-taj-focus.jpg differ
diff --git a/images/C/filters/examples/blur-taj-lens.jpg b/images/C/filters/examples/blur-taj-lens.jpg
new file mode 100644
index 000000000..ebc04a8ff
Binary files /dev/null and b/images/C/filters/examples/blur-taj-lens.jpg differ
diff --git a/images/C/filters/examples/blur-taj-variable.jpg b/images/C/filters/examples/blur-taj-variable.jpg
new file mode 100644
index 000000000..10d3b3032
Binary files /dev/null and b/images/C/filters/examples/blur-taj-variable.jpg differ
diff --git a/src/filters/blur.xml b/src/filters/blur.xml
index ccdf05bb6..80f329a96 100644
--- a/src/filters/blur.xml
+++ b/src/filters/blur.xml
@@ -9,11 +9,14 @@
   <title>Blur Filters</title>
 
   <xi:include href="blur/introduction.xml"/>
+  <xi:include href="blur/focus-blur.xml"/>
   <xi:include href="blur/gauss.xml"/>
+  <xi:include href="blur/lens-blur.xml"/>
   <xi:include href="blur/mean-curvature-blur.xml"/>
   <xi:include href="blur/median-blur.xml"/>
   <xi:include href="blur/pixelize.xml"/>
   <xi:include href="blur/gauss_select.xml"/>
+  <xi:include href="blur/variable-blur.xml"/>
   <xi:include href="blur/circular-motion.xml"/>
   <xi:include href="blur/linear-motion.xml"/>
   <xi:include href="blur/zoom-motion.xml"/>
diff --git a/src/filters/blur/focus-blur.xml b/src/filters/blur/focus-blur.xml
new file mode 100644
index 000000000..708f21477
--- /dev/null
+++ b/src/filters/blur/focus-blur.xml
@@ -0,0 +1,219 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+                       "http://www.docbook.org/xml/4.3/docbookx.dtd";>
+<sect2 id="gimp-filter-focus-blur" 
+xmlns:xi="http://www.w3.org/2001/XInclude";>
+  <title>Focus Blur</title>
+
+  <indexterm>
+    <primary>Filters</primary>
+    <secondary>Blur</secondary>
+    <tertiary>Focus Blur</tertiary>
+  </indexterm>
+  <indexterm>
+    <primary>Focus Blur</primary>
+  </indexterm>
+
+  <sect3>
+    <title>Overview</title>
+    <figure>
+      <title>The Focus Blur filter</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/filters/examples/taj_orig.jpg"
+            format="JPG"/>
+        </imageobject>
+        <caption>
+          <para>Original</para>
+        </caption>
+      </mediaobject>
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/filters/examples/blur-taj-focus.jpg"
+            format="JPG"/>
+        </imageobject>
+        <caption>
+          <para>Focus Blur applied</para>
+        </caption>
+      </mediaobject>
+    </figure>
+    <para>
+      Focus blur creates a blur in all directions around a focal point.
+      The default focal point is the center of the layer or selection.
+      You can change this focal point by dragging the center point.
+      All other points and lines can also be dragged to adjust the shape and
+      focus area of the image.
+    </para>
+  </sect3>
+
+  <sect3>
+    <title>Options</title>
+    <figure>
+      <title>
+        Focus Blur filter dialog options with Geometry Options expanded
+      </title>
+      <mediaobject>
+        <imageobject>
+          <imagedata format="PNG"
+            fileref="images/filters/blur/focus-blur-dialog.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <variablelist>
+      <varlistentry>
+        <term>
+          <guilabel>Presets</guilabel>, <guilabel>Input Type</guilabel>,
+          <guilabel>Blending Options</guilabel>, <guilabel>Preview</guilabel>, 
+          <guilabel>Split view</guilabel>
+        </term>
+        <listitem>
+          <xi:include href="../about-common-features.xml"/>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Shape</guilabel></term>
+        <listitem>
+          <para>
+            Here, you can select the shape used for creating the focus blur.
+            The choices are <guilabel>Circle</guilabel>,
+            <guilabel>Square</guilabel>,
+            <guilabel>Diamond</guilabel>,
+            <guilabel>Horizontal</guilabel> and
+            <guilabel>Vertical</guilabel>.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Blur type</guilabel></term>
+        <listitem>
+          <para>
+            The type of blur to use. The choices are
+            <guilabel>Gaussian Blur</guilabel> and
+            <guilabel>Lens Blur</guilabel>.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Blur radius</guilabel></term>
+        <listitem>
+          <para>
+            The size of the out-of-blur radius.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>High quality</guilabel> (only available for Gaussian Blur)</term>
+        <listitem>
+          <para>
+            Generate more accurate and consistent output. This is slower.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Highlight factor</guilabel> (only available for Lens Blur)</term>
+        <listitem>
+          <para>
+            Relative highlight strength.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Highlight threshold</guilabel> (only available for Lens Blur)</term>
+        <listitem>
+          <para>
+            Here you can set the minimum and maximum values for highlighting.
+            It can be set either by dragging the black and white triangles, or
+            inputting exact values into the number entry fields.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>Geometry Options</term>
+        <listitem>
+          <para>
+            These geometry related options can all be changed by using the
+            visual on-canvas controls. In case you need more fine-grained
+            control, they can be set manually here.
+          </para>
+          <variablelist>
+            <varlistentry>
+            <term>Center X, Center Y</term>
+            <listitem>
+              <para>
+                Specifies the center X and Y position of the focus blur.
+              </para>
+            </listitem>
+            </varlistentry>
+            <varlistentry>
+            <term>Radius</term>
+            <listitem>
+              <para>
+                The radius of the outer focus region. Visible as the outer
+                continuous line.
+              </para>
+            </listitem>
+            </varlistentry>
+            <varlistentry>
+            <term>Sharpness</term>
+            <listitem>
+              <para>
+                The radius of the inner focus region. Visible as the inner
+                continuous line.
+              </para>
+            </listitem>
+            </varlistentry>
+            <varlistentry>
+            <term>Midpoint</term>
+            <listitem>
+              <para>
+                The focus transition midpoint. Shown as a dashed line.
+                The area from the inner (sharpness) line to the midpoint, is
+                where the focus area turns into the blurred area.
+              </para>
+            </listitem>
+            </varlistentry>
+            <varlistentry>
+            <term>Aspect ratio</term>
+            <listitem>
+              <para>
+                This controls the aspect ratio.
+              </para>
+            </listitem>
+            </varlistentry>
+            <varlistentry>
+            <term>Rotation</term>
+            <listitem>
+              <para>
+                This controls the rotation in degrees. You can either use the
+                circular control or enter numbers.
+              </para>
+            </listitem>
+            </varlistentry>
+          </variablelist>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>On-canvas controls</guilabel></term>
+        <listitem>
+          <para>
+            This option (default) allows you to modify blur settings directly 
+            on canvas, for easier visual tweaking of blur settings. It displays
+            lines in the selected shape with points on it. Both the lines and
+            the points can be dragged with a mouse to change the focus center,
+            the blurring area and other settings that are also available in
+            the <guilabel>Geometry Options</guilabel>.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </sect3>
+</sect2>
diff --git a/src/filters/blur/lens-blur.xml b/src/filters/blur/lens-blur.xml
new file mode 100644
index 000000000..ef80519ad
--- /dev/null
+++ b/src/filters/blur/lens-blur.xml
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+                       "http://www.docbook.org/xml/4.3/docbookx.dtd";>
+<sect2 id="gimp-filter-lens-blur" 
+xmlns:xi="http://www.w3.org/2001/XInclude";>
+  <title>Lens Blur</title>
+
+  <indexterm>
+    <primary>Filters</primary>
+    <secondary>Blur</secondary>
+    <tertiary>Lens Blur</tertiary>
+  </indexterm>
+  <indexterm>
+    <primary>Lens Blur</primary>
+  </indexterm>
+
+  <sect3>
+    <title>Overview</title>
+    <figure>
+      <title>The Lens Blur filter</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/filters/examples/taj_orig.jpg"
+            format="JPG"/>
+        </imageobject>
+        <caption>
+          <para>Original</para>
+        </caption>
+      </mediaobject>
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/filters/examples/blur-taj-lens.jpg"
+            format="JPG"/>
+        </imageobject>
+        <caption>
+          <para>Lens Blur applied</para>
+        </caption>
+      </mediaobject>
+    </figure>
+    <para>
+      Lens blur simulates an out-of-focus camera picture.
+    </para>
+  </sect3>
+
+  <sect3>
+    <title>Options</title>
+    <figure>
+      <title>
+        Lens Blur filter dialog options
+      </title>
+      <mediaobject>
+        <imageobject>
+          <imagedata format="PNG"
+            fileref="images/filters/blur/lens-blur-dialog.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <variablelist>
+      <varlistentry>
+        <term>
+          <guilabel>Presets</guilabel>, <guilabel>Input Type</guilabel>,
+          <guilabel>Blending Options</guilabel>, <guilabel>Preview</guilabel>, 
+          <guilabel>Split view</guilabel>
+        </term>
+        <listitem>
+          <xi:include href="../about-common-features.xml"/>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Aux input</guilabel></term>
+        <listitem>
+          <para>
+            This allows you to select an additional input layer or channel,
+            that will be used to compute the lens blur. Clicking on the
+            square picture allows you to select from a list of available
+            layers and channels. The <guilabel>Aux input</guilabel> will
+            only be used if this setting is enabled.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Radius</guilabel></term>
+        <listitem>
+          <para>
+            The size of the blur radius.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Highlight factor</guilabel></term>
+        <listitem>
+          <para>
+            Relative highlight strength.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Highlight threshold</guilabel></term>
+        <listitem>
+          <para>
+            Here you can set the minimum and maximum values for highlighting.
+            It can be set either by dragging the black and white triangles, or
+            inputting exact values into the number entry fields.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Clip to input extents</guilabel></term>
+        <listitem>
+          <para>
+            If enabled, this limits the output to the input extents.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Linear mask</guilabel></term>
+        <listitem>
+          <para>
+            If enabled, use linear mask values.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </sect3>
+</sect2>
diff --git a/src/filters/blur/variable-blur.xml b/src/filters/blur/variable-blur.xml
new file mode 100644
index 000000000..e2d4799f0
--- /dev/null
+++ b/src/filters/blur/variable-blur.xml
@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+                       "http://www.docbook.org/xml/4.3/docbookx.dtd";>
+<sect2 id="gimp-filter-variable-blur" 
+xmlns:xi="http://www.w3.org/2001/XInclude";>
+  <title>Variable Blur</title>
+
+  <indexterm>
+    <primary>Filters</primary>
+    <secondary>Blur</secondary>
+    <tertiary>Variable Blur</tertiary>
+  </indexterm>
+  <indexterm>
+    <primary>Variable Blur</primary>
+  </indexterm>
+
+  <sect3>
+    <title>Overview</title>
+    <figure>
+      <title>The Variable Blur filter</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/filters/examples/taj_orig.jpg"
+            format="JPG"/>
+        </imageobject>
+        <caption>
+          <para>Original</para>
+        </caption>
+      </mediaobject>
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/filters/examples/blur-taj-variable.jpg"
+            format="JPG"/>
+        </imageobject>
+        <caption>
+          <para>Variable Blur applied</para>
+        </caption>
+      </mediaobject>
+    </figure>
+    <para>
+      Variable Blur blurs the image by a variable amount using a mask set in
+      <guilabel>Aux input</guilabel>. Black in the mask layer will be
+      minimally blurred, and white will be blurred at maximum value.
+    </para>
+  </sect3>
+
+  <sect3>
+    <title>Options</title>
+    <figure>
+      <title>
+        Variable Blur filter dialog options
+      </title>
+      <mediaobject>
+        <imageobject>
+          <imagedata format="PNG"
+            fileref="images/filters/blur/variable-blur-dialog.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <variablelist>
+      <varlistentry>
+        <term>
+          <guilabel>Presets</guilabel>, <guilabel>Input Type</guilabel>,
+          <guilabel>Blending Options</guilabel>, <guilabel>Preview</guilabel>, 
+          <guilabel>Split view</guilabel>
+        </term>
+        <listitem>
+          <xi:include href="../about-common-features.xml"/>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Aux input</guilabel></term>
+        <listitem>
+          <para>
+            Here you can set the mask that determines how much a certain
+            area of the input layer will be blurred. Black areas in the mask
+            will result in minimal blurring of the output, and white will
+            be blurred the most.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Radius</guilabel></term>
+        <listitem>
+          <para>
+            Maximal blur radius.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>Linear mask</guilabel></term>
+        <listitem>
+          <para>
+            If enabled, use linear mask values.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><guilabel>High quality</guilabel></term>
+        <listitem>
+          <para>
+            If enabled, generates more accurate and consistent output, at the
+            cost of being slower.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </sect3>
+</sect2>
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]