← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpcolor/xml/gimprgb.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpcolor/xml/gimprgb.xml
4
4
 
5
5
<refentry id="libgimpcolor-GimpRGB">
6
6
<refmeta>
7
 
<refentrytitle>GimpRGB</refentrytitle>
 
7
<refentrytitle role="top_of_page">GimpRGB</refentrytitle>
8
8
<manvolnum>3</manvolnum>
9
9
<refmiscinfo>LIBGIMPCOLOR Library</refmiscinfo>
10
10
</refmeta>
11
11
 
12
12
<refnamediv>
13
 
<refname>GimpRGB</refname><refpurpose>Definitions and Functions relating to RGB colors.</refpurpose>
 
13
<refname>GimpRGB</refname>
 
14
<refpurpose>Definitions and Functions relating to RGB colors.</refpurpose>
 
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
14
16
</refnamediv>
15
17
 
16
 
<refsynopsisdiv><title>Synopsis</title>
 
18
<refsynopsisdiv role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
17
20
 
18
21
<synopsis>
19
22
 
20
23
 
21
24
 
22
 
            <link linkend="GimpRGB">GimpRGB</link>;
23
 
enum        <link linkend="GimpRGBCompositeMode">GimpRGBCompositeMode</link>;
24
 
<link linkend="void">void</link>        <link linkend="gimp-rgb-set">gimp_rgb_set</link>                    (<link linkend="GimpRGB">GimpRGB</link> *rgb,
25
 
                                             <link linkend="gdouble">gdouble</link> red,
26
 
                                             <link linkend="gdouble">gdouble</link> green,
27
 
                                             <link linkend="gdouble">gdouble</link> blue);
28
 
<link linkend="void">void</link>        <link linkend="gimp-rgb-set-alpha">gimp_rgb_set_alpha</link>              (<link linkend="GimpRGB">GimpRGB</link> *rgb,
29
 
                                             <link linkend="gdouble">gdouble</link> alpha);
30
 
<link linkend="void">void</link>        <link linkend="gimp-rgb-set-uchar">gimp_rgb_set_uchar</link>              (<link linkend="GimpRGB">GimpRGB</link> *rgb,
31
 
                                             <link linkend="guchar">guchar</link> red,
32
 
                                             <link linkend="guchar">guchar</link> green,
33
 
                                             <link linkend="guchar">guchar</link> blue);
34
 
<link linkend="void">void</link>        <link linkend="gimp-rgb-get-uchar">gimp_rgb_get_uchar</link>              (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
35
 
                                             <link linkend="guchar">guchar</link> *red,
36
 
                                             <link linkend="guchar">guchar</link> *green,
37
 
                                             <link linkend="guchar">guchar</link> *blue);
38
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-rgb-parse-name">gimp_rgb_parse_name</link>             (<link linkend="GimpRGB">GimpRGB</link> *rgb,
39
 
                                             const <link linkend="gchar">gchar</link> *name,
40
 
                                             <link linkend="gint">gint</link> len);
41
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-rgb-parse-hex">gimp_rgb_parse_hex</link>              (<link linkend="GimpRGB">GimpRGB</link> *rgb,
42
 
                                             const <link linkend="gchar">gchar</link> *hex,
43
 
                                             <link linkend="gint">gint</link> len);
44
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-rgb-parse-css">gimp_rgb_parse_css</link>              (<link linkend="GimpRGB">GimpRGB</link> *rgb,
45
 
                                             const <link linkend="gchar">gchar</link> *css,
46
 
                                             <link linkend="gint">gint</link> len);
47
 
<link linkend="gint">gint</link>        <link linkend="gimp-rgb-list-names">gimp_rgb_list_names</link>             (const <link linkend="gchar">gchar</link> ***names,
48
 
                                             <link linkend="GimpRGB">GimpRGB</link> **colors);
49
 
<link linkend="void">void</link>        <link linkend="gimp-rgb-add">gimp_rgb_add</link>                    (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
50
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgb2);
51
 
<link linkend="void">void</link>        <link linkend="gimp-rgb-subtract">gimp_rgb_subtract</link>               (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
52
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgb2);
53
 
<link linkend="void">void</link>        <link linkend="gimp-rgb-multiply">gimp_rgb_multiply</link>               (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
54
 
                                             <link linkend="gdouble">gdouble</link> factor);
55
 
<link linkend="gdouble">gdouble</link>     <link linkend="gimp-rgb-distance">gimp_rgb_distance</link>               (const <link linkend="GimpRGB">GimpRGB</link> *rgb1,
56
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgb2);
57
 
<link linkend="gdouble">gdouble</link>     <link linkend="gimp-rgb-max">gimp_rgb_max</link>                    (const <link linkend="GimpRGB">GimpRGB</link> *rgb);
58
 
<link linkend="gdouble">gdouble</link>     <link linkend="gimp-rgb-min">gimp_rgb_min</link>                    (const <link linkend="GimpRGB">GimpRGB</link> *rgb);
59
 
<link linkend="void">void</link>        <link linkend="gimp-rgb-clamp">gimp_rgb_clamp</link>                  (<link linkend="GimpRGB">GimpRGB</link> *rgb);
60
 
<link linkend="void">void</link>        <link linkend="gimp-rgb-gamma">gimp_rgb_gamma</link>                  (<link linkend="GimpRGB">GimpRGB</link> *rgb,
61
 
                                             <link linkend="gdouble">gdouble</link> gamma);
62
 
<link linkend="gdouble">gdouble</link>     <link linkend="gimp-rgb-intensity">gimp_rgb_intensity</link>              (const <link linkend="GimpRGB">GimpRGB</link> *rgb);
63
 
<link linkend="guchar">guchar</link>      <link linkend="gimp-rgb-intensity-uchar">gimp_rgb_intensity_uchar</link>        (const <link linkend="GimpRGB">GimpRGB</link> *rgb);
64
 
<link linkend="void">void</link>        <link linkend="gimp-rgb-composite">gimp_rgb_composite</link>              (<link linkend="GimpRGB">GimpRGB</link> *color1,
65
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color2,
66
 
                                             <link linkend="GimpRGBCompositeMode">GimpRGBCompositeMode</link> mode);
67
 
<link linkend="void">void</link>        <link linkend="gimp-rgba-set">gimp_rgba_set</link>                   (<link linkend="GimpRGB">GimpRGB</link> *rgba,
68
 
                                             <link linkend="gdouble">gdouble</link> red,
69
 
                                             <link linkend="gdouble">gdouble</link> green,
70
 
                                             <link linkend="gdouble">gdouble</link> blue,
71
 
                                             <link linkend="gdouble">gdouble</link> alpha);
72
 
<link linkend="void">void</link>        <link linkend="gimp-rgba-set-uchar">gimp_rgba_set_uchar</link>             (<link linkend="GimpRGB">GimpRGB</link> *rgba,
73
 
                                             <link linkend="guchar">guchar</link> red,
74
 
                                             <link linkend="guchar">guchar</link> green,
75
 
                                             <link linkend="guchar">guchar</link> blue,
76
 
                                             <link linkend="guchar">guchar</link> alpha);
77
 
<link linkend="void">void</link>        <link linkend="gimp-rgba-get-uchar">gimp_rgba_get_uchar</link>             (const <link linkend="GimpRGB">GimpRGB</link> *rgba,
78
 
                                             <link linkend="guchar">guchar</link> *red,
79
 
                                             <link linkend="guchar">guchar</link> *green,
80
 
                                             <link linkend="guchar">guchar</link> *blue,
81
 
                                             <link linkend="guchar">guchar</link> *alpha);
82
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-rgba-parse-css">gimp_rgba_parse_css</link>             (<link linkend="GimpRGB">GimpRGB</link> *rgba,
83
 
                                             const <link linkend="gchar">gchar</link> *css,
84
 
                                             <link linkend="gint">gint</link> len);
85
 
<link linkend="void">void</link>        <link linkend="gimp-rgba-add">gimp_rgba_add</link>                   (<link linkend="GimpRGB">GimpRGB</link> *rgba1,
86
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgba2);
87
 
<link linkend="void">void</link>        <link linkend="gimp-rgba-subtract">gimp_rgba_subtract</link>              (<link linkend="GimpRGB">GimpRGB</link> *rgba1,
88
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgba2);
89
 
<link linkend="void">void</link>        <link linkend="gimp-rgba-multiply">gimp_rgba_multiply</link>              (<link linkend="GimpRGB">GimpRGB</link> *rgba,
90
 
                                             <link linkend="gdouble">gdouble</link> factor);
91
 
<link linkend="gdouble">gdouble</link>     <link linkend="gimp-rgba-distance">gimp_rgba_distance</link>              (const <link linkend="GimpRGB">GimpRGB</link> *rgba1,
92
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgba2);
93
 
#define     <link linkend="GIMP-RGB-INTENSITY:CAPS">GIMP_RGB_INTENSITY</link>              (r,g,b)
94
 
#define     <link linkend="GIMP-RGB-INTENSITY-RED:CAPS">GIMP_RGB_INTENSITY_RED</link>
95
 
