kdefx Library API Documentation

KPixmapEffect Class Reference

This class includes various pixmap-based graphical effects. More...

#include <kpixmapeffect.h>

List of all members.

Static Public Methods

KPixmapgradient (KPixmap &pixmap, const QColor &ca, const QColor &cb, GradientType type, int ncols=3)
 Creates a gradient from color a to color b of the specified type.

KPixmapunbalancedGradient (KPixmap &pixmap, const QColor &ca, const QColor &cb, GradientType type, int xfactor=100, int yfactor=100, int ncols=3)
 Creates an unbalanced gradient.

KPixmap createTiled (const KPixmap &pixmap, QSize size)
 Creates a pixmap of a given size with the given pixmap.

KPixmapintensity (KPixmap &pixmap, float ratio)
 Either brightens or dims a pixmap by a specified ratio.

KPixmapchannelIntensity (KPixmap &pixmap, float ratio, RGBComponent channel)
 Modifies the intensity of a pixmap's RGB channel component.

KPixmapblend (KPixmap &pixmap, float initial_intensity, const QColor &bgnd, GradientType eff, bool anti_dir=false, int ncols=3)
 Blends the provided pixmap into a background of the indicated color.

KPixmaphash (KPixmap &pixmap, Lighting lite=NorthLite, unsigned int spacing=0, int ncols=3)
 Builds a hash on any given pixmap.

KPixmap pattern (const KPixmap &pixmap, QSize size, const QColor &ca, const QColor &cb, int ncols=8)
 Creates a pattern from a pixmap.

KPixmapfade (KPixmap &pixmap, double val, const QColor &color)
 Recolors a pixmap.

KPixmaptoGray (KPixmap &pixmap, bool fast=false)
 Converts a pixmap to grayscale.

KPixmapdesaturate (KPixmap &pixmap, float desat=0.3)
 Desaturates a pixmap.

KPixmapcontrast (KPixmap &pixmap, int c)
 Modifies the contrast of a pixmap.

KPixmapdither (KPixmap &pixmap, const QColor *palette, int size)
 Dithers a pixmap using Floyd-Steinberg dithering for low-color situations.

KPixmap selectedPixmap (const KPixmap &pixmap, const QColor &col)
 Calculate a 'selected' pixmap, for instance a selected icon on the desktop.


Detailed Description

This class includes various pixmap-based graphical effects.

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.

Definition at line 26 of file kpixmapeffect.h.


Member Function Documentation

KPixmap & KPixmapEffect::gradient KPixmap   pixmap,
const QColor   ca,
const QColor   cb,
GradientType    type,
int    ncols = 3
[static]
 

Creates a gradient from color a to color b of the specified type.

Parameters:
pixmap  The pixmap to process.
ca  Color a.
cb  Color b.
type  The type of gradient.
ncols  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.
Returns:
Returns the generated pixmap, for convenience.

Definition at line 24 of file kpixmapeffect.cpp.

References QColor::blue(), KPixmap::convertFromImage(), QPixmap::depth(), QPainter::drawLine(), KImageEffect::gradient(), QColor::green(), QPixmap::height(), QColor::red(), QPainter::setPen(), QPixmap::size(), and QPixmap::width().

KPixmap & KPixmapEffect::unbalancedGradient KPixmap   pixmap,
const QColor   ca,
const QColor   cb,
GradientType    type,
int    xfactor = 100,
int    yfactor = 100,
int    ncols = 3
[static]
 

Creates an unbalanced gradient.

An unbalanced gradient is a gradient where the transition from color a to color b is not linear, but in this case, exponential.

Parameters:
pixmap  The pixmap that should be written.
ca  Color a.
cb  Color b.
type  The type of gradient.
xfactor  The x decay length. Use a value between -200 and 200.
yfactor  The y decay length.
ncols  The number of colors. See gradient.
Returns:
The generated pixmap, for convencience.

Definition at line 88 of file kpixmapeffect.cpp.

References KPixmap::convertFromImage(), QPixmap::size(), and KImageEffect::unbalancedGradient().

KPixmap KPixmapEffect::createTiled const KPixmap   pixmap,
QSize    size
[static]
 

Creates a pixmap of a given size with the given pixmap.

if the given size is bigger than the size of the pixmap, the pixmap is tiled.

Parameters:
pixmap  This is the source pixmap
size  The size the new pixmap should have.
Returns:
The generated, tiled pixmap.

Definition at line 240 of file kpixmapeffect.cpp.

References QPainter::drawTiledPixmap(), QSize::height(), and QSize::width().

Referenced by pattern().

KPixmap & KPixmapEffect::intensity KPixmap   pixmap,
float    ratio
[static]
 

Either brightens or dims a pixmap by a specified ratio.

Parameters:
pixmap  The pixmap to process.
ratio  The ratio to use. Use negative value to dim.
Returns:
Returns The pixmap(), provided for convenience.

Definition at line 109 of file kpixmapeffect.cpp.

References KPixmap::convertFromImage(), QPixmap::convertToImage(), and KImageEffect::intensity().

KPixmap & KPixmapEffect::channelIntensity KPixmap   pixmap,
float    ratio,
RGBComponent    channel
[static]
 

Modifies the intensity of a pixmap's RGB channel component.

Parameters:
pixmap  The pixmap to process.
ratio  value. Use negative value to dim.
channel  Which channel(s) should be modified
Returns:
Returns the pixmap(), provided for convenience.

Definition at line 121 of file kpixmapeffect.cpp.

