Files
gimp/devel-docs/libgimpbase/html/libgimpbase-gimpchecks.html
2010-08-11 01:24:03 -04:00

160 lines
6.6 KiB
HTML

<!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.73.2">
<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-gimpparam.html" title="gimpparam">
<link rel="next" href="libgimpbase-gimpcpuaccel.html" title="gimpcpuaccel">
<meta name="generator" content="GTK-Doc V1.9 (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">
<link rel="index" href="libgimpbase-index.html" title="Index">
<link rel="index" href="libgimpbase-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimpbase-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimpbase-index-deprecated.html" title="Index of deprecated symbols">
</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-gimpparam.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-gimpcpuaccel.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="#id2602801" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2583101" 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="id2602801"></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 class="link" href="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE:CAPS">GIMP_CHECK_SIZE</a>
#define <a class="link" href="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE-SM:CAPS">GIMP_CHECK_SIZE_SM</a>
#define <a class="link" href="libgimpbase-gimpchecks.html#GIMP-CHECK-DARK:CAPS">GIMP_CHECK_DARK</a>
#define <a class="link" href="libgimpbase-gimpchecks.html#GIMP-CHECK-LIGHT:CAPS">GIMP_CHECK_LIGHT</a>
void <a class="link" href="libgimpbase-gimpchecks.html#gimp-checks-get-shades">gimp_checks_get_shades</a> (<a class="link" href="libgimpbase-gimpbaseenums.html#GimpCheckType">GimpCheckType</a> type,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *light,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *dark);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2583101"></a><h2>Description</h2>
<p>
Constants and functions related to rendering checkerboards.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2583118"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2583128"></a><h3>
<a name="GIMP-CHECK-SIZE:CAPS"></a>GIMP_CHECK_SIZE</h3>
<a class="indexterm" name="id2583140"></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="id2583158"></a><h3>
<a name="GIMP-CHECK-SIZE-SM:CAPS"></a>GIMP_CHECK_SIZE_SM</h3>
<a class="indexterm" name="id2583170"></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="id2582656"></a><h3>
<a name="GIMP-CHECK-DARK:CAPS"></a>GIMP_CHECK_DARK</h3>
<a class="indexterm" name="id2582667"></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="id2582684"></a><h3>
<a name="GIMP-CHECK-LIGHT:CAPS"></a>GIMP_CHECK_LIGHT</h3>
<a class="indexterm" name="id2582695"></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="id2582712"></a><h3>
<a name="gimp-checks-get-shades"></a>gimp_checks_get_shades ()</h3>
<a class="indexterm" name="id2582725"></a><pre class="programlisting">void gimp_checks_get_shades (<a class="link" href="libgimpbase-gimpbaseenums.html#GimpCheckType">GimpCheckType</a> type,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *light,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *dark);</pre>
<p>
Retrieves the actual shades of gray to use when drawing a
checkerboard for a certain <a class="link" 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><p><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></p></td>
<td> the checkerboard type
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>light</code></em>&#160;:</span></p></td>
<td> return location for the light shade
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dark</code></em>&#160;:</span></p></td>
<td> return location for the dark shade
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2582996"></a><div class="refsect2" lang="en"><a name="id2582997"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2582998"></a></div>
</div>
</div>
</body>
</html>