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

39 lines
5.5 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><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 I. 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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part I. GIMP Base Library"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" 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></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><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="id2543433"></a><h2>Description</h2><p>
Constants and functions related to rendering checkerboards.
</p></div><div class="refsect1" lang="en"><a name="id2543443"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2543448"></a><h3><a name="GIMP-CHECK-SIZE:CAPS"></a>GIMP_CHECK_SIZE</h3><a class="indexterm" name="id2543457"></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="id2543469"></a><h3><a name="GIMP-CHECK-SIZE-SM:CAPS"></a>GIMP_CHECK_SIZE_SM</h3><a class="indexterm" name="id2543478"></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="id2543488"></a><h3><a name="GIMP-CHECK-DARK:CAPS"></a>GIMP_CHECK_DARK</h3><a class="indexterm" name="id2543497"></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="id2543507"></a><h3><a name="GIMP-CHECK-LIGHT:CAPS"></a>GIMP_CHECK_LIGHT</h3><a class="indexterm" name="id2543516"></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="id2543525"></a><h3><a name="gimp-checks-get-shades"></a>gimp_checks_get_shades ()</h3><a class="indexterm" name="id2543534"></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> :</span></td><td> the checkerboard type
</td></tr><tr><td><span class="term"><em class="parameter"><code>light</code></em> :</span></td><td> return location for the light shade
</td></tr><tr><td><span class="term"><em class="parameter"><code>dark</code></em> :</span></td><td> return location for the dark shade
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimpbase-gimplimits.html"><b>&lt;&lt; gimplimits</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpdatafiles.html"><b>gimpdatafiles &gt;&gt;</b></a></td></tr></table></body></html>