SDL_helpers.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_HELPERS_HPP
#define NOMLIB_SDL2_HELPERS_HPP
 
#include <memory>
 
#include <SDL.h>
 
#include "nomlib/config.hpp"
#include "nomlib/math/Color4.hpp"
#include "nomlib/math/Rect.hpp"
#include "nomlib/math/Size2.hpp"
#include "nomlib/math/Point2.hpp"
 
// FIXME: The following declaration is necessary in order to avoid a very
// nasty compiling conflict that can happen under Windows anytime the
// wingdi.h header file is included (commonly from windows.h), due to min and
// max macros being declared there. This is why macros are evil.
//
// In this case, it's probably not a bad idea to rename our RGB functions...
// seeing as they are terrible names for a function description, anyhow!
//
// http://support.microsoft.com/kb/143208
// http://stackoverflow.com/questions/5004858/stdmin-gives-error
#if defined( NOM_PLATFORM_WINDOWS )
  #undef RGB
#endif
 
// Forward declarations
struct _TTF_Font {};
 
namespace nom {
 
enum BlendMode
{
  BLEND_MODE_NONE = SDL_BLENDMODE_NONE,

  BLEND_MODE_BLEND = SDL_BLENDMODE_BLEND,

  BLEND_MODE_ADD = SDL_BLENDMODE_ADD,

  BLEND_MODE_MOD = SDL_BLENDMODE_MOD
};

enum PixelFormat
{
  PIXEL_FORMAT_INVALID = SDL_PIXELFORMAT_UNKNOWN,

  PIXEL_FORMAT_ARGB8888 = SDL_PIXELFORMAT_ARGB8888,

  PIXEL_FORMAT_YV12 = SDL_PIXELFORMAT_YV12,

  PIXEL_FORMAT_IYUV = SDL_PIXELFORMAT_IYUV,

  PIXEL_FORMAT_UYVY = SDL_PIXELFORMAT_UYVY,
};

namespace SDL_WINDOW
{
  typedef std::unique_ptr<SDL_Window, void (*)(SDL_Window*)> UniquePtr;
  typedef SDL_Window* RawPtr;
}

namespace SDL_PIXELFORMAT
{
  typedef SDL_PixelFormat* RawPtr;
}

namespace SDL_SURFACE
{
  typedef std::unique_ptr<SDL_Surface, void(*) (SDL_Surface*)> UniquePtr;
  typedef std::shared_ptr<SDL_Surface> SharedPtr;
  typedef SDL_Surface* RawPtr;
}

namespace SDL_TEXTURE
{
  typedef std::shared_ptr<SDL_Texture> SharedPtr;
  typedef SDL_Texture* RawPtr;
}

BlendMode blend_mode(SDL_BlendMode mode);

SDL_BlendMode SDL_blend_mode(BlendMode mode);

SDL_Rect SDL_RECT ( const IntRect& rectangle );

SDL_Rect SDL_RECT ( const Point2i& pos, const Size2i& size );

SDL_Point SDL_POINT ( const Point2i& );

SDL_Color SDL_COLOR ( const Color4i& color );

const Color4i pixel ( uint32 pixel, const SDL_PixelFormat* fmt );

const Color4i alpha_pixel ( uint32 pixel, const SDL_PixelFormat* fmt );
 
const Color4i pixel ( uint32 pixel, uint32 fmt );
const Color4i alpha_pixel ( uint32 pixel, uint32 fmt );

uint32 RGB ( const Color4i& color, const SDL_PixelFormat* fmt );

uint32 RGB ( const Color4i& color, uint32 fmt );

uint32 RGBA ( const Color4i& color, const SDL_PixelFormat* fmt );

uint32 RGBA ( const Color4i& color, uint32 fmt );

std::string hint(const std::string& name);

bool set_hint(const std::string& name, const std::string& value);
 
const std::string PIXEL_FORMAT_NAME ( uint32 format );

bool save_png ( SDL_SURFACE::RawPtr, const std::string& filename );

int available_render_driver(const std::string& driver);
 
namespace priv {

void FreeWindow ( SDL_Window* );

void FreeRenderTarget ( SDL_Renderer* );

void FreeTexture ( SDL_Texture* );

void FreeSurface ( SDL_Surface* );

void TTF_FreeFont ( _TTF_Font* );
 
} // namespace priv
} // namespace nom

std::ostream& operator <<( std::ostream& os, const SDL_Point& pos );

std::ostream& operator <<( std::ostream& os, const SDL_Rect& rect );

std::ostream& operator <<( std::ostream& os, const SDL_Color& color );
 
#endif // include guard defined