Surface.hh

/*
  libSDL2pp - C++ bindings/wrapper for SDL2
  Copyright (C) 2014-2015 Dmitry Marakasov <amdmi3@amdmi3.ru>
 
  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 SDL2PP_SURFACE_HH
#define SDL2PP_SURFACE_HH
 
#include <SDL_stdinc.h>
#include <SDL_blendmode.h>
 
#include <SDL2pp/Config.hh>
#include <SDL2pp/Optional.hh>
#include <SDL2pp/Rect.hh>
#include <SDL2pp/Point.hh>
#include <SDL2pp/Export.hh>
#include <SDL2pp/Color.hh>
 
struct SDL_Surface;
struct SDL_PixelFormat;
 
namespace SDL2pp {
 
class RWops;
 
class SDL2PP_EXPORT Surface {
private:
    SDL_Surface* surface_; 
 
public:
    class LockHandle {
        friend class Surface;
    private:
        Surface* surface_;  
 
    private:
        explicit LockHandle(Surface* surface);
 
    public:
        LockHandle();
 
        ~LockHandle();
 
        LockHandle(LockHandle&& other) noexcept;
 
        LockHandle& operator=(LockHandle&& other) noexcept;
 
        LockHandle(const LockHandle& other) = delete;
 
        LockHandle& operator=(const LockHandle& other) = delete;
 
        void* GetPixels() const;
 
        int GetPitch() const;
 
        const SDL_PixelFormat& GetFormat() const;
    };
 
public:
    explicit Surface(SDL_Surface* surface);
 
    Surface(Uint32 flags, int width, int height, int depth, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
 
    Surface(void* pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
 
#ifdef SDL2PP_WITH_IMAGE
    explicit Surface(RWops& rwops);
 
    explicit Surface(const std::string& filename);
#endif
 
    virtual ~Surface();
 
    Surface(Surface&& other) noexcept;
 
    Surface& operator=(Surface&& other) noexcept;
 
    Surface(const Surface&) = delete;
 
    Surface& operator=(const Surface&) = delete;
 
    SDL_Surface* Get() const;
 
    Surface Convert(const SDL_PixelFormat& format);
 
    Surface Convert(Uint32 pixel_format);
 
    void Blit(const Optional<Rect>& srcrect, Surface& dst, const Rect& dstrect);
 
    void BlitScaled(const Optional<Rect>& srcrect, Surface& dst, const Optional<Rect>& dstrect);
 
    LockHandle Lock();
 
    Rect GetClipRect() const;
 
    Uint32 GetColorKey() const;
 
    Uint8 GetAlphaMod() const;
 
    SDL_BlendMode GetBlendMode() const;
 
    Color GetColorAndAlphaMod() const;
 
    void GetColorMod(Uint8& r, Uint8& g, Uint8& b) const;
 
    Surface& SetClipRect(const Optional<Rect>& rect = NullOpt);
 
    Surface& SetColorKey(bool flag, Uint32 key);
 
    Surface& SetAlphaMod(Uint8 alpha = 255);
 
    Surface& SetBlendMode(SDL_BlendMode blendMode);
 
    Surface& SetColorMod(Uint8 r = 255, Uint8 g = 255, Uint8 b = 255);
 
    Surface& SetColorAndAlphaMod(const Color& color);
 
    Surface& SetRLE(bool flag);
 
    Surface& FillRect(const Optional<Rect>& rect, Uint32 color);
 
    Surface& FillRects(const Rect* rects, int count, Uint32 color);
 
    int GetWidth() const;
 
    int GetHeight() const;
 
    Point GetSize() const;
 
    Uint32 GetFormat() const;
};
 
}
 
#endif