ImageHelper Class Reference

#include <imagehelper.h>

Inheritance diagram for ImageHelper:

Public Member Functions
virtual	~ImageHelper ()
Image *	load (SDL_RWops *const rw)
virtual Image *	load (SDL_RWops *const rw, Dye const &dye)
virtual Image *	loadSurface (SDL_Surface *const)
virtual Image *	createTextSurface (SDL_Surface *const tmpImage, const int width, const int height, const float alpha) const
virtual SDL_Surface *	create32BitSurface (int width, int height) const
virtual void	copySurfaceToImage (const Image *const image, const int x, const int y, SDL_Surface *const surface) const
virtual RenderType	useOpenGL () const
virtual void	postInit ()

Static Public Member Functions
static SDL_Surface *	convertTo32Bit (SDL_Surface *const tmpImage)
static void	dumpSurfaceFormat (const SDL_Surface *const image)
static void	setEnableAlpha (const bool n)
static SDL_Surface *	loadPng (SDL_RWops *const rw)
static void	setOpenGlMode (const RenderType useOpenGL)

Protected Member Functions
	ImageHelper ()

Static Protected Attributes
static bool	mEnableAlpha = true
static RenderType	mUseOpenGL = RENDER_SOFTWARE

Friends
class	CompoundSprite
class	Image

Detailed Description

Defines a class for loading and storing images.

Definition at line 42 of file imagehelper.h.

Constructor & Destructor Documentation

~ImageHelper()

virtual ImageHelper::~ImageHelper ( )

inlinevirtual

Definition at line 50 of file imagehelper.h.

 { }

ImageHelper()

ImageHelper::ImageHelper ( )

inlineprotected

Definition at line 114 of file imagehelper.h.

 { }

Member Function Documentation

convertTo32Bit()

SDL_Surface * ImageHelper::convertTo32Bit ( SDL_Surface *const  tmpImage )

static

< Surface is in system memory

Definition at line 134 of file imagehelper.cpp.

{
 if (tmpImage == nullptr)
 return nullptr;
 SDL_PixelFormat RGBAFormat;
 RGBAFormat.palette = nullptr;
#ifndef USE_SDL2
 RGBAFormat.colorkey = 0;
 RGBAFormat.alpha = 0;
#endif // USE_SDL2
 
 RGBAFormat.BitsPerPixel = 32;
 RGBAFormat.BytesPerPixel = 4;
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
 RGBAFormat.Rmask = 0xFF000000U;
 RGBAFormat.Rshift = 0;
 RGBAFormat.Rloss = 0;
 RGBAFormat.Gmask = 0x00FF0000U;
 RGBAFormat.Gshift = 8;
 RGBAFormat.Gloss = 0;
 RGBAFormat.Bmask = 0x0000FF00U;
 RGBAFormat.Bshift = 16;
 RGBAFormat.Bloss = 0;
 RGBAFormat.Amask = 0x000000FFU;
 RGBAFormat.Ashift = 24;
 RGBAFormat.Aloss = 0;
#else // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
 RGBAFormat.Rmask = 0x000000FFU;
 RGBAFormat.Rshift = 24;
 RGBAFormat.Rloss = 0;
 RGBAFormat.Gmask = 0x0000FF00U;
 RGBAFormat.Gshift = 16;
 RGBAFormat.Gloss = 0;
 RGBAFormat.Bmask = 0x00FF0000U;
 RGBAFormat.Bshift = 8;
 RGBAFormat.Bloss = 0;
 RGBAFormat.Amask = 0xFF000000U;
 RGBAFormat.Ashift = 0;
 RGBAFormat.Aloss = 0;
#endif // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
 return MSDL_ConvertSurface(tmpImage, &RGBAFormat, SDL_SWSURFACE);
}

References MSDL_ConvertSurface.

Referenced by SDLImageHelper::_SDLload(), OpenGLImageHelper::load(), SafeOpenGLImageHelper::load(), main(), and TestLauncher::testTextures().

copySurfaceToImage()

virtual void ImageHelper::copySurfaceToImage ( const Image *const  image, const int  x, const int  y, SDL_Surface *const  surface  ) const

inlinevirtual

Reimplemented in SafeOpenGLImageHelper, OpenGLImageHelper, and SDLImageHelper.

Definition at line 86 of file imagehelper.h.

 { }

Referenced by AtlasManager::createSDLAtlas().

create32BitSurface()

SDL_Surface * ImageHelper::create32BitSurface ( int  width, int  height  ) const

virtual

< Surface is in system memory

Reimplemented in SafeOpenGLImageHelper, and OpenGLImageHelper.

Definition at line 239 of file imagehelper.cpp.

