PixelLightAPI  .
Static Public Member Functions
PLGraphics::ImageEffects Class Reference

Static image effects class. More...

#include <ImageEffects.h>

List of all members.

Static Public Member Functions

static ImageEffectWrapper Effect (const PLCore::String &sEffect, const PLCore::String &sParameters)
 Create image effect dynamically.
static IEFilter Filter ()
 Create image filter.
static IEScale Scale (const PLMath::Vector3i &vNewSize, bool bUseMipmaps)
 Create scale image effect.
static IEConvert Convert (EDataFormat nDataFormat, EColorFormat nColorFormat)
 Create image conversion effect.
static IEMonochrome Monochrome ()
 Create monochrome image effect.
static IEColorKey ColorKey (const Color3 &cColor, float fTolerance)
 Create color key image effect.
static IEFlipXAxis FlipXAxis ()
 Create flip the image around the x axis image effect.
static IEFlipYAxis FlipYAxis ()
 Create flip the image around the y axis image effect.
static IERemovePalette RemovePalette ()
 Create remove palette image effect.

Detailed Description

Static image effects class.


Member Function Documentation

ImageEffectWrapper PLGraphics::ImageEffects::Effect ( const PLCore::String sEffect,
const PLCore::String sParameters 
) [inline, static]

Create image effect dynamically.

Parameters:
[in]sEffectImage effect class name
[in]sParametersImage effect parameters
Returns:
Image effect

Create image filter.

Returns:
Image filter
IEScale PLGraphics::ImageEffects::Scale ( const PLMath::Vector3i vNewSize,
bool  bUseMipmaps 
) [inline, static]

Create scale image effect.

Parameters:
[in]vNewSizeThe new size
[in]bUseMipmapsIf there are mipmaps and one of them matches the new dimension... is it allowed to just make this mipmap to the new base image and destroy the now unused other mipmaps? (extremely fast 'scale', but no set filters are applied and may cause problems on 'none standard' images)
Returns:
Scale image effect
IEConvert PLGraphics::ImageEffects::Convert ( EDataFormat  nDataFormat,
EColorFormat  nColorFormat 
) [inline, static]

Create image conversion effect.

Parameters:
[in]nDataFormatDesired data format
[in]nColorFormatDesired color format
Returns:
Image conversion effect

Create monochrome image effect.

Returns:
Monochrome image effect
IEColorKey PLGraphics::ImageEffects::ColorKey ( const Color3 cColor,
float  fTolerance 
) [inline, static]

Create color key image effect.

Parameters:
[in]cColorColor
[in]fToleranceTolerance (0 .. 1)
Returns:
Color key image effect

Create flip the image around the x axis image effect.

Returns:
Flip the image around the x axis image effect

Create flip the image around the y axis image effect.

Returns:
Flip the image around the y axis image effect

Create remove palette image effect.

Returns:
Remove palette image effect

The documentation for this class was generated from the following files:


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:18
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported