[gimp-help-2] Review Lighting Effects filter docs
- From: Ulf-D. Ehlert <ulfehlert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp-help-2] Review Lighting Effects filter docs
- Date: Sun, 23 May 2010 19:05:26 +0000 (UTC)
commit 464481d394fc6e768b7598e829f244332e128206
Author: Ulf-D. Ehlert <ulfehlert svn gnome org>
Date: Sat May 22 11:30:02 2010 +0200
Review Lighting Effects filter docs
Here (and in the previous commit), "review" means formal changes like
converting lists to sections for tabbed options or to fix spelling of options.
src/filters/light_effects/lighting.xml | 664 ++++++++++++++++----------------
1 files changed, 341 insertions(+), 323 deletions(-)
---
diff --git a/src/filters/light_effects/lighting.xml b/src/filters/light_effects/lighting.xml
index a5eaf69..9b80233 100644
--- a/src/filters/light_effects/lighting.xml
+++ b/src/filters/light_effects/lighting.xml
@@ -79,333 +79,351 @@
<para>
If <guilabel>Interactive</guilabel> is not checked, changes are
displayed in preview only when you click on the
- <guilabel>Update</guilabel> button.
+ <guibutton>Update</guibutton> button.
This option is useful with a slow computer.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term>General Options</term>
- <listitem>
- <figure>
- <title><quote>Lighting</quote> filter general options</title>
- <mediaobject>
- <imageobject>
- <imagedata format="PNG"
- fileref="images/filters/options-light-lighting1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <variablelist>
- <varlistentry>
- <term>Transparent Background</term>
- <listitem>
- <para>
- Makes destination image transparent when bumpmap height
- is zero (height is zero in black areas of the bumpmapped
- image).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Create New Image</term>
- <listitem>
- <para>
- Creates a new image when applying filter.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>High Quality Preview</term>
- <listitem>
- <para>
- For quick CPU...
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Distance</term>
- <listitem>
- <para>
- You can specify the distance of the light source from the
- center of the image with this slider. The range of values
- is from 0.0 to 2.0.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Light</term>
- <listitem>
- <figure>
- <title><quote>Light</quote> Options of the Lighting filter</title>
- <mediaobject>
- <imageobject>
- <imagedata format="PNG"
- fileref="images/filters/options-light-lighting2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- In this tab, you can set light parameters. With
- <guilabel>Light 1, 2,...6</guilabel>: You can create six light
- sources and work on each of them separately.
- </para>
- <variablelist>
- <varlistentry>
- <term>Light Type</term>
- <listitem>
- <para>
- This filter provides several <guilabel>Light Types
- </guilabel> in a drop-down list:
- </para>
- <para><emphasis>Point</emphasis>: displays a blue point at center
- of preview. You can click and drag it to move light all
- over the preview.
- </para>
- <para><emphasis>Directional</emphasis>: the blue point is linked
- to preview center by a line which indicates the direction
- of light.
- </para>
- <para><emphasis>None</emphasis>: This deletes the light source
- (light may persist...).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Light Source Color</term>
- <listitem>
- <para>
- When you click on the color swatch, you bring a dialog up
- where you can select the light source color.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Intensity</term>
- <listitem>
- <para>
- With this option, you can set light intensity.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Position</term>
- <listitem>
- <para>
- Determines the light point
- position according to three coordinates: X coordinate for
- horizontal position, Y for vertical position, Z for source
- distance (the light darkens when distance increases). Values
- are from -1 to +1.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Direction</term>
- <listitem>
- <para>
- This option should allow you to fix the light direction in
- its three <guilabel>X</guilabel>, <guilabel>Y</guilabel>
- and <guilabel>Z</guilabel> coordinates.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Isolate</term>
- <listitem>
- <para>
- With this option, you can decide whether all light sources
- must appear in the Preview, or only the source you are
- working on.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Lighting Preset</term>
- <listitem>
- <para>
- You can save your settings with the <guibutton>Save
- </guibutton> and get them back later with the
- <guibutton>Open</guibutton>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Material</term>
- <listitem>
- <figure>
- <title><quote>Material</quote> tab of the Lighting filter</title>
- <mediaobject>
- <imageobject>
- <imagedata format="PNG"
- fileref="images/filters/options-light-lighting3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- These options don't concern light itself, but light reflected by
- objects.
- </para>
- <para>
- Small spheres, on both ends of the input boxes, represent the
- action of every option, from its minimum (on the left) to its
- maximum (on the right). Help pop ups are more useful.
- </para>
- <variablelist>
- <varlistentry>
- <term>Glowing</term>
- <listitem>
- <para>
- With these option, you can set the amount of original
- color to show where no direct light falls.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Bright</term>
- <listitem>
- <para>
- With this option, you can set the intensity of original
- color when hit directly by a light source.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Shiny</term>
- <listitem>
- <para>
- This option controls how intense the highlight will be.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Polished</term>
- <listitem>
- <para>
- With this option, higher values make the highlight more
- focused.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Metallic</term>
- <listitem>
- <para>
- When this option is checked, surfaces look metallic.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Bump Map</term>
- <listitem>
- <figure>
- <title>
- <quote>Bumpmap</quote> options of the Lighting filter
- </title>
- <mediaobject>
- <imageobject>
- <imagedata format="PNG"
- fileref="images/filters/options-light-lighting4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- In this tab, you can set filter options that give relief to the
- image. See <link linkend="glossary-bumpmapping">Bumpmapping</link>.
- </para>
- <variablelist>
- <varlistentry>
- <term>Enable Bump Mapping</term>
- <listitem>
- <para>
- With this option, bright parts of the image will appear
- raised and dark parts will appear depressed. The aspect
- depends on the light source position.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Bump Map Image</term>
- <listitem>
- <para>
- You have to select there the grey-scale image that will
- act as a bump map.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Curve</term>
- <listitem>
- <para>
- Four curve types are available:
- <emphasis>Linear</emphasis>,
- <emphasis>Logarithmic</emphasis>,
- <emphasis>Sinusoidal</emphasis> and
- <emphasis>Spherical</emphasis>. See
- <link linkend="plug-in-bump-map">Bump Map</link> plug-in for
- explanations.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Maximum Height</term>
- <listitem>
- <para>
- This is the maximum height of bumps.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Environment Map</term>
- <listitem>
- <figure>
- <title><quote>Environment map</quote> options</title>
- <mediaobject>
- <imageobject>
- <imagedata format="PNG"
- fileref="images/filters/options-light-lighting5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <variablelist>
- <varlistentry>
- <term>Enable Environment Mapping</term>
- <listitem>
- <para>
- When you check this box, the following option is enabled:
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Environment Image</term>
- <listitem>
- <para>
- You have to select there a RGB image, present on your
- screen. Please note that for this option to work you
- should load another image with gimp
- <emphasis>before</emphasis> using it.
- </para>
- <para>
- An example can be found at
- <xref linkend="bibliography-online-golden-text"/>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
</variablelist>
+ <para>
+ Any other options are organized in tabs:
+ </para>
+
+ <sect4>
+ <title>General Options</title>
+ <figure>
+ <title><quote>Lighting</quote> filter general options</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata format="PNG"
+ fileref="images/filters/options-light-lighting1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <variablelist>
+ <varlistentry>
+ <term>Transparent background</term>
+ <listitem>
+ <para>
+ Makes destination image transparent when bumpmap height
+ is zero (height is zero in black areas of the bumpmapped
+ image).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Create new image</term>
+ <listitem>
+ <para>
+ Creates a new image when applying filter.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>High quality preview</term>
+ <listitem>
+ <para>
+ For quick CPU...
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Distance</term>
+ <listitem>
+ <para>
+ You can specify the distance of the light source from the
+ center of the image with this slider. The range of values
+ is from 0.0 to 2.0.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect4>
+
+ <sect4>
+ <title>Light Settings</title>
+ <figure>
+ <title><quote>Light</quote> options of the Lighting filter</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata format="PNG"
+ fileref="images/filters/options-light-lighting2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <variablelist>
+ <para>
+ In this tab, you can set light parameters. With
+ <guilabel>Light 1</guilabel> ...
+ <guilabel>Light 6</guilabel> you can create six light sources
+ and work on each of them separately.
+ </para>
+ <varlistentry>
+ <term>Type</term>
+ <listitem>
+ <para>
+ The filter provides several <emphasis>light types</emphasis> in
+ a drop-down list:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Point</guilabel></term>
+ <listitem>
+ <para>
+ Displays a blue point at center of preview. You can click
+ and drag it to move light all over the preview.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Directional</guilabel></term>
+ <listitem>
+ <para>
+ The blue point is linked to preview center by a line which
+ indicates the direction of light.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>None</guilabel></term>
+ <listitem>
+ <para>
+ This deletes the light source (light may persist...).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Color</term>
+ <listitem>
+ <para>
+ When you click on the color swatch, you bring a dialog up
+ where you can select the light source color.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Intensity</term>
+ <listitem>
+ <para>
+ With this option, you can set light intensity.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Position</term>
+ <listitem>
+ <para>
+ Determines the light point
+ position according to three coordinates: X coordinate for
+ horizontal position, Y for vertical position, Z for source
+ distance (the light darkens when distance increases). Values
+ are from -1 to +1.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Direction</term>
+ <listitem>
+ <para>
+ This option should allow you to fix the light direction in
+ its three <guilabel>X</guilabel>, <guilabel>Y</guilabel>
+ and <guilabel>Z</guilabel> coordinates.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Isolate</term>
+ <listitem>
+ <para>
+ With this option, you can decide whether all light sources
+ must appear in the Preview, or only the source you are
+ working on.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Lighting preset</term>
+ <listitem>
+ <para>
+ You can save your settings with the <guibutton>Save
+ </guibutton> and get them back later with the
+ <guibutton>Open</guibutton>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect4>
+
+ <sect4>
+ <title>Material Properties</title>
+ <figure>
+ <title><quote>Material</quote> tab of the Lighting filter</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata format="PNG"
+ fileref="images/filters/options-light-lighting3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ These options don't concern light itself, but light reflected by
+ objects.
+ </para>
+ <para>
+ Small spheres, on both ends of the input boxes, represent the
+ action of every option, from its minimum (on the left) to its
+ maximum (on the right). Help pop ups are more useful.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Glowing</term>
+ <listitem>
+ <para>
+ With these option, you can set the amount of original
+ color to show where no direct light falls.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Bright</term>
+ <listitem>
+ <para>
+ With this option, you can set the intensity of original
+ color when hit directly by a light source.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Shiny</term>
+ <listitem>
+ <para>
+ This option controls how intense the highlight will be.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Polished</term>
+ <listitem>
+ <para>
+ With this option, higher values make the highlight more
+ focused.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Metallic</term>
+ <listitem>
+ <para>
+ When this option is checked, surfaces look metallic.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect4>
+
+ <sect4>
+ <title>Bump Map</title>
+ <figure>
+ <title>
+ <quote>Bump Map</quote> options of the Lighting filter
+ </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata format="PNG"
+ fileref="images/filters/options-light-lighting4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ In this tab, you can set filter options that give relief to the
+ image. See <xref linkend="glossary-bumpmapping"/>.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Enable bump mapping</term>
+ <listitem>
+ <para>
+ With this option, bright parts of the image will appear
+ raised and dark parts will appear depressed. The aspect
+ depends on the light source position.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Bumpmap image</term>
+ <listitem>
+ <para>
+ You have to select there the grey-scale image that will
+ act as a bump map. See <link linkend="plug-in-bump-map">Bump
+ Map</link> plug-in for additional explanations.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Curve</term>
+ <listitem>
+ <para>
+ This option defines the method that will be used when applying
+ the bump map; that is, the bump height is a function of the
+ specified curve.
+ Four curve types are available:
+ <emphasis>Linear</emphasis>,
+ <emphasis>Logarithmic</emphasis>,
+ <emphasis>Sinusoidal</emphasis> and
+ <emphasis>Spherical</emphasis>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Maximum height</term>
+ <listitem>
+ <para>
+ This is the maximum height of bumps.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect4>
+
+ <sect4>
+ <title>Environment Map</title>
+ <figure>
+ <title><quote>Environment Map</quote> options</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata format="PNG"
+ fileref="images/filters/options-light-lighting5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <variablelist>
+ <varlistentry>
+ <term>Enable environment mapping</term>
+ <listitem>
+ <para>
+ When you check this box, the following option is enabled:
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Environment image</term>
+ <listitem>
+ <para>
+ You have to select there a RGB image, present on your
+ screen. Please note that for this option to work you
+ should load another image with <acronym>GIMP</acronym>
+ <emphasis>before</emphasis> using it.
+ </para>
+ <para>
+ An example can be found at
+ <xref linkend="bibliography-online-golden-text"/>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect4>
</sect3>
</sect2>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
