Image.hpp

Warning

This page refers to an old version of SFML. Click here to switch to the latest version.

• Main Page
• Namespaces
• Classes
• Files

• File List
• File Members

• SFML
• include
• SFML
• Graphics

Image.hpp

Go to the documentation of this file.

//
// 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 RenderWindow;

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

    Image();

    Image(const Image& Copy);

    Image(unsigned int Width, unsigned int Height, const Color& Col = Color(0, 0, 0, 255));

    Image(unsigned int Width, unsigned int Height, const Uint8* Data);

    ~Image();

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

    bool LoadFromMemory(const char* Data, std::size_t SizeInBytes);

    bool LoadFromPixels(unsigned int Width, unsigned int Height, const Uint8* Data);

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

    bool Create(unsigned int Width, unsigned int Height, Color Col = Color(0, 0, 0, 255));

    void CreateMaskFromColor(Color ColorKey, 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& Col);

    const Color& GetPixel(unsigned int X, unsigned int Y) const;

    const Uint8* GetPixelsPtr() const;

    void Bind() const;

    void SetSmooth(bool Smooth);

    unsigned int GetWidth() const;

    unsigned int GetHeight() const;

    bool IsSmooth() const;

    FloatRect GetTexCoords(const IntRect& Rect) const;

    static unsigned int GetValidTextureSize(unsigned int Size);

    Image& operator =(const Image& Other);
 
private :

    bool CreateTexture();

    void EnsureTextureUpdate() const;

    void EnsureArrayUpdate() const;

    void Reset();

    void DestroyTexture();

    // Member data
    unsigned int               myWidth;             
    unsigned int               myHeight;            
    unsigned int               myTextureWidth;      
    unsigned int               myTextureHeight;     
    unsigned int               myTexture;           
    bool                       myIsSmooth;          
    mutable std::vector<Color> myPixels;            
    mutable bool               myNeedTextureUpdate; 
    mutable bool               myNeedArrayUpdate;   
};
 
} // namespace sf
 
 
#endif // SFML_IMAGE_HPP