#define     <link linkend="GIMP-RGB-INTENSITY-GREEN:CAPS">GIMP_RGB_INTENSITY_GREEN</link>
96
 
#define     <link linkend="GIMP-RGB-INTENSITY-BLUE:CAPS">GIMP_RGB_INTENSITY_BLUE</link>
97
 
#define     <link linkend="GIMP-TYPE-RGB:CAPS">GIMP_TYPE_RGB</link>
98
 
#define     <link linkend="GIMP-VALUE-HOLDS-RGB:CAPS">GIMP_VALUE_HOLDS_RGB</link>            (value)
 
25
                    <link linkend="GimpRGB">GimpRGB</link>;
 
26
enum                <link linkend="GimpRGBCompositeMode">GimpRGBCompositeMode</link>;
 
27
<link linkend="void">void</link>                <link linkend="gimp-rgb-set">gimp_rgb_set</link>                        (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
28
                                                         <link linkend="gdouble">gdouble</link> red,
 
29
                                                         <link linkend="gdouble">gdouble</link> green,
 
30
                                                         <link linkend="gdouble">gdouble</link> blue);
 
31
<link linkend="void">void</link>                <link linkend="gimp-rgb-set-alpha">gimp_rgb_set_alpha</link>                  (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
32
                                                         <link linkend="gdouble">gdouble</link> alpha);
 
33
<link linkend="void">void</link>                <link linkend="gimp-rgb-set-uchar">gimp_rgb_set_uchar</link>                  (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
34
                                                         <link linkend="guchar">guchar</link> red,
 
35
                                                         <link linkend="guchar">guchar</link> green,
 
36
                                                         <link linkend="guchar">guchar</link> blue);
 
37
<link linkend="void">void</link>                <link linkend="gimp-rgb-get-uchar">gimp_rgb_get_uchar</link>                  (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
 
38
                                                         <link linkend="guchar">guchar</link> *red,
 
39
                                                         <link linkend="guchar">guchar</link> *green,
 
40
                                                         <link linkend="guchar">guchar</link> *blue);
 
41
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-rgb-parse-name">gimp_rgb_parse_name</link>                 (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
42
                                                         const <link linkend="gchar">gchar</link> *name,
 
43
                                                         <link linkend="gint">gint</link> len);
 
44
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-rgb-parse-hex">gimp_rgb_parse_hex</link>                  (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
45
                                                         const <link linkend="gchar">gchar</link> *hex,
 
46
                                                         <link linkend="gint">gint</link> len);
 
47
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-rgb-parse-css">gimp_rgb_parse_css</link>                  (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
48
                                                         const <link linkend="gchar">gchar</link> *css,
 
49
                                                         <link linkend="gint">gint</link> len);
 
50
<link linkend="gint">gint</link>                <link linkend="gimp-rgb-list-names">gimp_rgb_list_names</link>                 (const <link linkend="gchar">gchar</link> ***names,
 
51
                                                         <link linkend="GimpRGB">GimpRGB</link> **colors);
 
52
<link linkend="void">void</link>                <link linkend="gimp-rgb-add">gimp_rgb_add</link>                        (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
 
53
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgb2);
 
54
<link linkend="void">void</link>                <link linkend="gimp-rgb-subtract">gimp_rgb_subtract</link>                   (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
 
55
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgb2);
 
56
<link linkend="void">void</link>                <link linkend="gimp-rgb-multiply">gimp_rgb_multiply</link>                   (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
 
57
                                                         <link linkend="gdouble">gdouble</link> factor);
 
58
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-rgb-distance">gimp_rgb_distance</link>                   (const <link linkend="GimpRGB">GimpRGB</link> *rgb1,
 
59
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgb2);
 
60
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-rgb-max">gimp_rgb_max</link>                        (const <link linkend="GimpRGB">GimpRGB</link> *rgb);
 
61
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-rgb-min">gimp_rgb_min</link>                        (const <link linkend="GimpRGB">GimpRGB</link> *rgb);
 
62
<link linkend="void">void</link>                <link linkend="gimp-rgb-clamp">gimp_rgb_clamp</link>                      (<link linkend="GimpRGB">GimpRGB</link> *rgb);
 
63
<link linkend="void">void</link>                <link linkend="gimp-rgb-gamma">gimp_rgb_gamma</link>                      (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
64
                                                         <link linkend="gdouble">gdouble</link> gamma);
 
65
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-rgb-luminance">gimp_rgb_luminance</link>                  (const <link linkend="GimpRGB">GimpRGB</link> *rgb);
 
66
<link linkend="guchar">guchar</link>              <link linkend="gimp-rgb-luminance-uchar">gimp_rgb_luminance_uchar</link>            (const <link linkend="GimpRGB">GimpRGB</link> *rgb);
 
67
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-rgb-intensity">gimp_rgb_intensity</link>                  (const <link linkend="GimpRGB">GimpRGB</link> *rgb);
 
68
<link linkend="guchar">guchar</link>              <link linkend="gimp-rgb-intensity-uchar">gimp_rgb_intensity_uchar</link>            (const <link linkend="GimpRGB">GimpRGB</link> *rgb);
 
69
<link linkend="void">void</link>                <link linkend="gimp-rgb-composite">gimp_rgb_composite</link>                  (<link linkend="GimpRGB">GimpRGB</link> *color1,
 
70
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color2,
 
71
                                                         <link linkend="GimpRGBCompositeMode">GimpRGBCompositeMode</link> mode);
 
72
<link linkend="void">void</link>                <link linkend="gimp-rgba-set">gimp_rgba_set</link>                       (<link linkend="GimpRGB">GimpRGB</link> *rgba,
 
73
                                                         <link linkend="gdouble">gdouble</link> red,
 
74
                                                         <link linkend="gdouble">gdouble</link> green,
 
75
                                                         <link linkend="gdouble">gdouble</link> blue,
 
76
                                                         <link linkend="gdouble">gdouble</link> alpha);
 
77
<link linkend="void">void</link>                <link linkend="gimp-rgba-set-uchar">gimp_rgba_set_uchar</link>                 (<link linkend="GimpRGB">GimpRGB</link> *rgba,
 
78
                                                         <link linkend="guchar">guchar</link> red,
 
79
                                                         <link linkend="guchar">guchar</link> green,
 
80
                                                         <link linkend="guchar">guchar</link> blue,
 
81
                                                         <link linkend="guchar">guchar</link> alpha);
 
82
<link linkend="void">void</link>                <link linkend="gimp-rgba-get-uchar">gimp_rgba_get_uchar</link>                 (const <link linkend="GimpRGB">GimpRGB</link> *rgba,
 
83
                                                         <link linkend="guchar">guchar</link> *red,
 
84
                                                         <link linkend="guchar">guchar</link> *green,
 
85
                                                         <link linkend="guchar">guchar</link> *blue,
 
86
                                                         <link linkend="guchar">guchar</link> *alpha);
 
87
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-rgba-parse-css">gimp_rgba_parse_css</link>                 (<link linkend="GimpRGB">GimpRGB</link> *rgba,
 
88
                                                         const <link linkend="gchar">gchar</link> *css,
 
89
                                                         <link linkend="gint">gint</link> len);
 
90
<link linkend="void">void</link>                <link linkend="gimp-rgba-add">gimp_rgba_add</link>                       (<link linkend="GimpRGB">GimpRGB</link> *rgba1,
 
91
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgba2);
 
92
<link linkend="void">void</link>                <link linkend="gimp-rgba-subtract">gimp_rgba_subtract</link>                  (<link linkend="GimpRGB">GimpRGB</link> *rgba1,
 
93
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgba2);
 
94
<link linkend="void">void</link>                <link linkend="gimp-rgba-multiply">gimp_rgba_multiply</link>                  (<link linkend="GimpRGB">GimpRGB</link> *rgba,
 
95
                                                         <link linkend="gdouble">gdouble</link> factor);
 
96
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-rgba-distance">gimp_rgba_distance</link>                  (const <link linkend="GimpRGB">GimpRGB</link> *rgba1,
 
97
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgba2);
 
98
#define             <link linkend="GIMP-RGB-LUMINANCE:CAPS">GIMP_RGB_LUMINANCE</link>                  (r,g,b)
 
99
#define             <link linkend="GIMP-RGB-LUMINANCE-RED:CAPS">GIMP_RGB_LUMINANCE_RED</link>
 
100
#define             <link linkend="GIMP-RGB-LUMINANCE-GREEN:CAPS">GIMP_RGB_LUMINANCE_GREEN</link>
 
101
#define             <link linkend="GIMP-RGB-LUMINANCE-BLUE:CAPS">GIMP_RGB_LUMINANCE_BLUE</link>
 
102
#define             <link linkend="GIMP-RGB-INTENSITY:CAPS">GIMP_RGB_INTENSITY</link>                  (r,g,b)
 
103
#define             <link linkend="GIMP-RGB-INTENSITY-RED:CAPS">GIMP_RGB_INTENSITY_RED</link>
 
104
#define             <link linkend="GIMP-RGB-INTENSITY-GREEN:CAPS">GIMP_RGB_INTENSITY_GREEN</link>
 
