Texture.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2016 Laurent Gomila (laurent@sfml-dev.org)
//
// 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_TEXTURE_HPP
#define SFML_TEXTURE_HPP

// Headers
#include <SFML/Graphics/Export.hpp>
#include <SFML/Graphics/Image.hpp>
#include <SFML/Window/GlResource.hpp>


namespace sf
{
class Window;
class RenderTarget;
class RenderTexture;
class InputStream;

class SFML_GRAPHICS_API Texture : GlResource
{
public:

    enum CoordinateType
    {
        Normalized, 
        Pixels      
    };

public:

    Texture();

    Texture(const Texture& copy);

    ~Texture();

    bool create(unsigned int width, unsigned int height);

    bool loadFromFile(const std::string& filename, const IntRect& area = IntRect());

    bool loadFromMemory(const void* data, std::size_t size, const IntRect& area = IntRect());

    bool loadFromStream(InputStream& stream, const IntRect& area = IntRect());

    bool loadFromImage(const Image& image, const IntRect& area = IntRect());

    Vector2u getSize() const;

    Image copyToImage() const;

    void update(const Uint8* pixels);

    void update(const Uint8* pixels, unsigned int width, unsigned int height, unsigned int x, unsigned int y);

    void update(const Image& image);

    void update(const Image& image, unsigned int x, unsigned int y);

    void update(const Window& window);

    void update(const Window& window, unsigned int x, unsigned int y);

    void setSmooth(bool smooth);

    bool isSmooth() const;

    void setSrgb(bool sRgb);

    bool isSrgb() const;

    void setRepeated(bool repeated);

    bool isRepeated() const;

    bool generateMipmap();

    Texture& operator =(const Texture& right);

    unsigned int getNativeHandle() const;

    static void bind(const Texture* texture, CoordinateType coordinateType = Normalized);

    static unsigned int getMaximumSize();

private:

    friend class RenderTexture;
    friend class RenderTarget;

    static unsigned int getValidSize(unsigned int size);

    void invalidateMipmap();

    // Member data
    Vector2u     m_size;          
    Vector2u     m_actualSize;    
    unsigned int m_texture;       
    bool         m_isSmooth;      
    bool         m_sRgb;          
    bool         m_isRepeated;    
    mutable bool m_pixelsFlipped; 
    bool         m_fboAttachment; 
    bool         m_hasMipmap;     
    Uint64       m_cacheId;       
};

} // namespace sf


#endif // SFML_TEXTURE_HPP