{
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
 const uint32_t rmask = 0xff000000U;
 const uint32_t gmask = 0x00ff0000U;
 const uint32_t bmask = 0x0000ff00U;
 const uint32_t amask = 0x000000ffU;
#else // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
 const uint32_t rmask = 0x000000ffU;
 const uint32_t gmask = 0x0000ff00U;
 const uint32_t bmask = 0x00ff0000U;
 const uint32_t amask = 0xff000000U;
#endif // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
 return MSDL_CreateRGBSurface(SDL_SWSURFACE,
 width, height, 32, rmask, gmask, bmask, amask);
}

References MSDL_CreateRGBSurface.

Referenced by TextChunk::generate(), TestLauncher::testBlitSpeed(), and TestLauncher::testTextures().

createTextSurface()

virtual Image* ImageHelper::createTextSurface ( SDL_Surface *const  tmpImage, const int  width, const int  height, const float  alpha  ) const

inlinevirtual

Definition at line 76 of file imagehelper.h.

 { return nullptr; }

Referenced by TextChunk::generate().

dumpSurfaceFormat()

void ImageHelper::dumpSurfaceFormat ( const SDL_Surface *const  image )

static

Definition at line 179 of file imagehelper.cpp.

{
 if (image == nullptr)
 return;
 if (image->format != nullptr)
 {
 const SDL_PixelFormat * const format = image->format;
 logger->log("Bytes per pixel: %d", format->BytesPerPixel);
#ifdef USE_SDL2
 logger->log("Format: %u", format->format);
#else // USE_SDL2
 
 logger->log("Alpha: %d", format->alpha);
 logger->log("Color key: %u", format->colorkey);
#endif // USE_SDL2
 
 logger->log("Loss: %02x, %02x, %02x, %02x",
 CAST_U32(format->Rloss),
 CAST_U32(format->Gloss),
 CAST_U32(format->Bloss),
 CAST_U32(format->Aloss));
 logger->log("Shift: %02x, %02x, %02x, %02x",
 CAST_U32(format->Rshift),
 CAST_U32(format->Gshift),
 CAST_U32(format->Bshift),
 CAST_U32(format->Ashift));
 logger->log("Mask: %08x, %08x, %08x, %08x", format->Rmask,
 format->Gmask, format->Bmask, format->Amask);
 }
 logger->log("Flags: %u", image->flags);
 logger->log("Pitch: %d", CAST_S32(image->pitch));
#ifndef USE_SDL2
 logger->log("Offset: %d", image->offset);
#endif // USE_SDL2
}

References CAST_S32, CAST_U32, Logger::log(), and logger.

Referenced by Graphics::videoInfo().

load() [1/2]

Image * ImageHelper::load

(

SDL_RWops *const

rw

)

Loads an image from an SDL_RWops structure.

Parameters

rw	The SDL_RWops to load the image from.

Returns

NULL if an error occurred, a valid pointer otherwise.

Definition at line 50 of file imagehelper.cpp.

{
 SDL_Surface *const tmpImage = loadPng(rw);
 if (tmpImage == nullptr)
 {
 logger->log("Error, image load failed: %s", SDL_GetError());
 return nullptr;
 }
 
 Image *const image = loadSurface(tmpImage);
 
 MSDL_FreeSurface(tmpImage);
 return image;
}

References loadPng(), loadSurface(), Logger::log(), logger, and MSDL_FreeSurface.

Referenced by anonymous_namespace{imageloader.cpp}::DyedImageLoader::load(), and AtlasManager::loadImages().

load() [2/2]

Image * ImageHelper::load ( SDL_RWops *const  rw, Dye const &  dye  )

virtual

< Surface is in system memory

Reimplemented in SDLImageHelper, SafeOpenGLImageHelper, and OpenGLImageHelper.

Definition at line 65 of file imagehelper.cpp.

{
 BLOCK_START("ImageHelper::load")
 SDL_Surface *const tmpImage = loadPng(rw);
 if (tmpImage == nullptr)
 {
 logger->log("Error, image load failed: %s", SDL_GetError());
 BLOCK_END("ImageHelper::load")
 return nullptr;
 }
 
 SDL_PixelFormat rgba;
 rgba.palette = nullptr;
 rgba.BitsPerPixel = 32;
 rgba.BytesPerPixel = 4;
 
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
 rgba.Rmask = 0x000000FFU;
 rgba.Gmask = 0x0000FF00U;
 rgba.Bmask = 0x00FF0000U;
 rgba.Amask = 0xFF000000U;
#else // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
 rgba.Rmask = 0xFF000000U;
 rgba.Gmask = 0x00FF0000U;
 rgba.Bmask = 0x0000FF00U;
 rgba.Amask = 0x000000FFU;
#endif // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
 SDL_Surface *const surf = MSDL_ConvertSurface(
 tmpImage, &rgba, SDL_SWSURFACE);
 MSDL_FreeSurface(tmpImage);
 
 if (surf == nullptr)
 return nullptr;
 
 uint32_t *const pixels = static_cast<uint32_t *>(surf->pixels);
 const int type = dye.getType();
 
 switch (type)
 {
 case 1:
 {
 const DyePalette *const pal = dye.getSPalete();
 if (pal != nullptr)
 DYEPALETTEP(pal, SColor)(pixels, surf->w * surf->h);
 break;
 }
 case 2:
 {
 const DyePalette *const pal = dye.getAPalete();
 if (pal != nullptr)
 DYEPALETTEP(pal, AColor)(pixels, surf->w * surf->h);
 break;
 }
 case 0:
 default:
 {
 dye.normalDye(pixels, surf->w * surf->h);
 break;
 }
 }
 
 Image *const image = loadSurface(surf);
 MSDL_FreeSurface(surf);
 BLOCK_END("ImageHelper::load")
 return image;
}

