summaryrefslogtreecommitdiffstats
path: root/devel-docs/libgimp/html/libgimp-gimpimagecolorprofile.html
blob: 936a5a51dd1c03ca073ae54893a88eec1b62c6ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpimagecolorprofile: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties">
<link rel="prev" href="libgimp-gimpimage.html" title="gimpimage">
<link rel="next" href="libgimp-gimpimageconvert.html" title="gimpimageconvert">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp-gimpimagecolorprofile.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp-gimpimage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp-gimpimageconvert.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp-gimpimagecolorprofile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimpimagecolorprofile.top_of_page"></a>gimpimagecolorprofile</span></h2>
<p>gimpimagecolorprofile — Operations on an image's color profile.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp-gimpimagecolorprofile.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GimpColorProfile</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimagecolorprofile.html#gimp-image-get-color-profile" title="gimp_image_get_color_profile ()">gimp_image_get_color_profile</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimagecolorprofile.html#gimp-image-set-color-profile" title="gimp_image_set_color_profile ()">gimp_image_set_color_profile</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimagecolorprofile.html#gimp-image-set-color-profile-from-file" title="gimp_image_set_color_profile_from_file ()">gimp_image_set_color_profile_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GimpColorProfile</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimagecolorprofile.html#gimp-image-get-effective-color-profile" title="gimp_image_get_effective_color_profile ()">gimp_image_get_effective_color_profile</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimagecolorprofile.html#gimp-image-convert-color-profile" title="gimp_image_convert_color_profile ()">gimp_image_convert_color_profile</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimagecolorprofile.html#gimp-image-convert-color-profile-from-file" title="gimp_image_convert_color_profile_from_file ()">gimp_image_convert_color_profile_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp-gimpimagecolorprofile.description"></a><h2>Description</h2>
<p>Operations on an image's color profile.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimpimagecolorprofile.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-image-get-color-profile"></a><h3>gimp_image_get_color_profile ()</h3>
<pre class="programlisting"><span class="returnvalue">GimpColorProfile</span> *
gimp_image_get_color_profile (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre>
<p>Returns the image's color profile</p>
<p>This procedure returns the image's color profile, or NULL if the
image has no color profile assigned.</p>
<div class="refsect3">
<a name="gimp-image-get-color-profile.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-get-color-profile.returns"></a><h4>Returns</h4>
<p> The image's color profile. The returned value
must be freed with <code class="function">g_object_unref()</code>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-set-color-profile"></a><h3>gimp_image_set_color_profile ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_set_color_profile (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
                              <em class="parameter"><code><span class="type">GimpColorProfile</span> *profile</code></em>);</pre>
<p>Sets the image's color profile</p>
<p>This procedure sets the image's color profile.</p>
<div class="refsect3">
<a name="gimp-image-set-color-profile.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>profile</p></td>
<td class="parameter_description"><p>A <span class="type">GimpColorProfile</span>, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-set-color-profile.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-set-color-profile-from-file"></a><h3>gimp_image_set_color_profile_from_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_set_color_profile_from_file
                               (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>);</pre>
<p>Sets the image's color profile from an ICC file</p>
<p>This procedure sets the image's color profile from a file containing
an ICC profile, or unsets it if NULL is passed as 'uri'. This
procedure does no color conversion.</p>
<div class="refsect3">
<a name="gimp-image-set-color-profile-from-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>The URI of the file containing the new color profile.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-set-color-profile-from-file.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-get-effective-color-profile"></a><h3>gimp_image_get_effective_color_profile ()</h3>
<pre class="programlisting"><span class="returnvalue">GimpColorProfile</span> *
gimp_image_get_effective_color_profile
                               (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre>
<p>Returns the color profile that is used for the image.</p>
<p>This procedure returns the color profile that is actually used for
this image, which is the profile returned by
<a class="link" href="libgimp-gimpimagecolorprofile.html#gimp-image-get-color-profile" title="gimp_image_get_color_profile ()"><code class="function">gimp_image_get_color_profile()</code></a> if the image has a profile assigned,
or the default RGB profile from preferences if no profile is
assigned to the image. If there is no default RGB profile configured
in preferences either, a generated default RGB profile is returned.</p>
<div class="refsect3">
<a name="gimp-image-get-effective-color-profile.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-get-effective-color-profile.returns"></a><h4>Returns</h4>
<p> The color profile. The returned value
must be freed with <code class="function">g_object_unref()</code>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-convert-color-profile"></a><h3>gimp_image_convert_color_profile ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_convert_color_profile (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
                                  <em class="parameter"><code><span class="type">GimpColorProfile</span> *profile</code></em>,
                                  <em class="parameter"><code><a href="../html/GimpColorConfig.html#GimpColorRenderingIntent"><span class="type">GimpColorRenderingIntent</span></a> intent</code></em>,
                                  <em class="parameter"><code><span class="type">gboolean</span> bpc</code></em>);</pre>
<p>Convert the image's layers to a color profile</p>
<p>This procedure converts from the image's color profile (or the
default RGB profile if none is set) to the given color profile. Only
RGB color profiles are accepted.</p>
<div class="refsect3">
<a name="gimp-image-convert-color-profile.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>profile</p></td>
<td class="parameter_description"><p>The color profile to convert to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>intent</p></td>
<td class="parameter_description"><p>Rendering intent.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bpc</p></td>
<td class="parameter_description"><p>Black point compensation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-convert-color-profile.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-convert-color-profile-from-file"></a><h3>gimp_image_convert_color_profile_from_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_convert_color_profile_from_file
                               (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
                                <em class="parameter"><code><a href="../html/GimpColorConfig.html#GimpColorRenderingIntent"><span class="type">GimpColorRenderingIntent</span></a> intent</code></em>,
                                <em class="parameter"><code><span class="type">gboolean</span> bpc</code></em>);</pre>
<p>Convert the image's layers to a color profile</p>
<p>This procedure converts from the image's color profile (or the
default RGB or grayscale profile if none is set) to an ICC profile
specified by 'uri'. Only RGB and grayscale color profiles are
accepted, according to the image's type.</p>
<div class="refsect3">
<a name="gimp-image-convert-color-profile-from-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>The URI of the file containing the new color profile.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>intent</p></td>
<td class="parameter_description"><p>Rendering intent.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bpc</p></td>
<td class="parameter_description"><p>Black point compensation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-convert-color-profile-from-file.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>