105
#define             <link linkend="GIMP-RGB-INTENSITY-BLUE:CAPS">GIMP_RGB_INTENSITY_BLUE</link>
 
106
#define             <link linkend="GIMP-TYPE-RGB:CAPS">GIMP_TYPE_RGB</link>
 
107
#define             <link linkend="GIMP-TYPE-PARAM-RGB:CAPS">GIMP_TYPE_PARAM_RGB</link>
 
108
<link linkend="GParamSpec">GParamSpec</link>*         <link linkend="gimp-param-spec-rgb">gimp_param_spec_rgb</link>                 (const <link linkend="gchar">gchar</link> *name,
 
109
                                                         const <link linkend="gchar">gchar</link> *nick,
 
110
                                                         const <link linkend="gchar">gchar</link> *blurb,
 
111
                                                         <link linkend="gboolean">gboolean</link> has_alpha,
 
112
                                                         const <link linkend="GimpRGB">GimpRGB</link> *default_value,
 
113
                                                         <link linkend="GParamFlags">GParamFlags</link> flags);
 
114
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-param-spec-rgb-has-alpha">gimp_param_spec_rgb_has_alpha</link>       (<link linkend="GParamSpec">GParamSpec</link> *pspec);
 
115
#define             <link linkend="GIMP-VALUE-HOLDS-RGB:CAPS">GIMP_VALUE_HOLDS_RGB</link>                (value)
 
116
<link linkend="void">void</link>                <link linkend="gimp-value-get-rgb">gimp_value_get_rgb</link>                  (const <link linkend="GValue">GValue</link> *value,
 
117
                                                         <link linkend="GimpRGB">GimpRGB</link> *rgb);
 
118
<link linkend="void">void</link>                <link linkend="gimp-value-set-rgb">gimp_value_set_rgb</link>                  (<link linkend="GValue">GValue</link> *value,
 
119
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgb);
99
120
 
100
121
</synopsis>
101
122
</refsynopsisdiv>
108
129
 
109
130
 
110
131
 
111
 
<refsect1>
112
 
<title>Description</title>
 
132
<refsect1 role="desc">
 
133
<title role="desc.title">Description</title>
113
134
<para>
114
135
Definitions and Functions relating to RGB colors.
115
136
</para>
116
137
</refsect1>
117
138
 
118
 
<refsect1>
119
 
<title>Details</title>
 
139
<refsect1 role="details">
 
140
<title role="details.title">Details</title>
120
141
<refsect2>
121
 
<title><anchor id="GimpRGB"/>GimpRGB</title>
 
142
<title><anchor id="GimpRGB" role="struct"/>GimpRGB</title>
122
143
<indexterm><primary>GimpRGB</primary></indexterm><programlisting>typedef struct {
123
144
  gdouble r, g, b, a;
124
145
} GimpRGB;
127
148
 
128
149
</para></refsect2>
129
150
<refsect2>
130
 
<title><anchor id="GimpRGBCompositeMode"/>enum GimpRGBCompositeMode</title>
 
