SFML - Simple and Fast Multimedia Library

SFML 2.5.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

Cursor.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef SFML_CURSOR_HPP
26#define SFML_CURSOR_HPP
27
29// Headers
31#include <SFML/Window/Export.hpp>
32#include <SFML/System/NonCopyable.hpp>
33#include <SFML/System/Vector2.hpp>
34
35namespace sf
36{
37namespace priv
38{
39 class CursorImpl;
40}
41
46 class SFML_WINDOW_API Cursor : NonCopyable
47{
48public:
49
76 enum Type
77 {
78 Arrow,
79 ArrowWait,
80 Wait,
81 Text,
82 Hand,
83 SizeHorizontal,
84 SizeVertical,
85 SizeTopLeftBottomRight,
86 SizeBottomLeftTopRight,
87 SizeAll,
88 Cross,
89 Help,
90 NotAllowed
91 };
92
93public:
94
104 Cursor();
105
113 ~Cursor();
114
144 bool loadFromPixels(const Uint8* pixels, Vector2u size, Vector2u hotspot);
145
160 bool loadFromSystem(Type type);
161
162private:
163
164 friend class Window;
165
175 const priv::CursorImpl& getImpl() const;
176
177private:
178
180 // Member data
182 priv::CursorImpl* m_impl;
183};
184
185} // namespace sf
186
187
188#endif // SFML_CURSOR_HPP
189
190
sf::Cursor
Cursor defines the appearance of a system cursor.
Definition: Cursor.hpp:47
sf::Cursor::Cursor
Cursor()
Default constructor.
sf::Cursor::~Cursor
~Cursor()
Destructor.
sf::Cursor::Type
Type
Enumeration of the native system cursor types.
Definition: Cursor.hpp:77
sf::Cursor::SizeHorizontal
@ SizeHorizontal
Horizontal double arrow cursor.
Definition: Cursor.hpp:83
sf::Cursor::ArrowWait
@ ArrowWait
Busy arrow cursor.
Definition: Cursor.hpp:79
sf::Cursor::Text
@ Text
I-beam, cursor when hovering over a field allowing text entry.
Definition: Cursor.hpp:81
sf::Cursor::SizeAll
@ SizeAll
Combination of SizeHorizontal and SizeVertical.
Definition: Cursor.hpp:87
sf::Cursor::Arrow
@ Arrow
Arrow cursor (default)
Definition: Cursor.hpp:78
sf::Cursor::SizeTopLeftBottomRight
@ SizeTopLeftBottomRight
Double arrow cursor going from top-left to bottom-right.
Definition: Cursor.hpp:85
sf::Cursor::SizeVertical
@ SizeVertical
Vertical double arrow cursor.
Definition: Cursor.hpp:84
sf::Cursor::Wait
@ Wait
Busy cursor.
Definition: Cursor.hpp:80
sf::Cursor::SizeBottomLeftTopRight
@ SizeBottomLeftTopRight
Double arrow cursor going from bottom-left to top-right.
Definition: Cursor.hpp:86
sf::Cursor::Hand
@ Hand
Pointing hand cursor.
Definition: Cursor.hpp:82
sf::Cursor::Help
@ Help
Help cursor.
Definition: Cursor.hpp:89
sf::Cursor::Cross
@ Cross
Crosshair cursor.
Definition: Cursor.hpp:88
sf::Cursor::loadFromPixels
bool loadFromPixels(const Uint8 *pixels, Vector2u size, Vector2u hotspot)
Create a cursor with the provided image.
sf::Cursor::loadFromSystem
bool loadFromSystem(Type type)
Create a native system cursor.
sf::NonCopyable
Utility class that makes any derived class non-copyable.
Definition: NonCopyable.hpp:42
sf::Vector2< unsigned int >
sf::Window
Window that serves as a target for OpenGL rendering.
Definition: Window/Window.hpp:59