image.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "resources/resource.h"
 
#include <SDL.h>
 
#ifdef USE_OPENGL
 
/* The definition of OpenGL extensions by SDL is giving problems with recent
 * gl.h headers, since they also include these definitions. As we're not using
 * extensions anyway it's safe to just disable the SDL version.
 */
#define NO_SDL_GLEXT
 
#include <SDL_opengl.h>
#endif
 
class Dye;
 
class Image : public Resource
{
    friend class SDLGraphics;
#ifdef USE_OPENGL
    friend class OpenGLGraphics;
#endif
 
    public:
        ~Image() override;
 
        static Resource *load(SDL_RWops *rw);
 
        static Resource *load(SDL_RWops *rw, const Dye &dye);
 
        static Image *load(SDL_Surface *);
 
        int getWidth() const
        { return mBounds.w; }
 
        int getHeight() const
        { return mBounds.h; }
 
        static bool useOpenGL();
 
        void setAlpha(float alpha);
 
        float getAlpha() const
        { return mAlpha; }
 
        Image *getSubImage(int x, int y, int width, int height);
 
        // SDL only public functions
 
        static void SDLdisableTransparency()
        { mDisableTransparency = true; }
 
        static bool SDLisTransparencyDisabled()
        { return mDisableTransparency; }
 
        static void setRenderer(SDL_Renderer *renderer);
 
#ifdef USE_OPENGL
 
        // OpenGL only public functions
 
        static void setLoadAsOpenGL(bool useOpenGL);
 
        static bool getLoadAsOpenGL() { return mUseOpenGL; }
 
        int getTextureWidth() const { return mTexWidth; }
        int getTextureHeight() const { return mTexHeight; }
        static int getTextureType() { return mTextureType; }
#endif
 
    protected:
 
        // -----------------------
        // Generic protected members
        // -----------------------
 
        SDL_Rect mBounds;
        float mAlpha = 1.0f;
 
        // -----------------------
        // SDL protected members
        // -----------------------
 
        Image(SDL_Texture *texture, int width, int height);
 
        static Image *_SDLload(SDL_Surface *tmpImage);
 
        SDL_Texture *mTexture = nullptr;
 
        static bool mDisableTransparency;
 
        static SDL_Renderer *mRenderer;
 
        // -----------------------
        // OpenGL protected members
        // -----------------------
#ifdef USE_OPENGL
        Image(GLuint glimage, int width, int height,
              int texWidth, int texHeight);
 
        static int powerOfTwo(int input);
 
        static Image *_GLload(SDL_Surface *image);
 
        GLuint mGLImage = 0;
        int mTexWidth, mTexHeight;
 
        static bool mUseOpenGL;
        static bool mPowerOfTwoTextures;
        static int mTextureType;
        static int mTextureSize;
#endif
};
 
class SubImage : public Image
{
    public:
        SubImage(Image *parent, SDL_Texture *texture,
                 int x, int y, int width, int height);
#ifdef USE_OPENGL
        SubImage(Image *parent, GLuint image, int x, int y,
                 int width, int height, int texWidth, int textHeight);
#endif
 
        ~SubImage() override;
 
    private:
        ResourceRef<Image> mParent;
};