151
<title><anchor id="GimpRGBCompositeMode" role="enum"/>enum GimpRGBCompositeMode</title>
131
152
<indexterm><primary>GimpRGBCompositeMode</primary></indexterm><programlisting>typedef enum
132
153
{
133
154
  GIMP_RGB_COMPOSITE_NONE = 0,
139
160
 
140
161
</para></refsect2>
141
162
<refsect2>
142
 
<title><anchor id="gimp-rgb-set"/>gimp_rgb_set ()</title>
143
 
<indexterm><primary>gimp_rgb_set</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgb_set                    (<link linkend="GimpRGB">GimpRGB</link> *rgb,
144
 
                                             <link linkend="gdouble">gdouble</link> red,
145
 
                                             <link linkend="gdouble">gdouble</link> green,
146
 
                                             <link linkend="gdouble">gdouble</link> blue);</programlisting>
 
163
<title><anchor id="gimp-rgb-set" role="function"/>gimp_rgb_set ()</title>
 
164
<indexterm><primary>gimp_rgb_set</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_set                        (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
165
                                                         <link linkend="gdouble">gdouble</link> red,
 
166
                                                         <link linkend="gdouble">gdouble</link> green,
 
167
                                                         <link linkend="gdouble">gdouble</link> blue);</programlisting>
147
168
<para>
148
169
Sets the red, green and blue components of <parameter>rgb</parameter> and leaves the
149
170
alpha component unchanged. The color values should be between 0.0
166
187
</simpara></listitem></varlistentry>
167
188
</variablelist></refsect2>
168
189
<refsect2>
169
 
<title><anchor id="gimp-rgb-set-alpha"/>gimp_rgb_set_alpha ()</title>
170
 
<indexterm><primary>gimp_rgb_set_alpha</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgb_set_alpha              (<link linkend="GimpRGB">GimpRGB</link> *rgb,
171
 
                                             <link linkend="gdouble">gdouble</link> alpha);</programlisting>
 
190
<title><anchor id="gimp-rgb-set-alpha" role="function"/>gimp_rgb_set_alpha ()</title>
 
191
<indexterm><primary>gimp_rgb_set_alpha</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_set_alpha                  (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
192
                                                         <link linkend="gdouble">gdouble</link> alpha);</programlisting>
172
193
<para>
173
194
Sets the alpha component of <parameter>rgb</parameter> and leaves the RGB components unchanged.</para>
174
195
<para>
182
203
</simpara></listitem></varlistentry>
183
204
</variablelist></refsect2>
184
205
<refsect2>
185
 
<title><anchor id="gimp-rgb-set-uchar"/>gimp_rgb_set_uchar ()</title>
186
 
<indexterm><primary>gimp_rgb_set_uchar</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgb_set_uchar              (<link linkend="GimpRGB">GimpRGB</link> *rgb,
187
 
                                             <link linkend="guchar">guchar</link> red,
188
 
                                             <link linkend="guchar">guchar</link> green,
189
 
                                             <link linkend="guchar">guchar</link> blue);</programlisting>
 
206
<title><anchor id="gimp-rgb-set-uchar" role="function"/>gimp_rgb_set_uchar ()</title>
 
207
<indexterm><primary>gimp_rgb_set_uchar</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_set_uchar                  (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
208
                                                         <link linkend="guchar">guchar</link> red,
 
209
                                                         <link linkend="guchar">guchar</link> green,
 
210
                                                         <link linkend="guchar">guchar</link> blue);</programlisting>
190
211
<para>
191
212
Sets the red, green and blue components of <parameter>rgb</parameter> from 8bit values
192
213
(0 to 255) and leaves the alpha component unchanged.</para>
207
228
</simpara></listitem></varlistentry>
208
229
</variablelist></refsect2>
209
230
<refsect2>
210
 
<title><anchor id="gimp-rgb-get-uchar"/>gimp_rgb_get_uchar ()</title>
211
 
<indexterm><primary>gimp_rgb_get_uchar</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgb_get_uchar              (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
212
 
                                             <link linkend="guchar">guchar</link> *red,
213
 
                                             <link linkend="guchar">guchar</link> *green,
214
 
                                             <link linkend="guchar">guchar</link> *blue);</programlisting>
 
231
<title><anchor id="gimp-rgb-get-uchar" role="function"/>gimp_rgb_get_uchar ()</title>
 
232
<indexterm><primary>gimp_rgb_get_uchar</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_get_uchar                  (const <link linkend="GimpRGB">GimpRGB</link> *rgb,
 
233
                                                         <link linkend="guchar">guchar</link> *red,
 
234
                                                         <link linkend="guchar">guchar</link> *green,
 
235
                                                         <link linkend="guchar">guchar</link> *blue);</programlisting>
215
236
<para>
216
237
 
217
238
</para><variablelist role="params">
231
252
</simpara></listitem></varlistentry>
232
253
</variablelist></refsect2>
233
254
<refsect2>
234
 
<title><anchor id="gimp-rgb-parse-name"/>gimp_rgb_parse_name ()</title>
235
 
<indexterm role="GIMP 2.2"><primary>gimp_rgb_parse_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_rgb_parse_name             (<link linkend="GimpRGB">GimpRGB</link> *rgb,
236
 
                                             const <link linkend="gchar">gchar</link> *name,
237
 
                                             <link linkend="gint">gint</link> len);</programlisting>
 
255
<title><anchor id="gimp-rgb-parse-name" role="function" condition="since:GIMP 2.2"/>gimp_rgb_parse_name ()</title>
 
256
<indexterm role="GIMP 2.2"><primary>gimp_rgb_parse_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_rgb_parse_name                 (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
257
                                                         const <link linkend="gchar">gchar</link> *name,
 
258
                                                         <link linkend="gint">gint</link> len);</programlisting>
238
259
<para>
239
260
Attempts to parse a color name. This function accepts RGB hex
240
261
values or <ulink url="http://www.w3.org/TR/SVG/types.html">SVG 1.0
243
264
hexadecimal characters.
244
265
</para>
245
266
<para>
246
 
This funcion does not touch the alpha component of <parameter>rgb</parameter>.</para>
 
267
This function does not touch the alpha component of <parameter>rgb</parameter>.</para>
247
268
<para>
248
269
 
249
270
</para><variablelist role="params">
256
277
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
257
278
<listitem><simpara>  the length of <parameter>name</parameter>, in bytes. or -1 if <parameter>name</parameter> is nul-terminated
258
279
</simpara></listitem></varlistentry>
259
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if <parameter>name</parameter> was parsed successfully and <parameter>rgb</parameter> has been
260
 
              set, <literal>FALSE</literal> otherwise
 
280
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>name</parameter> was parsed successfully and <parameter>rgb</parameter> has been
 
281
              set, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
261
282
 
262
283
</simpara></listitem></varlistentry>
263
 
</variablelist><para>Since  GIMP 2.2
 
284
</variablelist><para role="since">Since  GIMP 2.2
264
285
</para></refsect2>
265
286
<refsect2>
266
 
<title><anchor id="gimp-rgb-parse-hex"/>gimp_rgb_parse_hex ()</title>
267
 
<indexterm role="GIMP 2.2"><primary>gimp_rgb_parse_hex</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_rgb_parse_hex              (<link linkend="GimpRGB">GimpRGB</link> *rgb,
268
 
                                             const <link linkend="gchar">gchar</link> *hex,
269
 
                                             <link linkend="gint">gint</link> len);</programlisting>
 
287
<title><anchor id="gimp-rgb-parse-hex" role="function" condition="since:GIMP 2.2"/>gimp_rgb_parse_hex ()</title>
 
288
<indexterm role="GIMP 2.2"><primary>gimp_rgb_parse_hex</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_rgb_parse_hex                  (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
289
                                                         const <link linkend="gchar">gchar</link> *hex,
 
290
                                                         <link linkend="gint">gint</link> len);</programlisting>
270
291
<para>
271
292
Attempts to parse a string describing a color in RGB value in
272
293
hexadecimal notation (optionally prefixed with a '#').
273
294
</para>
274
295
<para>
275
 
This funcion does not touch the alpha component of <parameter>rgb</parameter>.</para>
 
296
This function does not touch the alpha component of <parameter>rgb</parameter>.</para>
276
297
<para>
277
298
 
278
299
</para><variablelist role="params">
285
306
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
286
307
<listitem><simpara> the length of <parameter>hex</parameter>, in bytes. or -1 if <parameter>hex</parameter> is nul-terminated
287
308
</simpara></listitem></varlistentry>
288
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if <parameter>hex</parameter> was parsed successfully and <parameter>rgb</parameter> has been
289
 
              set, <literal>FALSE</literal> otherwise
 
309
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>hex</parameter> was parsed successfully and <parameter>rgb</parameter> has been
 
310
              set, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
290
311
 
291
312
</simpara></listitem></varlistentry>
292
 
</variablelist><para>Since  GIMP 2.2
 
313
</variablelist><para role="since">Since  GIMP 2.2
293
314
</para></refsect2>
294
315
<refsect2>
295
 
<title><anchor id="gimp-rgb-parse-css"/>gimp_rgb_parse_css ()</title>
296
 
<indexterm role="GIMP 2.2"><primary>gimp_rgb_parse_css</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_rgb_parse_css              (<link linkend="GimpRGB">GimpRGB</link> *rgb,
297
 
                                             const <link linkend="gchar">gchar</link> *css,
298
 
                                             <link linkend="gint">gint</link> len);</programlisting>
 
316
<title><anchor id="gimp-rgb-parse-css" role="function" condition="since:GIMP 2.2"/>gimp_rgb_parse_css ()</title>
 
317
<indexterm role="GIMP 2.2"><primary>gimp_rgb_parse_css</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_rgb_parse_css                  (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
318
                                                         const <link linkend="gchar">gchar</link> *css,
 
319
                                                         <link linkend="gint">gint</link> len);</programlisting>
299
320
<para>
300
321
Attempts to parse a string describing a color in RGB value in CSS
301
322
notation. This can be either a numerical representation
305
326
<link linkend="gimp-rgb-parse-name"><function>gimp_rgb_parse_name()</function></link> (<code>red</code>).
306
327
</para>
307
328
<para>
308
 
This funcion does not touch the alpha component of <parameter>rgb</parameter>.</para>
 
329
This function does not touch the alpha component of <parameter>rgb</parameter>.</para>
309
330
<para>
310
331
 
311
332
</para><variablelist role="params">
318
339
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
319
340
<listitem><simpara> the length of <parameter>hex</parameter>, in bytes. or -1 if <parameter>hex</parameter> is nul-terminated
320
341
</simpara></listitem></varlistentry>
321
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if <parameter>css</parameter> was parsed successfully and <parameter>rgb</parameter> has been
322
 
              set, <literal>FALSE</literal> otherwise
 
342
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>css</parameter> was parsed successfully and <parameter>rgb</parameter> has been
 
343
              set, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
323
344
 
324
345
</simpara></listitem></varlistentry>
325
 
</variablelist><para>Since  GIMP 2.2
 
346
</variablelist><para role="since">Since  GIMP 2.2
326
347
</para></refsect2>
327
348
<refsect2>
328
 
<title><anchor id="gimp-rgb-list-names"/>gimp_rgb_list_names ()</title>
329
 
<indexterm role="GIMP 2.2"><primary>gimp_rgb_list_names</primary></indexterm><programlisting><link linkend="gint">gint</link>        gimp_rgb_list_names             (const <link linkend="gchar">gchar</link> ***names,
330
 
                                             <link linkend="GimpRGB">GimpRGB</link> **colors);</programlisting>
 
349
<title><anchor id="gimp-rgb-list-names" role="function" condition="since:GIMP 2.2"/>gimp_rgb_list_names ()</title>
 
350
<indexterm role="GIMP 2.2"><primary>gimp_rgb_list_names</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_rgb_list_names                 (const <link linkend="gchar">gchar</link> ***names,
 
351
                                                         <link linkend="GimpRGB">GimpRGB</link> **colors);</programlisting>
331
352
<para>
332
353
Allows to retrieve the list of <ulink
333
354
url="http://www.w3.org/TR/SVG/types.html">SVG 1.0 color
350
371
              (i.e. the length of the returned arrays)
351
372
 
352
373
</simpara></listitem></varlistentry>
353
 
</variablelist><para>Since  GIMP 2.2
 
374
</variablelist><para role="since">Since  GIMP 2.2
354
375
</para></refsect2>
355
376
<refsect2>
356
 
<title><anchor id="gimp-rgb-add"/>gimp_rgb_add ()</title>
357
 
<indexterm><primary>gimp_rgb_add</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgb_add                    (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
358
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgb2);</programlisting>
359
 
<para>
360
 
 
361
 
</para><variablelist role="params">
362
 
<varlistentry><term><parameter>rgb1</parameter>&nbsp;:</term>
363
 
<listitem><simpara>
364
 
</simpara></listitem></varlistentry>
365
 
<varlistentry><term><parameter>rgb2</parameter>&nbsp;:</term>
366
 
<listitem><simpara>
367
 
 
368
 
 
369
 
</simpara></listitem></varlistentry>
370
 
</variablelist></refsect2>
371
 
<refsect2>
372
 
<title><anchor id="gimp-rgb-subtract"/>gimp_rgb_subtract ()</title>
373
 
<indexterm><primary>gimp_rgb_subtract</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgb_subtract               (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
374
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgb2);</programlisting>
375
 
<para>
376
 
 
377
 
</para><variablelist role="params">
378
 
<varlistentry><term><parameter>rgb1</parameter>&nbsp;:</term>
379
 
<listitem><simpara>
380
 
</simpara></listitem></varlistentry>
381
 
<varlistentry><term><parameter>rgb2</parameter>&nbsp;:</term>
382
 
<listitem><simpara>
383
 
 
384
 
 
385
 
</simpara></listitem></varlistentry>
386
 
</variablelist></refsect2>
387
 
<refsect2>
388
 
<title><anchor id="gimp-rgb-multiply"/>gimp_rgb_multiply ()</title>
389
 
<indexterm><primary>gimp_rgb_multiply</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgb_multiply               (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
390
 
                                             <link linkend="gdouble">gdouble</link> factor);</programlisting>
 
377
<title><anchor id="gimp-rgb-add" role="function"/>gimp_rgb_add ()</title>
 
378
<indexterm><primary>gimp_rgb_add</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_add                        (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
 
379
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgb2);</programlisting>
 
380
<para>
 
381
 
 
382
</para><variablelist role="params">
 
383
<varlistentry><term><parameter>rgb1</parameter>&nbsp;:</term>
 
384
<listitem><simpara>
 
385
</simpara></listitem></varlistentry>
 
386
<varlistentry><term><parameter>rgb2</parameter>&nbsp;:</term>
 
387
<listitem><simpara>
 
388
 
 
389
 
 
390
</simpara></listitem></varlistentry>
 
391
</variablelist></refsect2>
 
392
<refsect2>
 
393
<title><anchor id="gimp-rgb-subtract" role="function"/>gimp_rgb_subtract ()</title>
 
394
<indexterm><primary>gimp_rgb_subtract</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_subtract                   (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
 
395
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgb2);</programlisting>
 
396
<para>
 
397
 
 
398
</para><variablelist role="params">
 
399
<varlistentry><term><parameter>rgb1</parameter>&nbsp;:</term>
 
400
<listitem><simpara>
 
401
</simpara></listitem></varlistentry>
 
402
<varlistentry><term><parameter>rgb2</parameter>&nbsp;:</term>
 
403
<listitem><simpara>
 
404
 
 
405
 
 
406
</simpara></listitem></varlistentry>
 
407
</variablelist></refsect2>
 
408
<refsect2>
 
409
<title><anchor id="gimp-rgb-multiply" role="function"/>gimp_rgb_multiply ()</title>
 
410
<indexterm><primary>gimp_rgb_multiply</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_multiply                   (<link linkend="GimpRGB">GimpRGB</link> *rgb1,
 
411
                                                         <link linkend="gdouble">gdouble</link> factor);</programlisting>
391
412
<para>
392
413
 
393
414
</para><variablelist role="params">
401
422
</simpara></listitem></varlistentry>
402
423
</variablelist></refsect2>
403
424
<refsect2>
404
 
<title><anchor id="gimp-rgb-distance"/>gimp_rgb_distance ()</title>
405
 
<indexterm><primary>gimp_rgb_distance</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>     gimp_rgb_distance               (const <link linkend="GimpRGB">GimpRGB</link> *rgb1,
406
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgb2);</programlisting>
 
425
<title><anchor id="gimp-rgb-distance" role="function"/>gimp_rgb_distance ()</title>
 
426
<indexterm><primary>gimp_rgb_distance</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_rgb_distance                   (const <link linkend="GimpRGB">GimpRGB</link> *rgb1,
 
427
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgb2);</programlisting>
407
428
<para>
408
429
 
409
430
</para><variablelist role="params">
419
440
</simpara></listitem></varlistentry>
420
441
</variablelist></refsect2>
421
442
<refsect2>
422
 
<title><anchor id="gimp-rgb-max"/>gimp_rgb_max ()</title>
423
 
<indexterm><primary>gimp_rgb_max</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>     gimp_rgb_max                    (const <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
424
 
<para>
425
 
 
426
 
</para><variablelist role="params">
427
 
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
428
 
<listitem><simpara>
429
 
</simpara></listitem></varlistentry>
430
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
431
 
 
432
 
 
433
 
</simpara></listitem></varlistentry>
434
 
</variablelist></refsect2>
435
 
<refsect2>
436
 
<title><anchor id="gimp-rgb-min"/>gimp_rgb_min ()</title>
437
 
<indexterm><primary>gimp_rgb_min</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>     gimp_rgb_min                    (const <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
438
 
<para>
439
 
 
440
 
</para><variablelist role="params">
441
 
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
442
 
<listitem><simpara>
443
 
</simpara></listitem></varlistentry>
444
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
445
 
 
446
 
 
447
 
</simpara></listitem></varlistentry>
448
 
</variablelist></refsect2>
449
 
<refsect2>
450
 
<title><anchor id="gimp-rgb-clamp"/>gimp_rgb_clamp ()</title>
451
 
<indexterm><primary>gimp_rgb_clamp</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgb_clamp                  (<link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
452
 
<para>
453
 
 
454
 
</para><variablelist role="params">
455
 
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
456
 
<listitem><simpara>
457
 
 
458
 
 
459
 
</simpara></listitem></varlistentry>
460
 
</variablelist></refsect2>
461
 
<refsect2>
462
 
<title><anchor id="gimp-rgb-gamma"/>gimp_rgb_gamma ()</title>
463
 
<indexterm><primary>gimp_rgb_gamma</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgb_gamma                  (<link linkend="GimpRGB">GimpRGB</link> *rgb,
464
 
                                             <link linkend="gdouble">gdouble</link> gamma);</programlisting>
 
443
<title><anchor id="gimp-rgb-max" role="function"/>gimp_rgb_max ()</title>
 
444
<indexterm><primary>gimp_rgb_max</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_rgb_max                        (const <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
 
445
<para>
 
446
 
 
447
</para><variablelist role="params">
 
448
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
 
449
<listitem><simpara>
 
450
</simpara></listitem></varlistentry>
 
451
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
452
 
 
453
 
 
454
</simpara></listitem></varlistentry>
 
455
</variablelist></refsect2>
 
456
<refsect2>
 
457
<title><anchor id="gimp-rgb-min" role="function"/>gimp_rgb_min ()</title>
 
458
<indexterm><primary>gimp_rgb_min</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_rgb_min                        (const <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
 
459
<para>
 
460
 
 
461
</para><variablelist role="params">
 
462
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
 
463
<listitem><simpara>
 
464
</simpara></listitem></varlistentry>
 
465
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
466
 
 
467
 
 
468
</simpara></listitem></varlistentry>
 
469
</variablelist></refsect2>
 
470
<refsect2>
 
471
<title><anchor id="gimp-rgb-clamp" role="function"/>gimp_rgb_clamp ()</title>
 
472
<indexterm><primary>gimp_rgb_clamp</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_clamp                      (<link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
 
473
<para>
 
474
 
 
475
</para><variablelist role="params">
 
476
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
 
477
<listitem><simpara>
 
478
 
 
479
 
 
480
</simpara></listitem></varlistentry>
 
481
</variablelist></refsect2>
 
482
<refsect2>
 
483
<title><anchor id="gimp-rgb-gamma" role="function"/>gimp_rgb_gamma ()</title>
 
484
<indexterm><primary>gimp_rgb_gamma</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_gamma                      (<link linkend="GimpRGB">GimpRGB</link> *rgb,
 
485
                                                         <link linkend="gdouble">gdouble</link> gamma);</programlisting>
465
486
<para>
466
487
 
467
488
</para><variablelist role="params">
475
496
</simpara></listitem></varlistentry>
476
497
</variablelist></refsect2>
477
498
<refsect2>
478
 
<title><anchor id="gimp-rgb-intensity"/>gimp_rgb_intensity ()</title>
479
 
<indexterm><primary>gimp_rgb_intensity</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>     gimp_rgb_intensity              (const <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
480
 
<para>
481
 
 
482
 
</para><variablelist role="params">
483
 
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
484
 
<listitem><simpara>
485
 
</simpara></listitem></varlistentry>
486
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
487
 
 
488
 
 
489
 
</simpara></listitem></varlistentry>
490
 
</variablelist></refsect2>
491
 
<refsect2>
492
 
<title><anchor id="gimp-rgb-intensity-uchar"/>gimp_rgb_intensity_uchar ()</title>
493
 
<indexterm><primary>gimp_rgb_intensity_uchar</primary></indexterm><programlisting><link linkend="guchar">guchar</link>      gimp_rgb_intensity_uchar        (const <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
494
 
<para>
495
 
 
496
 
</para><variablelist role="params">
497
 
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
498
 
<listitem><simpara>
499
 
</simpara></listitem></varlistentry>
500
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
501
 
 
502
 
 
503
 
</simpara></listitem></varlistentry>
504
 
</variablelist></refsect2>
505
 
<refsect2>
506
 
<title><anchor id="gimp-rgb-composite"/>gimp_rgb_composite ()</title>
507
 
<indexterm><primary>gimp_rgb_composite</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgb_composite              (<link linkend="GimpRGB">GimpRGB</link> *color1,
508
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color2,
509
 
                                             <link linkend="GimpRGBCompositeMode">GimpRGBCompositeMode</link> mode);</programlisting>
 
499
<title><anchor id="gimp-rgb-luminance" role="function" condition="since:GIMP 2.4"/>gimp_rgb_luminance ()</title>
 
500
<indexterm role="GIMP 2.4"><primary>gimp_rgb_luminance</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_rgb_luminance                  (const <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
 
501
<para>
 
502
</para>
 
503
<para>
 
504
 
 
505
</para><variablelist role="params">
 
506
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
 
507
<listitem><simpara>
 
508
</simpara></listitem></varlistentry>
 
509
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the luminous intensity of the range from 0.0 to 1.0.
 
510
 
 
511
</simpara></listitem></varlistentry>
 
512
</variablelist><para role="since">Since  GIMP 2.4
 
513
</para></refsect2>
 
514
<refsect2>
 
515
<title><anchor id="gimp-rgb-luminance-uchar" role="function" condition="since:GIMP 2.4"/>gimp_rgb_luminance_uchar ()</title>
 
516
<indexterm role="GIMP 2.4"><primary>gimp_rgb_luminance_uchar</primary></indexterm><programlisting><link linkend="guchar">guchar</link>              gimp_rgb_luminance_uchar            (const <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
 
517
<para>
 
518
</para>
 
519
<para>
 
520
 
 
521
</para><variablelist role="params">
 
522
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
 
523
<listitem><simpara>
 
524
</simpara></listitem></varlistentry>
 
525
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the luminous intensity in the range from 0 to 255.
 
526
 
 
527
</simpara></listitem></varlistentry>
 
528
</variablelist><para role="since">Since  GIMP 2.4
 
529
</para></refsect2>
 
530
<refsect2>
 
531
<title><anchor id="gimp-rgb-intensity" role="function" condition="deprecated:"/>gimp_rgb_intensity ()</title>
 
532
<indexterm role="deprecated"><primary>gimp_rgb_intensity</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_rgb_intensity                  (const <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
 
533
<warning><para><literal>gimp_rgb_intensity</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
534
<para>
 
535
This function is deprecated! Use <link linkend="gimp-rgb-luminance"><function>gimp_rgb_luminance()</function></link> instead.</para>
 
536
<para>
 
537
 
 
538
</para><variablelist role="params">
 
539
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
 
540
<listitem><simpara>
 
541
</simpara></listitem></varlistentry>
 
542
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the intensity in the range from 0.0 to 1.0.
 
543
</simpara></listitem></varlistentry>
 
544
</variablelist></refsect2>
 
545
<refsect2>
 
546
<title><anchor id="gimp-rgb-intensity-uchar" role="function" condition="deprecated:"/>gimp_rgb_intensity_uchar ()</title>
 
547
<indexterm role="deprecated"><primary>gimp_rgb_intensity_uchar</primary></indexterm><programlisting><link linkend="guchar">guchar</link>              gimp_rgb_intensity_uchar            (const <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
 
548
<warning><para><literal>gimp_rgb_intensity_uchar</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
549
<para>
 
550
This function is deprecated! Use <link linkend="gimp-rgb-luminance-uchar"><function>gimp_rgb_luminance_uchar()</function></link> instead.</para>
 
551
<para>
 
552
 
 
553
</para><variablelist role="params">
 
554
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
 
555
<listitem><simpara>
 
556
</simpara></listitem></varlistentry>
 
557
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the intensity in the range from 0 to 255.
 
558
</simpara></listitem></varlistentry>
 
559
</variablelist></refsect2>
 
560
<refsect2>
 
561
<title><anchor id="gimp-rgb-composite" role="function"/>gimp_rgb_composite ()</title>
 
562
<indexterm><primary>gimp_rgb_composite</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgb_composite                  (<link linkend="GimpRGB">GimpRGB</link> *color1,
 
563
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color2,
 
564
                                                         <link linkend="GimpRGBCompositeMode">GimpRGBCompositeMode</link> mode);</programlisting>
510
565
<para>
511
566
 
512
567
</para><variablelist role="params">
523
578
</simpara></listitem></varlistentry>
524
579
</variablelist></refsect2>
525
580
<refsect2>
526
 
<title><anchor id="gimp-rgba-set"/>gimp_rgba_set ()</title>
527
 
<indexterm><primary>gimp_rgba_set</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgba_set                   (<link linkend="GimpRGB">GimpRGB</link> *rgba,
528
 
                                             <link linkend="gdouble">gdouble</link> red,
529
 
                                             <link linkend="gdouble">gdouble</link> green,
530
 
                                             <link linkend="gdouble">gdouble</link> blue,
531
 
                                             <link linkend="gdouble">gdouble</link> alpha);</programlisting>
 
581
<title><anchor id="gimp-rgba-set" role="function"/>gimp_rgba_set ()</title>
 
582
<indexterm><primary>gimp_rgba_set</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgba_set                       (<link linkend="GimpRGB">GimpRGB</link> *rgba,
 
583
                                                         <link linkend="gdouble">gdouble</link> red,
 
584
                                                         <link linkend="gdouble">gdouble</link> green,
 
585
                                                         <link linkend="gdouble">gdouble</link> blue,
 
586
                                                         <link linkend="gdouble">gdouble</link> alpha);</programlisting>
532
587
<para>
533
588
Sets the red, green, blue and alpha components of <parameter>rgb</parameter>. The values
534
589
should be between 0.0 and 1.0 but there is no check to enforce this
553
608
</simpara></listitem></varlistentry>
554
609
</variablelist></refsect2>
555
610
<refsect2>
556
 
<title><anchor id="gimp-rgba-set-uchar"/>gimp_rgba_set_uchar ()</title>
557
 
<indexterm><primary>gimp_rgba_set_uchar</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgba_set_uchar             (<link linkend="GimpRGB">GimpRGB</link> *rgba,
558
 
                                             <link linkend="guchar">guchar</link> red,
559
 
                                             <link linkend="guchar">guchar</link> green,
560
 
                                             <link linkend="guchar">guchar</link> blue,
561
 
                                             <link linkend="guchar">guchar</link> alpha);</programlisting>
 
611
<title><anchor id="gimp-rgba-set-uchar" role="function"/>gimp_rgba_set_uchar ()</title>
 
612
<indexterm><primary>gimp_rgba_set_uchar</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgba_set_uchar                 (<link linkend="GimpRGB">GimpRGB</link> *rgba,
 
613
                                                         <link linkend="guchar">guchar</link> red,
 
614
                                                         <link linkend="guchar">guchar</link> green,
 
615
                                                         <link linkend="guchar">guchar</link> blue,
 
616
                                                         <link linkend="guchar">guchar</link> alpha);</programlisting>
562
617
<para>
563
618
Sets the red, green, blue and alpha components of <parameter>rgb</parameter> from 8bit
564
619
values (0 to 255).</para>
582
637
</simpara></listitem></varlistentry>
583
638
</variablelist></refsect2>
584
639
<refsect2>
585
 
<title><anchor id="gimp-rgba-get-uchar"/>gimp_rgba_get_uchar ()</title>
586
 
<indexterm><primary>gimp_rgba_get_uchar</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgba_get_uchar             (const <link linkend="GimpRGB">GimpRGB</link> *rgba,
587
 
                                             <link linkend="guchar">guchar</link> *red,
588
 
                                             <link linkend="guchar">guchar</link> *green,
589
 
                                             <link linkend="guchar">guchar</link> *blue,
590
 
                                             <link linkend="guchar">guchar</link> *alpha);</programlisting>
 
640
<title><anchor id="gimp-rgba-get-uchar" role="function"/>gimp_rgba_get_uchar ()</title>
 
641
<indexterm><primary>gimp_rgba_get_uchar</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgba_get_uchar                 (const <link linkend="GimpRGB">GimpRGB</link> *rgba,
 
642
                                                         <link linkend="guchar">guchar</link> *red,
 
643
                                                         <link linkend="guchar">guchar</link> *green,
 
644
                                                         <link linkend="guchar">guchar</link> *blue,
 
645
                                                         <link linkend="guchar">guchar</link> *alpha);</programlisting>
591
646
<para>
592
647
 
593
648
</para><variablelist role="params">
610
665
</simpara></listitem></varlistentry>
611
666
</variablelist></refsect2>
612
667
<refsect2>
613
 
<title><anchor id="gimp-rgba-parse-css"/>gimp_rgba_parse_css ()</title>
614
 
<indexterm role="GIMP 2.2"><primary>gimp_rgba_parse_css</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_rgba_parse_css             (<link linkend="GimpRGB">GimpRGB</link> *rgba,
615
 
                                             const <link linkend="gchar">gchar</link> *css,
616
 
                                             <link linkend="gint">gint</link> len);</programlisting>
 
668
<title><anchor id="gimp-rgba-parse-css" role="function" condition="since:GIMP 2.2"/>gimp_rgba_parse_css ()</title>
 
669
<indexterm role="GIMP 2.2"><primary>gimp_rgba_parse_css</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_rgba_parse_css                 (<link linkend="GimpRGB">GimpRGB</link> *rgba,
 
670
                                                         const <link linkend="gchar">gchar</link> *css,
 
671
                                                         <link linkend="gint">gint</link> len);</programlisting>
617
672
<para>
618
673
Similar to <link linkend="gimp-rgb-parse-css"><function>gimp_rgb_parse_css()</function></link> but handles RGB colors with alpha
619
674
channel in the numerical CSS notation (<code>rgba(255,0,0,255)</code>
634
689
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
635
690
<listitem><simpara> the length of <parameter>hex</parameter>, in bytes. or -1 if <parameter>hex</parameter> is nul-terminated
636
691
</simpara></listitem></varlistentry>
637
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if <parameter>css</parameter> was parsed successfully and <parameter>rgb</parameter> has been
638
 
              set, <literal>FALSE</literal> otherwise
 
692
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>css</parameter> was parsed successfully and <parameter>rgb</parameter> has been
 
693
              set, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
639
694
 
640
695
</simpara></listitem></varlistentry>
641
 
</variablelist><para>Since  GIMP 2.2
 
696
</variablelist><para role="since">Since  GIMP 2.2
642
697
</para></refsect2>
643
698
<refsect2>
644
 
<title><anchor id="gimp-rgba-add"/>gimp_rgba_add ()</title>
645
 
<indexterm><primary>gimp_rgba_add</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgba_add                   (<link linkend="GimpRGB">GimpRGB</link> *rgba1,
646
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgba2);</programlisting>
647
 
<para>
648
 
 
649
 
</para><variablelist role="params">
650
 
<varlistentry><term><parameter>rgba1</parameter>&nbsp;:</term>
651
 
<listitem><simpara>
652
 
</simpara></listitem></varlistentry>
653
 
<varlistentry><term><parameter>rgba2</parameter>&nbsp;:</term>
654
 
<listitem><simpara>
655
 
 
656
 
 
657
 
</simpara></listitem></varlistentry>
658
 
</variablelist></refsect2>
659
 
<refsect2>
660
 
<title><anchor id="gimp-rgba-subtract"/>gimp_rgba_subtract ()</title>
661
 
<indexterm><primary>gimp_rgba_subtract</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgba_subtract              (<link linkend="GimpRGB">GimpRGB</link> *rgba1,
662
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgba2);</programlisting>
663
 
<para>
664
 
 
665
 
</para><variablelist role="params">
666
 
<varlistentry><term><parameter>rgba1</parameter>&nbsp;:</term>
667
 
<listitem><simpara>
668
 
</simpara></listitem></varlistentry>
669
 
<varlistentry><term><parameter>rgba2</parameter>&nbsp;:</term>
670
 
<listitem><simpara>
671
 
 
672
 
 
673
 
</simpara></listitem></varlistentry>
674
 
</variablelist></refsect2>
675
 
<refsect2>
676
 
<title><anchor id="gimp-rgba-multiply"/>gimp_rgba_multiply ()</title>
677
 
<indexterm><primary>gimp_rgba_multiply</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_rgba_multiply              (<link linkend="GimpRGB">GimpRGB</link> *rgba,
678
 
                                             <link linkend="gdouble">gdouble</link> factor);</programlisting>
 
699
<title><anchor id="gimp-rgba-add" role="function"/>gimp_rgba_add ()</title>
 
700
<indexterm><primary>gimp_rgba_add</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgba_add                       (<link linkend="GimpRGB">GimpRGB</link> *rgba1,
 
701
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgba2);</programlisting>
 
702
<para>
 
703
 
 
704
</para><variablelist role="params">
 
705
<varlistentry><term><parameter>rgba1</parameter>&nbsp;:</term>
 
706
<listitem><simpara>
 
707
</simpara></listitem></varlistentry>
 
708
<varlistentry><term><parameter>rgba2</parameter>&nbsp;:</term>
 
709
<listitem><simpara>
 
710
 
 
711
 
 
712
</simpara></listitem></varlistentry>
 
713
</variablelist></refsect2>
 
714
<refsect2>
 
715
<title><anchor id="gimp-rgba-subtract" role="function"/>gimp_rgba_subtract ()</title>
 
716
<indexterm><primary>gimp_rgba_subtract</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgba_subtract                  (<link linkend="GimpRGB">GimpRGB</link> *rgba1,
 
717
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgba2);</programlisting>
 
718
<para>
 
719
 
 
720
</para><variablelist role="params">
 
721
<varlistentry><term><parameter>rgba1</parameter>&nbsp;:</term>
 
722
<listitem><simpara>
 
723
</simpara></listitem></varlistentry>
 
724
<varlistentry><term><parameter>rgba2</parameter>&nbsp;:</term>
 
725
<listitem><simpara>
 
726
 
 
727
 
 
728
</simpara></listitem></varlistentry>
 
729
</variablelist></refsect2>
 
730
<refsect2>
 
731
<title><anchor id="gimp-rgba-multiply" role="function"/>gimp_rgba_multiply ()</title>
 
732
<indexterm><primary>gimp_rgba_multiply</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_rgba_multiply                  (<link linkend="GimpRGB">GimpRGB</link> *rgba,
 
733
                                                         <link linkend="gdouble">gdouble</link> factor);</programlisting>
679
734
<para>
680
735
 
681
736
</para><variablelist role="params">
689
744
</simpara></listitem></varlistentry>
690
745
</variablelist></refsect2>
691
746
<refsect2>
692
 
<title><anchor id="gimp-rgba-distance"/>gimp_rgba_distance ()</title>
693
 
<indexterm><primary>gimp_rgba_distance</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>     gimp_rgba_distance              (const <link linkend="GimpRGB">GimpRGB</link> *rgba1,
694
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *rgba2);</programlisting>
 
747
<title><anchor id="gimp-rgba-distance" role="function"/>gimp_rgba_distance ()</title>
 
748
<indexterm><primary>gimp_rgba_distance</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_rgba_distance                  (const <link linkend="GimpRGB">GimpRGB</link> *rgba1,
 
749
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgba2);</programlisting>
695
750
<para>
696
751
 
697
752
</para><variablelist role="params">
707
762
</simpara></listitem></varlistentry>
708
763
</variablelist></refsect2>
709
764
<refsect2>
710
 
<title><anchor id="GIMP-RGB-INTENSITY:CAPS"/>GIMP_RGB_INTENSITY()</title>
711
 
<indexterm><primary>GIMP_RGB_INTENSITY</primary></indexterm><programlisting>#define     GIMP_RGB_INTENSITY(r,g,b)</programlisting>
 
765
<title><anchor id="GIMP-RGB-LUMINANCE:CAPS" role="macro"/>GIMP_RGB_LUMINANCE()</title>
 
766
<indexterm><primary>GIMP_RGB_LUMINANCE</primary></indexterm><programlisting>#define             GIMP_RGB_LUMINANCE(r,g,b)</programlisting>
 
767
<para>
 
768
 
 
769
</para><variablelist role="params">
 
770
<varlistentry><term><parameter>r</parameter>&nbsp;:</term>
 
771
<listitem><simpara>
 
772
</simpara></listitem></varlistentry>
 
773
<varlistentry><term><parameter>g</parameter>&nbsp;:</term>
 
774
<listitem><simpara>
 
775
</simpara></listitem></varlistentry>
 
776
<varlistentry><term><parameter>b</parameter>&nbsp;:</term>
 
777
<listitem><simpara>
 
778
 
 
779
 
 
780
</simpara></listitem></varlistentry>
 
781
</variablelist></refsect2>
 
782
<refsect2>
 
783
<title><anchor id="GIMP-RGB-LUMINANCE-RED:CAPS" role="macro"/>GIMP_RGB_LUMINANCE_RED</title>
 
784
<indexterm><primary>GIMP_RGB_LUMINANCE_RED</primary></indexterm><programlisting>#define GIMP_RGB_LUMINANCE_RED    (0.2126)
 
785
</programlisting>
 
786
<para>
 
787
 
 
788
</para></refsect2>
 
789
<refsect2>
 
790
<title><anchor id="GIMP-RGB-LUMINANCE-GREEN:CAPS" role="macro"/>GIMP_RGB_LUMINANCE_GREEN</title>
 
791
<indexterm><primary>GIMP_RGB_LUMINANCE_GREEN</primary></indexterm><programlisting>#define GIMP_RGB_LUMINANCE_GREEN  (0.7152)
 
792
</programlisting>
 
793
<para>
 
794
 
 
795
</para></refsect2>
 
796
<refsect2>
 
797
<title><anchor id="GIMP-RGB-LUMINANCE-BLUE:CAPS" role="macro"/>GIMP_RGB_LUMINANCE_BLUE</title>
 
798
<indexterm><primary>GIMP_RGB_LUMINANCE_BLUE</primary></indexterm><programlisting>#define GIMP_RGB_LUMINANCE_BLUE   (0.0722)
 
799
</programlisting>
 
800
<para>
 
801
 
 
802
</para></refsect2>
 
803
<refsect2>
 
804
<title><anchor id="GIMP-RGB-INTENSITY:CAPS" role="macro" condition="deprecated:"/>GIMP_RGB_INTENSITY()</title>
 
805
<indexterm role="deprecated"><primary>GIMP_RGB_INTENSITY</primary></indexterm><programlisting>#define             GIMP_RGB_INTENSITY(r,g,b)</programlisting>
 
806
<warning><para><literal>GIMP_RGB_INTENSITY</literal> is deprecated and should not be used in newly-written code.</para></warning>
712
807
<para>
713
808
This macro calculates the intensity of an RGB value based on
714
809
coefficients taken from the NTSC analog television standard.
726
821
</simpara></listitem></varlistentry>
727
822
</variablelist></refsect2>
728
823
<refsect2>
729
 
<title><anchor id="GIMP-RGB-INTENSITY-RED:CAPS"/>GIMP_RGB_INTENSITY_RED</title>
730
 
<indexterm><primary>GIMP_RGB_INTENSITY_RED</primary></indexterm><programlisting>#define GIMP_RGB_INTENSITY_RED    0.30
731
 
</programlisting>
732
 
<para>
733
 
 
734
 
</para></refsect2>
735
 
<refsect2>
736
 
<title><anchor id="GIMP-RGB-INTENSITY-GREEN:CAPS"/>GIMP_RGB_INTENSITY_GREEN</title>
737
 
<indexterm><primary>GIMP_RGB_INTENSITY_GREEN</primary></indexterm><programlisting>#define GIMP_RGB_INTENSITY_GREEN  0.59
738
 
</programlisting>
739
 
<para>
740
 
 
741
 
</para></refsect2>
742
 
<refsect2>
743
 
<title><anchor id="GIMP-RGB-INTENSITY-BLUE:CAPS"/>GIMP_RGB_INTENSITY_BLUE</title>
744
 
<indexterm><primary>GIMP_RGB_INTENSITY_BLUE</primary></indexterm><programlisting>#define GIMP_RGB_INTENSITY_BLUE   0.11
745
 
</programlisting>
746
 
<para>
747
 
 
748
 
</para></refsect2>
749
 
<refsect2>
750
 
<title><anchor id="GIMP-TYPE-RGB:CAPS"/>GIMP_TYPE_RGB</title>
 
824
<title><anchor id="GIMP-RGB-INTENSITY-RED:CAPS" role="macro" condition="deprecated:"/>GIMP_RGB_INTENSITY_RED</title>
 
825
<indexterm role="deprecated"><primary>GIMP_RGB_INTENSITY_RED</primary></indexterm><programlisting>#define GIMP_RGB_INTENSITY_RED    (0.30)
 
826
</programlisting>
 
827
<warning><para><literal>GIMP_RGB_INTENSITY_RED</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
828
<para>
 
829
 
 
830
</para></refsect2>
 
831
<refsect2>
 
832
<title><anchor id="GIMP-RGB-INTENSITY-GREEN:CAPS" role="macro" condition="deprecated:"/>GIMP_RGB_INTENSITY_GREEN</title>
 
833
<indexterm role="deprecated"><primary>GIMP_RGB_INTENSITY_GREEN</primary></indexterm><programlisting>#define GIMP_RGB_INTENSITY_GREEN  (0.59)
 
834
</programlisting>
 
835
<warning><para><literal>GIMP_RGB_INTENSITY_GREEN</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
836
<para>
 
837
 
 
838
</para></refsect2>
 
839
<refsect2>
 
840
<title><anchor id="GIMP-RGB-INTENSITY-BLUE:CAPS" role="macro" condition="deprecated:"/>GIMP_RGB_INTENSITY_BLUE</title>
 
841
<indexterm role="deprecated"><primary>GIMP_RGB_INTENSITY_BLUE</primary></indexterm><programlisting>#define GIMP_RGB_INTENSITY_BLUE   (0.11)
 
842
</programlisting>
 
843
<warning><para><literal>GIMP_RGB_INTENSITY_BLUE</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
844
<para>
 
845
 
 
846
</para></refsect2>
 
847
<refsect2>
 
848
<title><anchor id="GIMP-TYPE-RGB:CAPS" role="macro"/>GIMP_TYPE_RGB</title>
751
849
<indexterm><primary>GIMP_TYPE_RGB</primary></indexterm><programlisting>#define GIMP_TYPE_RGB               (gimp_rgb_get_type ())
752
850
</programlisting>
753
851
<para>
754
852
<link linkend="GIMP-TYPE-RGB:CAPS"><type>GIMP_TYPE_RGB</type></link> is a <link linkend="GType"><type>GType</type></link> derived from <link linkend="G-TYPE-BOXED:CAPS"><type>G_TYPE_BOXED</type></link>.
755
853
</para></refsect2>
756
854
<refsect2>
757
 
<title><anchor id="GIMP-VALUE-HOLDS-RGB:CAPS"/>GIMP_VALUE_HOLDS_RGB()</title>
 
855
<title><anchor id="GIMP-TYPE-PARAM-RGB:CAPS" role="macro"/>GIMP_TYPE_PARAM_RGB</title>
 
856
<indexterm><primary>GIMP_TYPE_PARAM_RGB</primary></indexterm><programlisting>#define GIMP_TYPE_PARAM_RGB           (gimp_param_rgb_get_type ())
 
857
</programlisting>
 
858
<para>
 
859
 
 
860
</para></refsect2>
 
861
<refsect2>
 
862
<title><anchor id="gimp-param-spec-rgb" role="function" condition="since:GIMP 2.4"/>gimp_param_spec_rgb ()</title>
 
863
<indexterm role="GIMP 2.4"><primary>gimp_param_spec_rgb</primary></indexterm><programlisting><link linkend="GParamSpec">GParamSpec</link>*         gimp_param_spec_rgb                 (const <link linkend="gchar">gchar</link> *name,
 
864
                                                         const <link linkend="gchar">gchar</link> *nick,
 
865
                                                         const <link linkend="gchar">gchar</link> *blurb,
 
866
                                                         <link linkend="gboolean">gboolean</link> has_alpha,
 
867
                                                         const <link linkend="GimpRGB">GimpRGB</link> *default_value,
 
868
                                                         <link linkend="GParamFlags">GParamFlags</link> flags);</programlisting>
 
869
<para>
 
870
Creates a param spec to hold an <link linkend="GimpRGB"><type>GimpRGB</type></link> value.
 
871
See <link linkend="g-param-spec-internal"><function>g_param_spec_internal()</function></link> for more information.</para>
 
872
<para>
 
873
 
 
874
</para><variablelist role="params">
 
875
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
876
<listitem><simpara>          Canonical name of the param
 
877
</simpara></listitem></varlistentry>
 
878
<varlistentry><term><parameter>nick</parameter>&nbsp;:</term>
 
879
<listitem><simpara>          Nickname of the param
 
880
</simpara></listitem></varlistentry>
 
881
<varlistentry><term><parameter>blurb</parameter>&nbsp;:</term>
 
882
<listitem><simpara>         Brief desciption of param.
 
883
</simpara></listitem></varlistentry>
 
884
<varlistentry><term><parameter>has_alpha</parameter>&nbsp;:</term>
 
885
<listitem><simpara>     <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the alpha channel has relevance.
 
886
</simpara></listitem></varlistentry>
 
887
<varlistentry><term><parameter>default_value</parameter>&nbsp;:</term>
 
888
<listitem><simpara> Value to use if none is assigned.
 
889
</simpara></listitem></varlistentry>
 
890
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
 
891
<listitem><simpara>         a combination of <link linkend="GParamFlags"><type>GParamFlags</type></link>
 
892
</simpara></listitem></varlistentry>
 
893
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated <link linkend="GParamSpec"><type>GParamSpec</type></link> instance
 
894
 
 
895
</simpara></listitem></varlistentry>
 
896
</variablelist><para role="since">Since  GIMP 2.4
 
897
</para></refsect2>
 
898
<refsect2>
 
899
<title><anchor id="gimp-param-spec-rgb-has-alpha" role="function" condition="since:GIMP 2.4"/>gimp_param_spec_rgb_has_alpha ()</title>
 
900
<indexterm role="GIMP 2.4"><primary>gimp_param_spec_rgb_has_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_param_spec_rgb_has_alpha       (<link linkend="GParamSpec">GParamSpec</link> *pspec);</programlisting>
 
901
<para>
 
902
</para>
 
903
<para>
 
904
 
 
905
</para><variablelist role="params">
 
906
<varlistentry><term><parameter>pspec</parameter>&nbsp;:</term>
 
907
<listitem><simpara> a <link linkend="GParamSpec"><type>GParamSpec</type></link> to hold an <link linkend="GimpRGB"><type>GimpRGB</type></link> value.
 
908
</simpara></listitem></varlistentry>
 
909
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the alpha channel is relevant.
 
910
 
 
911
</simpara></listitem></varlistentry>
 
912
</variablelist><para role="since">Since  GIMP 2.4
 
913
</para></refsect2>
 
914
<refsect2>
 
915
<title><anchor id="GIMP-VALUE-HOLDS-RGB:CAPS" role="macro"/>GIMP_VALUE_HOLDS_RGB()</title>
758
916
<indexterm><primary>GIMP_VALUE_HOLDS_RGB</primary></indexterm><programlisting>#define GIMP_VALUE_HOLDS_RGB(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_RGB))
759
917
</programlisting>
760
918
<para>
766
924
 
767
925
</simpara></listitem></varlistentry>
768
926
</variablelist></refsect2>
 
927
<refsect2>
 
928
<title><anchor id="gimp-value-get-rgb" role="function"/>gimp_value_get_rgb ()</title>
 
929
<indexterm><primary>gimp_value_get_rgb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_value_get_rgb                  (const <link linkend="GValue">GValue</link> *value,
 
930
                                                         <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
 
931
<para>
 
932
 
 
933
</para><variablelist role="params">
 
934
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
935
<listitem><simpara>
 
936
</simpara></listitem></varlistentry>
 
937
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
 
938
<listitem><simpara>
 
939
 
 
940
 
 
941
</simpara></listitem></varlistentry>
 
942
</variablelist></refsect2>
 
943
<refsect2>
 
944
<title><anchor id="gimp-value-set-rgb" role="function"/>gimp_value_set_rgb ()</title>
 
945
<indexterm><primary>gimp_value_set_rgb</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_value_set_rgb                  (<link linkend="GValue">GValue</link> *value,
 
946
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgb);</programlisting>
 
947
<para>
 
948
 
 
949
</para><variablelist role="params">
 
950
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
951
<listitem><simpara>
 
952
</simpara></listitem></varlistentry>
 
953
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
 
954
<listitem><simpara>
 
955
 
 
956
 
 
957
</simpara></listitem></varlistentry>
 
958
</variablelist></refsect2>
769
959
 
770
960
</refsect1>
771
961