<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kdefx: KPixmapEffect Class Reference (kdefx)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kdefx</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">KPixmapEffect Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KPixmapEffect" -->
<p>This class includes various pixmap-based graphical effects.
<a href="classKPixmapEffect.html#details">More...</a></p>
<p><code>#include <<a class="el" href="kpixmapeffect_8h_source.html">kpixmapeffect.h</a>></code></p>
<p><a href="classKPixmapEffect-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>GradientType</b> { <br/>
  <b>VerticalGradient</b>,
<b>HorizontalGradient</b>,
<b>DiagonalGradient</b>,
<b>CrossDiagonalGradient</b>,
<br/>
  <b>PyramidGradient</b>,
<b>RectangleGradient</b>,
<b>PipeCrossGradient</b>,
<b>EllipticGradient</b>
<br/>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>RGBComponent</b> { <b>Red</b>,
<b>Green</b>,
<b>Blue</b>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>Lighting</b> { <br/>
  <b>NorthLite</b>,
<b>NWLite</b>,
<b>WestLite</b>,
<b>SWLite</b>,
<br/>
  <b>SouthLite</b>,
<b>SELite</b>,
<b>EastLite</b>,
<b>NELite</b>
<br/>
}</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#a9cded223b75513effc4b2760a3416e39">gradient</a> (<a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, const <a class="elRef" href="qcolor.html">QColor</a> &ca, const <a class="elRef" href="qcolor.html">QColor</a> &cb, GradientType type, int ncols=3)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#a9547f7634a1fd8bc0c7e3bde97f353e4">unbalancedGradient</a> (<a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, const <a class="elRef" href="qcolor.html">QColor</a> &ca, const <a class="elRef" href="qcolor.html">QColor</a> &cb, GradientType type, int xfactor=100, int yfactor=100, int ncols=3)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#ab865dc6e67906b6ee42464fd71cd1e10">createTiled</a> (const <a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, <a class="elRef" href="qsize.html">QSize</a> size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#a136bd9cdb4bed497adfa5ea35b55abfe">intensity</a> (<a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, float ratio)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#af171a9c7e29faba0fc4676bbf4db0597">channelIntensity</a> (<a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, float ratio, RGBComponent channel)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#ac5b12e198818445da3b78731a573a422">blend</a> (<a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, float initial_intensity, const <a class="elRef" href="qcolor.html">QColor</a> &bgnd, GradientType eff, bool anti_dir=false, int ncols=3)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#a4a984cf3f0ecb92c1f1c213158ace87c">hash</a> (<a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, Lighting lite=NorthLite, unsigned int spacing=0, int ncols=3)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#ac6ae1bd71f6cf13b8148ca14d7020a16">pattern</a> (const <a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, <a class="elRef" href="qsize.html">QSize</a> size, const <a class="elRef" href="qcolor.html">QColor</a> &ca, const <a class="elRef" href="qcolor.html">QColor</a> &cb, int ncols=8)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#a3c77ccb57fe4464bac3a665c4e150b61">fade</a> (<a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, double val, const <a class="elRef" href="qcolor.html">QColor</a> &color)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#a9a49c0ae52f41b2d078a25305b2ae4c8">toGray</a> (<a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, bool fast=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#aa88ef2ef750bc7e0d535e3a965dd4604">desaturate</a> (<a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, float desat=0.3)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#af543f25d940413e22b04f63965cf5e4e">contrast</a> (<a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, int c)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#a3677a4309e5dca887c97ea18ac80ee86">dither</a> (<a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, const <a class="elRef" href="qcolor.html">QColor</a> *palette, int size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKPixmap.html">KPixmap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPixmapEffect.html#a7f0f8c22b92ecd7f2ec7f76eefccefcd">selectedPixmap</a> (const <a class="el" href="classKPixmap.html">KPixmap</a> &pixmap, const <a class="elRef" href="qcolor.html">QColor</a> &col)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class includes various pixmap-based graphical effects. </p>
<p>Everything is static, so there is no need to create an instance of this class. You can just call the static methods. They are encapsulated here merely to provide a common namespace. </p>
<p>Definition at line <a class="el" href="kpixmapeffect_8h_source.html#l00027">27</a> of file <a class="el" href="kpixmapeffect_8h_source.html">kpixmapeffect.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac5b12e198818445da3b78731a573a422"></a><!-- doxytag: member="KPixmapEffect::blend" ref="ac5b12e198818445da3b78731a573a422" args="(KPixmap &pixmap, float initial_intensity, const QColor &bgnd, GradientType eff, bool anti_dir=false, int ncols=3)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> & KPixmapEffect::blend </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>initial_intensity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qcolor.html">QColor</a> & </td>
<td class="paramname"><em>bgnd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GradientType </td>
<td class="paramname"><em>eff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>anti_dir</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>ncols</em> = <code>3</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Blends the provided pixmap into a background of the indicated color. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap to process. </td></tr>
<tr><td class="paramname">initial_intensity</td><td>this parameter takes values from -1 to 1: <ul>
<li>If positive, it tells how much to fade the image in its less affected spot. </li>
<li>If negative, it tells roughly indicates how much of the image remains unaffected </li>
</ul>
</td></tr>
<tr><td class="paramname">bgnd</td><td>Indicates the color of the background to blend in. </td></tr>
<tr><td class="paramname">eff</td><td>Lets you choose what kind of blending you like. </td></tr>
<tr><td class="paramname">anti_dir</td><td>Blend in the opposite direction (makes no much sense with concentric blending effects). </td></tr>
<tr><td class="paramname">ncols</td><td>The number of colors to dither the pixmap to. Only used for 8 bpp pixmaps. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the pixmap(), provided for convenience. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00140">140</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af171a9c7e29faba0fc4676bbf4db0597"></a><!-- doxytag: member="KPixmapEffect::channelIntensity" ref="af171a9c7e29faba0fc4676bbf4db0597" args="(KPixmap &pixmap, float ratio, RGBComponent channel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> & KPixmapEffect::channelIntensity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>ratio</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RGBComponent </td>
<td class="paramname"><em>channel</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modifies the intensity of a pixmap's RGB channel component. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap to process. </td></tr>
<tr><td class="paramname">ratio</td><td>value. Use negative value to dim. </td></tr>
<tr><td class="paramname">channel</td><td>Which channel(s) should be modified </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the pixmap(), provided for convenience. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00121">121</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af543f25d940413e22b04f63965cf5e4e"></a><!-- doxytag: member="KPixmapEffect::contrast" ref="af543f25d940413e22b04f63965cf5e4e" args="(KPixmap &pixmap, int c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> & KPixmapEffect::contrast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>c</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Modifies the contrast of a pixmap. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap to process. </td></tr>
<tr><td class="paramname">c</td><td>A contrast value between -255 and 255. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the pixmap(), provided for convenience. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00287">287</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab865dc6e67906b6ee42464fd71cd1e10"></a><!-- doxytag: member="KPixmapEffect::createTiled" ref="ab865dc6e67906b6ee42464fd71cd1e10" args="(const KPixmap &pixmap, QSize size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> KPixmapEffect::createTiled </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="qsize.html">QSize</a> </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a pixmap of a given size with the given pixmap. </p>
<p>if the given size is bigger than the size of the pixmap, the pixmap is tiled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>This is the source pixmap </td></tr>
<tr><td class="paramname">size</td><td>The size the new pixmap should have. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The generated, tiled pixmap. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00240">240</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa88ef2ef750bc7e0d535e3a965dd4604"></a><!-- doxytag: member="KPixmapEffect::desaturate" ref="aa88ef2ef750bc7e0d535e3a965dd4604" args="(KPixmap &pixmap, float desat=0.3)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> & KPixmapEffect::desaturate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>desat</em> = <code>0.3</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Desaturates a pixmap. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap to process. </td></tr>
<tr><td class="paramname">desat</td><td>A value between 0 and 1 setting the degree of desaturation </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns The pixmap(), provided for convenience. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00278">278</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3677a4309e5dca887c97ea18ac80ee86"></a><!-- doxytag: member="KPixmapEffect::dither" ref="a3677a4309e5dca887c97ea18ac80ee86" args="(KPixmap &pixmap, const QColor *palette, int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> & KPixmapEffect::dither </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qcolor.html">QColor</a> * </td>
<td class="paramname"><em>palette</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dithers a pixmap using Floyd-Steinberg dithering for low-color situations. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap to process. </td></tr>
<tr><td class="paramname">palette</td><td>The color palette to use. </td></tr>
<tr><td class="paramname">size</td><td>The size of the palette. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the pixmap(), provided for convenience. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00303">303</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3c77ccb57fe4464bac3a665c4e150b61"></a><!-- doxytag: member="KPixmapEffect::fade" ref="a3c77ccb57fe4464bac3a665c4e150b61" args="(KPixmap &pixmap, double val, const QColor &color)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> & KPixmapEffect::fade </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qcolor.html">QColor</a> & </td>
<td class="paramname"><em>color</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fades a pixmap to a certain color. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap to process. </td></tr>
<tr><td class="paramname">val</td><td>The strength of the effect. 0 <= val <= 1. </td></tr>
<tr><td class="paramname">color</td><td>The color to blend to. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the pixmap(), provided for convenience. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00257">257</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9cded223b75513effc4b2760a3416e39"></a><!-- doxytag: member="KPixmapEffect::gradient" ref="a9cded223b75513effc4b2760a3416e39" args="(KPixmap &pixmap, const QColor &ca, const QColor &cb, GradientType type, int ncols=3)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> & KPixmapEffect::gradient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qcolor.html">QColor</a> & </td>
<td class="paramname"><em>ca</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qcolor.html">QColor</a> & </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GradientType </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>ncols</em> = <code>3</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a gradient from color a to color b of the specified type. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap to process. </td></tr>
<tr><td class="paramname">ca</td><td>Color a. </td></tr>
<tr><td class="paramname">cb</td><td>Color b. </td></tr>
<tr><td class="paramname">type</td><td>The type of gradient. </td></tr>
<tr><td class="paramname">ncols</td><td>The number of colors to use when not running on a truecolor display. The gradient will be dithered to this number of colors. Pass 0 to prevent dithering. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the generated pixmap, for convenience. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00024">24</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4a984cf3f0ecb92c1f1c213158ace87c"></a><!-- doxytag: member="KPixmapEffect::hash" ref="a4a984cf3f0ecb92c1f1c213158ace87c" args="(KPixmap &pixmap, Lighting lite=NorthLite, unsigned int spacing=0, int ncols=3)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> & KPixmapEffect::hash </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Lighting </td>
<td class="paramname"><em>lite</em> = <code>NorthLite</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>spacing</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>ncols</em> = <code>3</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Builds a hash on any given pixmap. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap to process. </td></tr>
<tr><td class="paramname">lite</td><td>The hash faces the indicated lighting (cardinal poles) </td></tr>
<tr><td class="paramname">spacing</td><td>How many unmodified pixels inbetween hashes. </td></tr>
<tr><td class="paramname">ncols</td><td>The number of colors to dither the pixmap to. Only used for 8 bpp pixmaps. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns The pixmap(), provided for convenience. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00179">179</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a136bd9cdb4bed497adfa5ea35b55abfe"></a><!-- doxytag: member="KPixmapEffect::intensity" ref="a136bd9cdb4bed497adfa5ea35b55abfe" args="(KPixmap &pixmap, float ratio)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> & KPixmapEffect::intensity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>ratio</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Either brightens or dims a pixmap by a specified ratio. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap to process. </td></tr>
<tr><td class="paramname">ratio</td><td>The ratio to use. Use negative value to dim. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns The pixmap(), provided for convenience. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00109">109</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac6ae1bd71f6cf13b8148ca14d7020a16"></a><!-- doxytag: member="KPixmapEffect::pattern" ref="ac6ae1bd71f6cf13b8148ca14d7020a16" args="(const KPixmap &pixmap, QSize size, const QColor &ca, const QColor &cb, int ncols=8)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> KPixmapEffect::pattern </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="qsize.html">QSize</a> </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qcolor.html">QColor</a> & </td>
<td class="paramname"><em>ca</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qcolor.html">QColor</a> & </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>ncols</em> = <code>8</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a pattern from a pixmap. </p>
<p>The given pixmap is "flattened" between color a to color b. Doesn't change the original pixmap.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap to process. </td></tr>
<tr><td class="paramname">size</td><td>The size of the returned pixmap. If <code>size</code> is larger than the original, the resulting pixmap will be tiled. </td></tr>
<tr><td class="paramname">ca</td><td>Color a. </td></tr>
<tr><td class="paramname">cb</td><td>Color b. </td></tr>
<tr><td class="paramname">ncols</td><td>The number of colors to use. The image will be dithered to this depth. Pass zero to prevent dithering. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The resulting pixmap. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00223">223</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7f0f8c22b92ecd7f2ec7f76eefccefcd"></a><!-- doxytag: member="KPixmapEffect::selectedPixmap" ref="a7f0f8c22b92ecd7f2ec7f76eefccefcd" args="(const KPixmap &pixmap, const QColor &col)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> KPixmapEffect::selectedPixmap </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qcolor.html">QColor</a> & </td>
<td class="paramname"><em>col</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Calculate a 'selected' pixmap, for instance a selected icon on the desktop. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>the pixmap to select </td></tr>
<tr><td class="paramname">col</td><td>the selected color, usually from <a class="elRef" href="qcolorgroup.html#highlight">QColorGroup::highlight()</a>. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00318">318</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9a49c0ae52f41b2d078a25305b2ae4c8"></a><!-- doxytag: member="KPixmapEffect::toGray" ref="a9a49c0ae52f41b2d078a25305b2ae4c8" args="(KPixmap &pixmap, bool fast=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> & KPixmapEffect::toGray </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>fast</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Converts a pixmap to grayscale. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap to process. </td></tr>
<tr><td class="paramname">fast</td><td>Set to <code>true</code> in order to use a faster but non-photographic quality algorithm. Appropriate for things such as toolbar icons. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the pixmap(), provided for convenience. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00268">268</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9547f7634a1fd8bc0c7e3bde97f353e4"></a><!-- doxytag: member="KPixmapEffect::unbalancedGradient" ref="a9547f7634a1fd8bc0c7e3bde97f353e4" args="(KPixmap &pixmap, const QColor &ca, const QColor &cb, GradientType type, int xfactor=100, int yfactor=100, int ncols=3)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPixmap.html">KPixmap</a> & KPixmapEffect::unbalancedGradient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPixmap.html">KPixmap</a> & </td>
<td class="paramname"><em>pixmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qcolor.html">QColor</a> & </td>
<td class="paramname"><em>ca</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qcolor.html">QColor</a> & </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GradientType </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>xfactor</em> = <code>100</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>yfactor</em> = <code>100</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>ncols</em> = <code>3</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates an unbalanced gradient. </p>
<p>An unbalanced gradient is a gradient where the transition from color a to color b is not linear, but in this case, exponential.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pixmap</td><td>The pixmap that should be written. </td></tr>
<tr><td class="paramname">ca</td><td>Color a. </td></tr>
<tr><td class="paramname">cb</td><td>Color b. </td></tr>
<tr><td class="paramname">type</td><td>The type of gradient. </td></tr>
<tr><td class="paramname">xfactor</td><td>The x decay length. Use a value between -200 and 200. </td></tr>
<tr><td class="paramname">yfactor</td><td>The y decay length. </td></tr>
<tr><td class="paramname">ncols</td><td>The number of colors. See <a class="el" href="classKPixmapEffect.html#a9cded223b75513effc4b2760a3416e39" title="Creates a gradient from color a to color b of the specified type.">gradient</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The generated pixmap, for convencience. </dd></dl>
<p>Definition at line <a class="el" href="kpixmapeffect_8cpp_source.html#l00088">88</a> of file <a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kpixmapeffect_8h_source.html">kpixmapeffect.h</a></li>
<li><a class="el" href="kpixmapeffect_8cpp_source.html">kpixmapeffect.cpp</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kdefx</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKCPUInfo.html">kcpuinfo</option>, <option value="classKImageEffect.html">kimageeffect</option>, <option value="classKPixmap.html">kpixmap</option>, <option value="classKPixmapEffect.html">kpixmapeffect</option>, <option value="classKPixmapSplitter.html">kpixmapsplitter</option>, <option value="classKStyle.html">kstyle</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
