SubImage Class Reference

#include <subimage.h>

Inheritance diagram for SubImage:

Public Member Functions
	SubImage (Image *const parent, SDL_Surface *const image, const int x, const int y, const int width, const int height)
	SubImage (Image *const parent, const GLuint image, const int x, const int y, const int width, const int height, const int texWidth, const int textHeight)
	~SubImage ()
Image *	getSubImage (const int x, const int y, const int width, const int height)
ImageTypeT	getType () const
int	calcMemoryLocal () const
void	decRef ()

Data Fields
SDL_Rect	mInternalBounds

Private Attributes
Image *	mParent

Detailed Description

A clipped version of a larger image.

Definition at line 34 of file subimage.h.

Constructor & Destructor Documentation

SubImage() [1/2]

SubImage::SubImage	(	Image *const	parent,
		SDL_Surface *const	image,
		const int	x,
		const int	y,
		const int	width,
		const int	height
	)

Constructor.

Definition at line 90 of file subimage.cpp.

                                                      :
    Image(image, false, nullptr),
    mInternalBounds(),
    mParent(parent)
{
    if (mParent != nullptr)
    {
        mParent->incRef();
        mParent->SDLTerminateAlphaCache();
        mHasAlphaChannel = mParent->hasAlphaChannel();
        mIsAlphaVisible = mHasAlphaChannel;
        mAlphaChannel = mParent->SDLgetAlphaChannel();
        mSource = parent->mIdPath;
#ifdef DEBUG_IMAGES
        logger->log("set name2 %p, %s", static_cast<void*>(this),
            mSource.c_str());
#endif  // DEBUG_IMAGES
#ifdef DEBUG_BIND_TEXTURE
        mIdPath = parent->mIdPath;
#endif  // DEBUG_BIND_TEXTURE
    }
    else
    {
        mHasAlphaChannel = false;
        mIsAlphaVisible = false;
        mAlphaChannel = nullptr;
    }
 
    // Set up the rectangle.
    mBounds.x = CAST_S16(x);
    mBounds.y = CAST_S16(y);
    mBounds.w = CAST_U16(width);
    mBounds.h = CAST_U16(height);
    if (mParent != nullptr)
    {
        mInternalBounds.x = mParent->mBounds.x;
        mInternalBounds.y = mParent->mBounds.y;
        mInternalBounds.w = mParent->mBounds.w;
        mInternalBounds.h = mParent->mBounds.h;
    }
    else
    {
        mInternalBounds.x = 0;
        mInternalBounds.y = 0;
        mInternalBounds.w = 1;
        mInternalBounds.h = 1;
    }
    mUseAlphaCache = false;
}

References CAST_S16, CAST_U16, Logger::log(), logger, mInternalBounds, mParent, x, and y.

Referenced by calcMemoryLocal().

SubImage() [2/2]

SubImage::SubImage	(	Image *const	parent,
		const GLuint	image,
		const int	x,
		const int	y,
		const int	width,
		const int	height,
		const int	texWidth,
		const int	textHeight
	)

Definition at line 144 of file subimage.cpp.

                                                            :
    Image(image, width, height, texWidth, texHeight),
    mInternalBounds(),
    mParent(parent)
{
    if (mParent != nullptr)
        mParent->incRef();
 
    // Set up the rectangle.
    mBounds.x = CAST_S16(x);
    mBounds.y = CAST_S16(y);
    mBounds.w = CAST_U16(width);
    mBounds.h = CAST_U16(height);
    if (mParent != nullptr)
    {
        mInternalBounds.x = mParent->mBounds.x;
        mInternalBounds.y = mParent->mBounds.y;
        mInternalBounds.w = mParent->mBounds.w;
        mInternalBounds.h = mParent->mBounds.h;
        mSource = parent->mIdPath;
#ifdef DEBUG_IMAGES
        logger->log("set name2 %p, %s", static_cast<void*>(this),
            mSource.c_str());
#endif  // DEBUG_IMAGES
#ifdef DEBUG_BIND_TEXTURE
        mIdPath = parent->mIdPath;
#endif  // DEBUG_BIND_TEXTURE
    }
    else
    {
        mInternalBounds.x = 0;
        mInternalBounds.y = 0;
        mInternalBounds.w = 1;
        mInternalBounds.h = 1;
    }
    mIsAlphaVisible = mHasAlphaChannel;
}

References CAST_S16, CAST_U16, Logger::log(), logger, mInternalBounds, mParent, x, and y.

~SubImage()

SubImage::~SubImage

(

)

Destructor.

Definition at line 187 of file subimage.cpp.

{
#ifdef DEBUG_IMAGES
    logger->log("delete subimage: %p", static_cast<void*>(this));
    logger->log("  %s, %s", mIdPath.c_str(), mSource.c_str());
#endif  // DEBUG_IMAGES
    // Avoid destruction of the image
    mSDLSurface = nullptr;
    // Avoid possible destruction of its alpha channel
    mAlphaChannel = nullptr;
#ifdef USE_SDL2
    // Avoid destruction of texture
    mTexture = nullptr;
#endif  // USE_SDL2
#ifdef USE_OPENGL
    mGLImage = 0;
#endif  // USE_OPENGL
    if (mParent != nullptr)
    {
#ifdef DEBUG_IMAGES
        logger->log("decref from subminage: %p, parent: %p",
            static_cast<void*>(this), static_cast<void*>(mParent));
#endif  // DEBUG_IMAGES
 
        mParent->decRef();
        mParent = nullptr;
    }
}

References Logger::log(), logger, and mParent.

Member Function Documentation

calcMemoryLocal()

int SubImage::calcMemoryLocal

(

)

const

Definition at line 231 of file subimage.cpp.

{
    return static_cast<int>(sizeof(SubImage) +
        sizeof(std::map<float, SDL_Surface*>)) +
        Image::calcMemoryLocal();
}

References ResourceManager::calcMemoryLocal(), and SubImage().

decRef()

void SubImage::decRef

(

)

Definition at line 225 of file subimage.cpp.

{
    Resource::decRef();
}

References Resource::decRef().

getSubImage()

Image * SubImage::getSubImage	(	const int	x,
		const int	y,
		const int	width,
		const int	height
	)

Creates a new image with the desired clipping rectangle.

Returns

NULL if creation failed and a valid image otherwise.

Definition at line 216 of file subimage.cpp.

{
    if (mParent != nullptr)
        return mParent->getSubImage(mBounds.x + x, mBounds.y + y, w, h);
    return nullptr;
}

References mParent, x, and y.

getType()

ImageTypeT SubImage::getType ( ) const

inline

Definition at line 70 of file subimage.h.

        { return ImageType::SubImage; }

References ImageType::SubImage.

Field Documentation

mInternalBounds

SDL_Rect SubImage::mInternalBounds

Definition at line 79 of file subimage.h.

Referenced by Map::reduce(), and SubImage().

mParent

Image* SubImage::mParent

private

Definition at line 82 of file subimage.h.

Referenced by getSubImage(), SubImage(), and ~SubImage().

---

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

• src/resources/image/subimage.h (986a3bf)
• src/resources/image/subimage.cpp (986a3bf)