Image.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
******************************************************************************/
#ifndef NOMLIB_SDL2_IMAGE_HEADERS
#define NOMLIB_SDL2_IMAGE_HEADERS
 
#include <string>
#include <memory>
 
// TODO: Forward declare
#include <SDL.h>
 
#include "nomlib/config.hpp"
#include "nomlib/math/Color4.hpp"
#include "nomlib/math/Point2.hpp"
#include "nomlib/math/Size2.hpp"
#include "nomlib/math/Rect.hpp"
 
namespace nom {

class Image
{
  public:
    typedef Image* RawPtr;
    typedef std::shared_ptr<Image> SharedPtr;

    Image ( void );

    ~Image( void );

    Image ( const Image& copy );

    Image& operator = ( const Image& other );

    SDL_Surface* clone ( void ) const;

    SDL_Surface* image ( void ) const;
 
    SDL_Texture* texture ( void ) const;

    bool valid ( void ) const;

    bool initialize ( void* pixels, int32 width, int32 height,
                      int bits_per_pixel, uint16 pitch,
                      uint32 Rmask, uint32 Gmask, uint32 Bmask, uint32 Amask
                    );

    bool initialize ( int32 width, int32 height, int bits_per_pixel, uint32 Rmask, uint32 Gmask, uint32 Bmask, uint32 Amask );

    bool initialize ( SDL_Surface* source );

    bool create(const Point2i& size, uint32 pixel_format);
    bool create( const Size2i& size, uint32 pixel_format );

    bool initialize ( const Point2i& size );
 
    int32 width ( void ) const;
    int32 height ( void ) const;
    void* pixels ( void ) const;
    uint16 pitch ( void ) const;
 
    uint8 bits_per_pixel ( void ) const;
 
    const SDL_PixelFormat* pixel_format ( void ) const;

    uint32 red_mask ( void ) const;

    uint32 green_mask ( void ) const;

    uint32 blue_mask ( void ) const;

    uint32 alpha_mask ( void ) const;
 
    const IntRect bounds ( void ) const;

    bool must_lock() const;

    bool locked( void ) const;

    uint8 alpha ( void ) const;
 
    const Point2i position ( void ) const;
 
    void set_bounds ( const IntRect& bounds );

    bool load( const std::string& filename, uint32 pixel_format = SDL_PIXELFORMAT_ARGB8888 );

    bool load_memory( const char* buffer,
                      int buffer_size,
                      const std::string& ext,
                      uint32 pixel_format = SDL_PIXELFORMAT_ARGB8888 );

    bool load_bmp ( const std::string& filename, uint32 pixel_format = SDL_PIXELFORMAT_ARGB8888 );

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

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

    Size2i size() const;

    const Color4i colorkey ( void ) const;

    const SDL_BlendMode blend_mode ( void ) const;

    const Color4i color_modulation ( void ) const;

    bool set_colorkey(const Color4i& colorkey, bool flag);

    bool RLE(bool flag);

    uint32 pixel( int x, int y ) const;

    Color4i color4i_pixel( int x, int y ) const;

    Color4i pixel( const Point2i& pos ) const;

    void set_pixel( int x, int y, const Color4i& color );

    bool set_blend_mode ( const SDL_BlendMode blend );

    bool lock() const;

    void unlock ( void ) const;
 
    bool set_alpha ( uint8 opacity );
 
    void set_position ( const Point2i& pos );

    void draw ( SDL_Surface* destination, const IntRect& bounds ) const;

    bool set_color_modulation ( const Color4i& color );
 
  private:
    std::shared_ptr<SDL_Surface> image_;
 
    Point2i position_;  // Not implemented
    IntRect bounds_;    // Not implemented
};
 
} // namespace nom
 
#endif // NOMLIB_SDL_IMAGE_HEADERS defined