OgreImage.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2014 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef _Image_H__
#define _Image_H__

#include "OgrePrerequisites.h"
#include "OgreCommon.h"
#include "OgrePixelFormat.h"
#include "OgreDataStream.h"

namespace Ogre {
    enum ImageFlags
    {
        IF_COMPRESSED = 0x00000001,
        IF_CUBEMAP    = 0x00000002,
        IF_3D_TEXTURE = 0x00000004
    };
    class _OgreExport Image : public ImageAlloc
    {
    public:
        typedef Ogre::Box Box;
        typedef Ogre::Rect Rect;
    public:
        Image();
        Image( const Image &img );

        virtual ~Image();

        Image & operator = ( const Image & img );

        Image & flipAroundY();

        Image & flipAroundX();

        Image& loadDynamicImage( uchar* data, uint32 width, uint32 height,
                            uint32 depth,
                             PixelFormat format, bool autoDelete = false, 
                             size_t numFaces = 1, uint8 numMipMaps = 0);
        
        Image& loadDynamicImage( uchar* data, uint32 width,
                                 uint32 height, PixelFormat format)
        {
            return loadDynamicImage(data, width, height, 1, format);
        }
        Image & loadRawData( 
            DataStreamPtr& stream, 
            uint32 width, uint32 height, uint32 depth,
            PixelFormat format,
            size_t numFaces = 1, size_t numMipMaps = 0);
        Image & loadRawData( 
            DataStreamPtr& stream, 
            uint32 width, uint32 height,
            PixelFormat format )
        {
            return loadRawData(stream, width, height, 1, format);
        }

        Image & load( const String& filename, const String& groupName );

        Image & load(DataStreamPtr& stream, const String& type = StringUtil::BLANK );

        Image & loadTwoImagesAsRGBA(const String& rgbFilename, const String& alphaFilename,
            const String& groupName, PixelFormat format = PF_BYTE_RGBA);

        Image & loadTwoImagesAsRGBA(DataStreamPtr& rgbStream, DataStreamPtr& alphaStream, PixelFormat format = PF_BYTE_RGBA,
            const String& rgbType = StringUtil::BLANK, const String& alphaType = StringUtil::BLANK);

        Image & combineTwoImagesAsRGBA(const Image& rgb, const Image& alpha, PixelFormat format = PF_BYTE_RGBA);

        
        void save(const String& filename);

        DataStreamPtr encode(const String& formatextension);

        uchar* getData(void);

        const uchar * getData() const;       

        size_t getSize() const;

        uint8 getNumMipmaps() const;

        bool hasFlag(const ImageFlags imgFlag) const;

        uint32 getWidth(void) const;

        uint32 getHeight(void) const;

        uint32 getDepth(void) const;
        
        size_t getNumFaces(void) const;

        size_t getRowSpan(void) const;

        PixelFormat getFormat() const;

        uchar getBPP() const;

        bool getHasAlpha() const;
        
        static void applyGamma( uchar *buffer, Real gamma, size_t size, uchar bpp );

        ColourValue getColourAt(size_t x, size_t y, size_t z) const;
        
        void setColourAt(ColourValue const &cv, size_t x, size_t y, size_t z);

        PixelBox getPixelBox(size_t face = 0, size_t mipmap = 0) const;

        void freeMemory();

        enum Filter
        {
            FILTER_NEAREST,
            FILTER_LINEAR,
            FILTER_BILINEAR,
            FILTER_BOX,
            FILTER_TRIANGLE,
            FILTER_BICUBIC
        };
        static void scale(const PixelBox &src, const PixelBox &dst, Filter filter = FILTER_BILINEAR);
        
        void resize(ushort width, ushort height, Filter filter = FILTER_BILINEAR);
        
        static size_t calculateSize(size_t mipmaps, size_t faces, uint32 width, uint32 height, uint32 depth, PixelFormat format);

        static String getFileExtFromMagic(DataStreamPtr stream);

    protected:
        uint32 mWidth;
        uint32 mHeight;
        uint32 mDepth;
        size_t mBufSize;
        uint8 mNumMipmaps;
        int mFlags;

        PixelFormat mFormat;

        uchar mPixelSize;
        uchar* mBuffer;

        bool mAutoDelete;
    };

    typedef vector<Image*>::type ImagePtrList;
    typedef vector<const Image*>::type ConstImagePtrList;

} // namespace

#endif