Image.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//

#ifndef SFML_IMAGE_HPP
#define SFML_IMAGE_HPP

// Headers
#include <SFML/System/Resource.hpp>
#include <SFML/Graphics/Color.hpp>
#include <SFML/Graphics/Rect.hpp>
#include <string>
#include <vector>


namespace sf
{
class Renderer;
class RenderImage;
class RenderWindow;

class SFML_API Image : public Resource<Image>
{
public :

    Image();

    Image(const Image& copy);

    ~Image();

    bool LoadFromFile(const std::string& filename);

    bool LoadFromMemory(const void* data, std::size_t sizeInBytes);

    bool LoadFromPixels(unsigned int width, unsigned int height, const Uint8* pixels);

    bool SaveToFile(const std::string& filename) const;

    bool Create(unsigned int width, unsigned int height, const Color& color = Color(0, 0, 0));

    void CreateMaskFromColor(const Color& transparentColor, Uint8 alpha = 0);

    void Copy(const Image& source, unsigned int destX, unsigned int destY, const IntRect& sourceRect = IntRect(0, 0, 0, 0), bool applyAlpha = false);

    bool CopyScreen(RenderWindow& window, const IntRect& sourceRect = IntRect(0, 0, 0, 0));

    void SetPixel(unsigned int x, unsigned int y, const Color& color);

    const Color& GetPixel(unsigned int x, unsigned int y) const;

    const Uint8* GetPixelsPtr() const;

    void UpdatePixels(const Uint8* pixels);

    void UpdatePixels(const Uint8* pixels, const IntRect& rectangle);

    void Bind() const;

    void SetSmooth(bool smooth);

    unsigned int GetWidth() const;

    unsigned int GetHeight() const;

    bool IsSmooth() const;

    FloatRect GetTexCoords(const IntRect& rectangle) const;

    static unsigned int GetMaximumSize();

    static unsigned int GetValidSize(unsigned int size);

    Image& operator =(const Image& other);

private :

    friend class Renderer;
    friend class RenderImage;

    bool CreateTexture();

    void EnsureTextureUpdate() const;

    void EnsureArrayUpdate() const;

    void Use() const;

    void Reset();

    void DestroyTexture();

    // Types
    typedef std::vector<Color> ColorArray; 

    // Member data
    unsigned int       myWidth;          
    unsigned int       myHeight;         
    unsigned int       myTextureWidth;   
    unsigned int       myTextureHeight;  
    unsigned int       myTexture;        
    bool               myIsSmooth;       
    mutable ColorArray myPixels;         
    mutable bool       myTextureUpdated; 
    mutable bool       myArrayUpdated;   
    mutable bool       myPixelsFlipped;  
};

} // namespace sf


#endif // SFML_IMAGE_HPP

 ::  Copyright © 2007-2008 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  ::