Irrlicht 3D Engine
irr::video::IImage Class Reference

Interface for software image data. More...

#include <IImage.h>

+ Inheritance diagram for irr::video::IImage:

List of all members.

Public Member Functions

Static Public Member Functions


Detailed Description

Interface for software image data.

Image loaders create these images from files. IVideoDrivers convert these images into their (hardware) textures.

Definition at line 22 of file IImage.h.


Member Function Documentation

virtual void irr::video::IImage::copyTo ( IImage target,
const core::position2d< s32 > &  pos = core::position2d< s32 >(0, 0) 
) [pure virtual]

copies this surface into another

virtual void irr::video::IImage::copyTo ( IImage target,
const core::position2d< s32 > &  pos,
const core::rect< s32 > &  sourceRect,
const core::rect< s32 > *  clipRect = 0 
) [pure virtual]

copies this surface into another

virtual void irr::video::IImage::copyToScaling ( void *  target,
u32  width,
u32  height,
ECOLOR_FORMAT  format = ECF_A8R8G8B8,
u32  pitch = 0 
) [pure virtual]

Copies the image into the target, scaling the image to fit.

virtual void irr::video::IImage::copyToScaling ( IImage target) [pure virtual]

Copies the image into the target, scaling the image to fit.

virtual void irr::video::IImage::copyToScalingBoxFilter ( IImage target,
s32  bias = 0,
bool  blend = false 
) [pure virtual]

copies this surface into another, scaling it to fit, appyling a box filter

virtual void irr::video::IImage::copyToWithAlpha ( IImage target,
const core::position2d< s32 > &  pos,
const core::rect< s32 > &  sourceRect,
const SColor color,
const core::rect< s32 > *  clipRect = 0 
) [pure virtual]

copies this surface into another, using the alpha mask and cliprect and a color to add with

virtual void irr::video::IImage::fill ( const SColor color) [pure virtual]

fills the surface with given color

virtual u32 irr::video::IImage::getAlphaMask ( ) const [pure virtual]

Returns mask for alpha value of a pixel.

virtual u32 irr::video::IImage::getBitsPerPixel ( ) const [pure virtual]

Returns bits per pixel.

static u32 irr::video::IImage::getBitsPerPixelFromFormat ( const ECOLOR_FORMAT  format) [inline, static]
virtual u32 irr::video::IImage::getBlueMask ( ) const [pure virtual]

Returns mask for blue value of a pixel.

virtual u32 irr::video::IImage::getBytesPerPixel ( ) const [pure virtual]

Returns bytes per pixel.

virtual ECOLOR_FORMAT irr::video::IImage::getColorFormat ( ) const [pure virtual]

Returns the color format.

virtual const core::dimension2d<u32>& irr::video::IImage::getDimension ( ) const [pure virtual]

Returns width and height of image data.

virtual u32 irr::video::IImage::getGreenMask ( ) const [pure virtual]

Returns mask for green value of a pixel.

virtual u32 irr::video::IImage::getImageDataSizeInBytes ( ) const [pure virtual]

Returns image data size in bytes.

virtual u32 irr::video::IImage::getImageDataSizeInPixels ( ) const [pure virtual]

Returns image data size in pixels.

virtual u32 irr::video::IImage::getPitch ( ) const [pure virtual]

Returns pitch of image.

virtual SColor irr::video::IImage::getPixel ( u32  x,
u32  y 
) const [pure virtual]

Returns a pixel.

virtual u32 irr::video::IImage::getRedMask ( ) const [pure virtual]

Returns mask for red value of a pixel.

static bool irr::video::IImage::isRenderTargetOnlyFormat ( const ECOLOR_FORMAT  format) [inline, static]

test if the color format is only viable for RenderTarget textures

Since we don't have support for e.g. floating point IImage formats one should test if the color format can be used for arbitrary usage, or if it is restricted to RTTs.

Definition at line 135 of file IImage.h.

References irr::video::ECF_A1R5G5B5, irr::video::ECF_A8R8G8B8, irr::video::ECF_R5G6B5, and irr::video::ECF_R8G8B8.

virtual void* irr::video::IImage::lock ( ) [pure virtual]

Lock function. Use this to get a pointer to the image data.

After you don't need the pointer anymore, you must call unlock().

Returns:
Pointer to the image data. What type of data is pointed to depends on the color format of the image. For example if the color format is ECF_A8R8G8B8, it is of u32. Be sure to call unlock() after you don't need the pointer any more.
virtual void irr::video::IImage::setPixel ( u32  x,
u32  y,
const SColor color,
bool  blend = false 
) [pure virtual]

Sets a pixel.

virtual void irr::video::IImage::unlock ( ) [pure virtual]

Unlock function.

Should be called after the pointer received by lock() is not needed anymore.


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