File: libgimpbase-gimpchecks.html

package info (click to toggle)
gimp 2.2.13-1etch4
  • links: PTS
  • area: main
  • in suites: etch
  • size: 94,832 kB
  • ctags: 47,113
  • sloc: ansic: 524,858; xml: 36,798; lisp: 9,870; sh: 9,409; makefile: 7,923; python: 2,674; perl: 2,589; yacc: 520; lex: 334
file content (145 lines) | stat: -rw-r--r-- 5,740 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpchecks</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimplimits.html" title="gimplimits">
<link rel="next" href="libgimpbase-gimpdatafiles.html" title="gimpdatafiles">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimplimits.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpdatafiles.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2565707" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id2535156" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpchecks"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2565707"></a><span class="refentrytitle">gimpchecks</span>
</h2>
<p>gimpchecks &#8212; Constants and functions related to rendering checkerboards.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">



#define     <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE:CAPS">GIMP_CHECK_SIZE</a>
#define     <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE-SM:CAPS">GIMP_CHECK_SIZE_SM</a>
#define     <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-DARK:CAPS">GIMP_CHECK_DARK</a>
#define     <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-LIGHT:CAPS">GIMP_CHECK_LIGHT</a>
void        <a href="libgimpbase-gimpchecks.html#gimp-checks-get-shades">gimp_checks_get_shades</a>          (<a href="libgimpbase-gimpbaseenums.html#GimpCheckType">GimpCheckType</a> type,
                                             guchar *light,
                                             guchar *dark);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2535156"></a><h2>Description</h2>
<p>
Constants and functions related to rendering checkerboards.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2535171"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2535182"></a><h3>
<a name="GIMP-CHECK-SIZE:CAPS"></a>GIMP_CHECK_SIZE</h3>
<a class="indexterm" name="id2535193"></a><pre class="programlisting">#define GIMP_CHECK_SIZE      8
</pre>
<p>
The default checkerboard size in pixels. This is configurable in the
core but GIMP plug-ins can't access the user preference and should use
this constant instead.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2535212"></a><h3>
<a name="GIMP-CHECK-SIZE-SM:CAPS"></a>GIMP_CHECK_SIZE_SM</h3>
<a class="indexterm" name="id2535223"></a><pre class="programlisting">#define GIMP_CHECK_SIZE_SM   4
</pre>
<p>
The default small checkerboard size in pixels.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559248"></a><h3>
<a name="GIMP-CHECK-DARK:CAPS"></a>GIMP_CHECK_DARK</h3>
<a class="indexterm" name="id2559260"></a><pre class="programlisting">#define GIMP_CHECK_DARK      0.4
</pre>
<p>
The dark gray value for the default checkerboard pattern.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559276"></a><h3>
<a name="GIMP-CHECK-LIGHT:CAPS"></a>GIMP_CHECK_LIGHT</h3>
<a class="indexterm" name="id2559288"></a><pre class="programlisting">#define GIMP_CHECK_LIGHT     0.6
</pre>
<p>
The light gray value for the default checkerboard pattern.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559303"></a><h3>
<a name="gimp-checks-get-shades"></a>gimp_checks_get_shades ()</h3>
<a class="indexterm" name="id2559317"></a><pre class="programlisting">void        gimp_checks_get_shades          (<a href="libgimpbase-gimpbaseenums.html#GimpCheckType">GimpCheckType</a> type,
                                             guchar *light,
                                             guchar *dark);</pre>
<p>
Retrieves the actual shades of gray to use when drawing a
checkerboard for a certain <a href="libgimpbase-gimpbaseenums.html#GimpCheckType"><span class="type">GimpCheckType</span></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td>  the checkerboard type
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>light</code></em>&#160;:</span></td>
<td> return location for the light shade
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>dark</code></em>&#160;:</span></td>
<td>  return location for the dark shade
</td>
</tr>
</tbody>
</table></div>
<p>Since  GIMP 2.2
</p>
</div>
</div>
</div>
</body>
</html>