[gimp-help/gimp-help-2-10] Add missing documentation for Kaleidoscope filter.



commit c1a8576f8c562d30cd87128093943cd4275d249c
Author: Jacob Boerema <jgboerema gmail com>
Date:   Tue Sep 27 17:42:04 2022 -0400

    Add missing documentation for Kaleidoscope filter.

 images/C/filters/distort/kaleidoscope-dialog.png   | Bin 0 -> 26873 bytes
 .../filters/examples/distort-taj-kaleidoscope.jpg  | Bin 0 -> 50699 bytes
 src/filters/distort.xml                            |   2 +-
 src/filters/distort/kaleidoscope.xml               | 165 +++++++++++++++++++++
 4 files changed, 166 insertions(+), 1 deletion(-)
---
diff --git a/images/C/filters/distort/kaleidoscope-dialog.png 
b/images/C/filters/distort/kaleidoscope-dialog.png
new file mode 100644
index 000000000..3bf7e38c5
Binary files /dev/null and b/images/C/filters/distort/kaleidoscope-dialog.png differ
diff --git a/images/C/filters/examples/distort-taj-kaleidoscope.jpg 
b/images/C/filters/examples/distort-taj-kaleidoscope.jpg
new file mode 100644
index 000000000..f677b9e30
Binary files /dev/null and b/images/C/filters/examples/distort-taj-kaleidoscope.jpg differ
diff --git a/src/filters/distort.xml b/src/filters/distort.xml
index 663340f6b..9c0d1bf37 100644
--- a/src/filters/distort.xml
+++ b/src/filters/distort.xml
@@ -19,7 +19,7 @@
   <xi:include href="distort/emboss.xml"/>
   <xi:include href="distort/engrave.xml"/>
   <xi:include href="distort/lens-distortion.xml"/>
-  <!--<xi:include href="distort/kaleidoscope.xml"/>-->
+  <xi:include href="distort/kaleidoscope.xml"/>
   <xi:include href="distort/mosaic.xml"/>
   <xi:include href="distort/newsprint.xml"/>
   <xi:include href="distort/polarcoords.xml"/>
diff --git a/src/filters/distort/kaleidoscope.xml b/src/filters/distort/kaleidoscope.xml
new file mode 100644
index 000000000..2fb0b7153
--- /dev/null
+++ b/src/filters/distort/kaleidoscope.xml
@@ -0,0 +1,165 @@
+<?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 xmlns:xi="http://www.w3.org/2001/XInclude"; id="gimp-filter-kaleidoscope">
+  <title>Kaleidoscope</title>
+
+  <indexterm>
+    <primary>Filters</primary>
+    <secondary>Distorts</secondary>
+    <tertiary>Kaleidoscope</tertiary>
+  </indexterm>
+  <indexterm>
+    <primary>Kaleidoscope</primary>
+  </indexterm>
+
+  <sect3>
+    <title>Overview</title>
+    <figure>
+      <title>Example for the <quote>Kaleidoscope</quote> filter</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata format="JPG"
+            fileref="images/filters/examples/taj_orig.jpg"/>
+        </imageobject>
+        <caption>
+          <para>Original image</para>
+        </caption>
+      </mediaobject>
+      <mediaobject>
+        <imageobject>
+          <imagedata format="JPG"
+            fileref="images/filters/examples/distort-taj-kaleidoscope.jpg"/>
+        </imageobject>
+        <caption>
+          <para>
+            Filter <quote>Kaleidoscope</quote> applied with the following
+            adjusted settings: mirror rotation 25.0, Zoom 20.0.
+          </para>
+        </caption>
+      </mediaobject>
+    </figure>
+    <para>
+      This filter creates a kaleidoscope by mirroring and adjusting the
+      original image through several parameters.
+    </para>
+  </sect3>
+
+  <sect3>
+    <title>Activating the filter</title>
+    <para>
+      You can find this filter through
+      <menuchoice>
+        <guimenu>Filters</guimenu>
+        <guisubmenu>Distorts</guisubmenu>
+        <guimenuitem>Kaleidoscope…</guimenuitem>
+      </menuchoice>.
+    </para>
+  </sect3>
+
+  <sect3>
+    <title>Options</title>
+    <figure>
+      <title><quote>Kaleidoscope</quote> filter options</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata format="PNG"
+            fileref="images/filters/distort/kaleidoscope-dialog.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+    <variablelist>
+      <varlistentry>
+        <term>Presets, Input Type, Blending Options, Preview, Split view</term>
+        <listitem>
+          <xi:include href="../about-common-features.xml"/>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Mirror rotation</term>
+        <listitem>
+          <para>
+            The rotation applied to the mirrored copies of the image.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Result rotation</term>
+        <listitem>
+          <para>
+            The rotation applied to the ouput image.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Mirrors</term>
+        <listitem>
+          <para>
+            The number or mirrored copies of the image to use.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Offset X, Offset Y</term>
+        <listitem>
+          <para>
+            Horizontal and vertical position of symmetry center in the
+            output image. The arrow button can be used to pick a location
+            from the current image. The chain button can be used to enable
+            or disable forcing the same values for <guilabel>Offset X</guilabel>
+            and <guilabel>Offset Y</guilabel>.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Center X, Center Y</term>
+        <listitem>
+          <para>
+            X axis and Y axis ratio for the center of mirroring.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Trim X, Trim Y</term>
+        <listitem>
+          <para>
+            X axis and Y axis ratio for trimming mirror expanse.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Zoom</term>
+        <listitem>
+          <para>
+            Scale factor to adjust the rendering size.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Expand</term>
+        <listitem>
+          <para>
+            It is unclear what the exact effect of this is. It also seems to
+            be relating to scaling.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Clip result to input size</term>
+        <listitem>
+          <para>
+            If enabled, clips the mirrored result to the input size.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Wrap input</term>
+        <listitem>
+          <para>
+            If enabled, fills the entire output area.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </sect3>
+</sect2>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]