Cursor.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2018 Julien Bernard
 *
 * 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.
 *
 * Part of this file comes from SFML, with the same license:
 * Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
 */
#ifndef GF_CURSOR_H
#define GF_CURSOR_H

#include <cstdint>

#include "Portability.h"
#include "Vector.h"

struct SDL_Cursor;
struct SDL_Surface;

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  class Image;

  class GF_API Cursor {
  public:

    enum Type {
      Arrow,                  
      ArrowWait,              
      Wait,                   
      Text,                   
      Hand,                   
      SizeHorizontal,         
      SizeVertical,           
      SizeTopLeftBottomRight, 
      SizeBottomLeftTopRight, 
      SizeAll,                
      Cross,                  
      NotAllowed              
    };

    Cursor();

    Cursor(const Cursor&) = delete;

    Cursor& operator=(const Cursor&) = delete;

    Cursor(Cursor&& other) noexcept;

    Cursor& operator=(Cursor&& other) noexcept;

    ~Cursor();

    bool loadFromPixels(const uint8_t* pixels, Vector2u size, Vector2u hotspot);

    bool loadFromImage(const Image& image, Vector2u hotspot);

    bool loadFromSystem(Type type);

  private:
    friend class Window;
    SDL_Cursor *m_cursor;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_CURSOR_H