References KImageEffect::channelIntensity(), KPixmap::convertFromImage(), and QPixmap::convertToImage().

KPixmap & KPixmapEffect::blend KPixmap   pixmap,
float    initial_intensity,
const QColor   bgnd,
GradientType    eff,
bool    anti_dir = false,
int    ncols = 3
[static]
 

Blends the provided pixmap into a background of the indicated color.

Parameters:
pixmap  The pixmap to process.
initial_intensity  this parameter takes values from -1 to 1:
  • If positive, it tells how much to fade the image in its less affected spot.
  • If negative, it tells roughly indicates how much of the image remains unaffected
bgnd  Indicates the color of the background to blend in.
eff  Lets you choose what kind of blending you like.
anti_dir  Blend in the opposite direction (makes no much sense with concentric blending effects).
Returns:
Returns the pixmap(), provided for convenience.

Definition at line 140 of file kpixmapeffect.cpp.

References KImageEffect::blend(), QImage::convertDepth(), KPixmap::convertFromImage(), QPixmap::convertToImage(), QPixmap::depth(), QImage::depth(), KImageEffect::dither(), and QColor::setRgb().

KPixmap & KPixmapEffect::hash KPixmap   pixmap,
Lighting    lite = NorthLite,
unsigned int    spacing = 0,
int    ncols = 3
[static]
 

Builds a hash on any given pixmap.

Parameters:
pixmap  The pixmap to process.
lite  The hash faces the indicated lighting (cardinal poles)
spacing  How many unmodified pixels inbetween hashes.
Returns:
Returns The pixmap(), provided for convenience.

Definition at line 179 of file kpixmapeffect.cpp.

References KPixmap::convertFromImage(), QPixmap::convertToImage(), QPixmap::depth(), KImageEffect::dither(), KImageEffect::hash(), and QColor::setRgb().

KPixmap KPixmapEffect::pattern const KPixmap   pixmap,
QSize    size,
const QColor   ca,
const QColor   cb,
int    ncols = 8
[static]
 

Creates a pattern from a pixmap.

The given pixmap is "flattened" between color a to color b.

Parameters:
pixmap  The pixmap to process.
ca  Color a.
cb  Color b.
ncols  The number of colors to use. The image will be dithered to this depth. Pass zero to prevent dithering.
Returns:
The pixmap(), provided for convenience.

Definition at line 223 of file kpixmapeffect.cpp.

References KPixmap::convertFromImage(), QPixmap::convertToImage(), createTiled(), QPixmap::depth(), and KImageEffect::flatten().

KPixmap & KPixmapEffect::fade KPixmap   pixmap,
double    val,
const QColor   color
[static]
 

Recolors a pixmap.

The most dark color will become color a, the most bright one color b, and in between.

Parameters:
pixmap  The pixmap to process.
ca  Color a.
cb  Color b.
ncols  The number of colors to use. Pass zero to prevent dithering.
Returns:
Returns the pixmap(), provided for convenience.

Definition at line 257 of file kpixmapeffect.cpp.

References KPixmap::convertFromImage(), QPixmap::convertToImage(), and KImageEffect::fade().

KPixmap & KPixmapEffect::toGray KPixmap   pixmap,
bool    fast = false
[static]
 

Converts a pixmap to grayscale.

Parameters:
pixmap  The pixmap to process.
fast  Set to true in order to use a faster but non-photographic quality algorithm. Appropriate for things such as toolbar icons.
Returns:
Returns the pixmap(), provided for convenience.

Definition at line 268 of file kpixmapeffect.cpp.

References KPixmap::convertFromImage(), QPixmap::convertToImage(), and KImageEffect::toGray().

KPixmap & KPixmapEffect::desaturate KPixmap   pixmap,
float    desat = 0.3
[static]
 

Desaturates a pixmap.

Parameters:
pixmap  The pixmap to process.
desat  A value between 0 and 1 setting the degree of desaturation
Returns:
Returns The pixmap(), provided for convenience.

Definition at line 278 of file kpixmapeffect.cpp.

References KPixmap::convertFromImage(), QPixmap::convertToImage(), and KImageEffect::desaturate().

KPixmap & KPixmapEffect::contrast KPixmap   pixmap,
int    c
[static]
 

Modifies the contrast of a pixmap.

Parameters:
pixmap  The pixmap to process.
c  A contrast value between -255 and 255.
Returns:
Returns the pixmap(), provided for convenience.

Definition at line 287 of file kpixmapeffect.cpp.

References KImageEffect::contrast(), KPixmap::convertFromImage(), and QPixmap::convertToImage().

KPixmap & KPixmapEffect::dither KPixmap   pixmap,
const QColor   palette,
int    size
[static]
 

Dithers a pixmap using Floyd-Steinberg dithering for low-color situations.

Parameters:
pixmap  The pixmap to process.
palette  The color palette to use.
size  The size of the palette.
Returns:
Returns the pixmap(), provided for convenience.

Definition at line 303 of file kpixmapeffect.cpp.

References KPixmap::convertFromImage(), QPixmap::convertToImage(), and KImageEffect::dither().

KPixmap KPixmapEffect::selectedPixmap const KPixmap   pixmap,
const QColor   col
[static]
 

Calculate a 'selected' pixmap, for instance a selected icon on the desktop.

Parameters:
pixmap  the pixmap to select
col  the selected color, usually from QColorGroup::highlight().

Definition at line 318 of file kpixmapeffect.cpp.

References KPixmap::convertFromImage(), QPixmap::convertToImage(), and KImageEffect::selectedImage().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:20:31 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001