class KPixmapEffect

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

Definition#include <kpixmapeffect.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Static Methods


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.

enum GradientType { VerticalGradient, HorizontalGradient, DiagonalGradient, CrossDiagonalGradient, PyramidGradient, RectangleGradient, PipeCrossGradient, EllipticGradient }

GradientType

enum RGBComponent { Red, Green, Blue }

RGBComponent

enum Lighting {NorthLite, NWLite, WestLite, SWLite, SouthLite, SELite, EastLite, NELite}

Lighting

KPixmap&  gradient (KPixmap& pixmap, const QColor &ca, const QColor &cb, GradientType type, int ncols=3)

gradient

[static]

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

Parameters:
pixmapThe pixmap to process.
caColor a.
cbColor b.
typeThe type of gradient.
ncolsThe 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.

KPixmap&  unbalancedGradient (KPixmap& pixmap, const QColor &ca, const QColor &cb, GradientType type, int xfactor = 100, int yfactor = 100, int ncols=3)

unbalancedGradient

[static]

Create 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:
pixmapThe pixmap that should be written.
caColor a.
cbColor b.
typeThe type of gradient.
xfactorThe x decay length. Use a value between -200 and 200.
yfactorThe y decay length.
ncolsThe number of colors. See KPixmapEffect:gradient().

Returns: The generated pixmap, for convencience.

KPixmap  createTiled (const KPixmap& pixmap, QSize size)

createTiled

[static]

Create 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:
pixmapThis is the source pixmap
sizeThe size the new pixmap should have.

Returns: The generated, tiled pixmap.

KPixmap&  intensity (KPixmap& pixmap, float ratio)

intensity

[static]

Either brighten or dim a pixmap by a specified ratio.

Parameters:
pixmapThe pixmap to process.
ratioThe ratio to use. Use negative value to dim.

Returns: Returns The pixmap(), provided for convenience.

KPixmap&  channelIntensity (KPixmap& pixmap, float ratio, RGBComponent channel)

channelIntensity

[static]

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

Parameters:
pixmapThe pixmap to process.
ratiovalue. Use negative value to dim.
channelWhich channel(s) should be modified

Returns: Returns the pixmap(), provided for convenience.

KPixmap&  blend (KPixmap& pixmap, float initial_intensity, const QColor &bgnd, GradientType eff, bool anti_dir=false, int ncols=3)

blend

[static]

Blend the provided pixmap into a background of the indicated color

Parameters:
pixmapThe pixmap to process.
initial_intensitythis parameter takes values from -1 to 1:
bgndIndicates the color of the background to blend in.
effLets you choose what kind of blending you like.
anti_dirBlend in the opposite direction (makes no much sense with concentric blending effects).

Returns: Returns the pixmap(), provided for convenience.

KPixmap&  hash (KPixmap& pixmap, Lighting lite=NorthLite, unsigned int spacing=0, int ncols=3)

hash

[static]

Build a hash on any given Pixmap.

Parameters:
pixmapThe pixmap to process.
liteThe hash faces the indicated lighting (cardinal poles)
spacingHow many unmodified pixels inbetween hashes.

Returns: Returns The pixmap(), provided for convenience.

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

pattern

[static]

Create a pattern from a pixmap.

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

Parameters:
pixmapThe pixmap to process.
caColor a.
cbColor b.
ncolsThe number of colors to use. The image will be dithered to this depth. Pass zero to prevent dithering.

Returns: The pixmap(), provided for convenience.

KPixmap&  fade (KPixmap& pixmap, double val, const QColor &color)

fade

[static]

Recolor a pixmap.

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

Parameters:
pixmapThe pixmap to process.
caColor a.
cbColor b.
ncolsThe number of colors to use. Pass zero to prevent dithering.

Returns: Returns the pixmap(), provided for convenience.

KPixmap&  toGray (KPixmap& pixmap, bool fast=false)

toGray

[static]

Convert a pixmap to grayscale.

Parameters:
pixmapThe pixmap to process.
fastSet 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.

KPixmap&  desaturate (KPixmap& pixmap, float desat = 0.3)

desaturate

[static]

Desaturate a pixmap.

Parameters:
pixmapThe pixmap to process.
desatA value between 0 and 1 setting the degree of desaturation

Returns: Returns The pixmap(), provided for convenience.

KPixmap&  contrast (KPixmap& pixmap, int c)

contrast

[static]

Modifie the contrast of a pixmap.

Parameters:
pixmapThe pixmap to process.
cA contrast value between -255 and 255.

Returns: Returns the pixmap(), provided for convenience.

KPixmap&  dither (KPixmap &pixmap, const QColor *palette, int size)

dither

[static]

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

Parameters:
pixmapThe pixmap to process.
paletteThe color palette to use.
sizeThe size of the palette.

Returns: Returns the pixmap(), provided for convenience.


Generated by: dfaure on kde.faure.org on Thu Jan 17 22:16:05 2002, using kdoc 2.0a53.