References BLOCK_END, BLOCK_START, DYEPALETTEP, Dye::getAPalete(), Dye::getSPalete(), Dye::getType(), loadPng(), loadSurface(), Logger::log(), logger, MSDL_ConvertSurface, MSDL_FreeSurface, and Dye::normalDye().

loadPng()

SDL_Surface * ImageHelper::loadPng ( SDL_RWops *const  rw )

static

Definition at line 215 of file imagehelper.cpp.

{
 if (rw == nullptr)
 return nullptr;
 
 if (IMG_isPNG(rw) != 0)
 {
 SDL_Surface *const tmpImage = MIMG_LoadPNG_RW(rw);
 SDL_RWclose(rw);
 return tmpImage;
 }
 
 if (IMG_isJPG(rw) != 0)
 {
 SDL_Surface *const tmpImage = MIMG_LoadJPG_RW(rw);
 SDL_RWclose(rw);
 return tmpImage;
 }
 
 logger->log("Error, image is not png");
 SDL_RWclose(rw);
 return nullptr;
}

References Logger::log(), logger, MIMG_LoadJPG_RW, and MIMG_LoadPNG_RW.

Referenced by load(), OpenGLImageHelper::load(), SafeOpenGLImageHelper::load(), and SDLImageHelper::load().

loadSurface()

virtual Image* ImageHelper::loadSurface ( SDL_Surface * const  )

inlinevirtual

Reimplemented in SDLImageHelper, SafeOpenGLImageHelper, and OpenGLImageHelper.

Definition at line 73 of file imagehelper.h.

 { return nullptr; }

Referenced by AtlasManager::convertAtlas(), AtlasManager::convertEmptyAtlas(), AtlasManager::createSDLAtlas(), load(), CompoundSprite::redraw(), Minimap::setMap(), and TestLauncher::testTextures().

postInit()

virtual void ImageHelper::postInit ( )

inlinevirtual

Reimplemented in SafeOpenGLImageHelper, and OpenGLImageHelper.

Definition at line 110 of file imagehelper.h.

 { }

Referenced by Client::initGraphics().

setEnableAlpha()

static void ImageHelper::setEnableAlpha ( const bool  n )

inlinestatic

Definition at line 98 of file imagehelper.h.

 { mEnableAlpha = n; }

References mEnableAlpha.

Referenced by GraphicsManager::initGraphics(), and Client::optionChanged().

setOpenGlMode()

static void ImageHelper::setOpenGlMode ( const RenderType  useOpenGL )

inlinestatic

Definition at line 103 of file imagehelper.h.

 { mUseOpenGL = useOpenGL; }

References mUseOpenGL, and useOpenGL().

Referenced by GraphicsManager::createRenderers().

useOpenGL()

virtual RenderType ImageHelper::useOpenGL ( ) const

inlinevirtual

Definition at line 107 of file imagehelper.h.

 { return mUseOpenGL; }

References mUseOpenGL.

Referenced by AmbientLayer::AmbientLayer(), Desktop::draw(), AmbientLayer::draw(), Font::Font(), MapDebugTab::MapDebugTab(), CompoundSprite::setAlpha(), Desktop::setBestFittingWallpaper(), setOpenGlMode(), and CompoundSprite::updateImages().

Friends And Related Function Documentation

CompoundSprite

friend class CompoundSprite

friend

Definition at line 44 of file imagehelper.h.

Image

friend class Image

friend

Definition at line 45 of file imagehelper.h.

Field Documentation

mEnableAlpha

bool ImageHelper::mEnableAlpha = true

staticprotected

Definition at line 117 of file imagehelper.h.

Referenced by CompoundSprite::redraw(), and setEnableAlpha().

mUseOpenGL

RenderType ImageHelper::mUseOpenGL = RENDER_SOFTWARE

staticprotected

Definition at line 118 of file imagehelper.h.

Referenced by OpenGLImageHelper::bindTexture(), SafeOpenGLImageHelper::bindTexture(), OpenGLImageHelper::glLoad(), setOpenGlMode(), and useOpenGL().

---

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

• src/resources/imagehelper.h (986a3bf)
• src/resources/imagehelper.cpp (986a3bf)