1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
////////////////////////////////////////////////////////////
//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
//
// 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 SFML_CURSOR_HPP
#define SFML_CURSOR_HPP
////////////////////////////////////////////////////////////
// Headers
////////////////////////////////////////////////////////////
#include <SFML/Window/Export.hpp>
#include <SFML/System/NonCopyable.hpp>
#include <SFML/System/Vector2.hpp>
namespace sf
{
namespace priv
{
class CursorImpl;
}
////////////////////////////////////////////////////////////
/// \brief Cursor defines the appearance of a system cursor
///
////////////////////////////////////////////////////////////
class SFML_WINDOW_API Cursor : NonCopyable
{
public:
////////////////////////////////////////////////////////////
/// \brief Enumeration of the native system cursor types
///
/// Refer to the following table to determine which cursor
/// is available on which platform.
///
/// Type | Linux | Mac OS X | Windows |
/// ------------------------------------|:-----:|:--------:|:--------:|
/// sf::Cursor::Arrow | yes | yes | yes |
/// sf::Cursor::ArrowWait | no | no | yes |
/// sf::Cursor::Wait | yes | no | yes |
/// sf::Cursor::Text | yes | yes | yes |
/// sf::Cursor::Hand | yes | yes | yes |
/// sf::Cursor::SizeHorizontal | yes | yes | yes |
/// sf::Cursor::SizeVertical | yes | yes | yes |
/// sf::Cursor::SizeTopLeftBottomRight | no | yes* | yes |
/// sf::Cursor::SizeBottomLeftTopRight | no | yes* | yes |
/// sf::Cursor::SizeLeft | yes | yes** | yes** |
/// sf::Cursor::SizeRight | yes | yes** | yes** |
/// sf::Cursor::SizeTop | yes | yes** | yes** |
/// sf::Cursor::SizeBottom | yes | yes** | yes** |
/// sf::Cursor::SizeTopLeft | yes | yes** | yes** |
/// sf::Cursor::SizeTopRight | yes | yes** | yes** |
/// sf::Cursor::SizeBottomLeft | yes | yes** | yes** |
/// sf::Cursor::SizeBottomRight | yes | yes** | yes** |
/// sf::Cursor::SizeAll | yes | no | yes |
/// sf::Cursor::Cross | yes | yes | yes |
/// sf::Cursor::Help | yes | yes* | yes |
/// sf::Cursor::NotAllowed | yes | yes | yes |
///
/// * These cursor types are undocumented so may not
/// be available on all versions, but have been tested on 10.13
///
/// ** On Windows and macOS, double-headed arrows are used
///
////////////////////////////////////////////////////////////
enum Type
{
Arrow, //!< Arrow cursor (default)
ArrowWait, //!< Busy arrow cursor
Wait, //!< Busy cursor
Text, //!< I-beam, cursor when hovering over a field allowing text entry
Hand, //!< Pointing hand cursor
SizeHorizontal, //!< Horizontal double arrow cursor
SizeVertical, //!< Vertical double arrow cursor
SizeTopLeftBottomRight, //!< Double arrow cursor going from top-left to bottom-right
SizeBottomLeftTopRight, //!< Double arrow cursor going from bottom-left to top-right
SizeLeft, //!< Left arrow cursor on Linux, same as SizeHorizontal on other platforms
SizeRight, //!< Right arrow cursor on Linux, same as SizeHorizontal on other platforms
SizeTop, //!< Up arrow cursor on Linux, same as SizeVertical on other platforms
SizeBottom, //!< Down arrow cursor on Linux, same as SizeVertical on other platforms
SizeTopLeft, //!< Top-left arrow cursor on Linux, same as SizeTopLeftBottomRight on other platforms
SizeBottomRight, //!< Bottom-right arrow cursor on Linux, same as SizeTopLeftBottomRight on other platforms
SizeBottomLeft, //!< Bottom-left arrow cursor on Linux, same as SizeBottomLeftTopRight on other platforms
SizeTopRight, //!< Top-right arrow cursor on Linux, same as SizeBottomLeftTopRight on other platforms
SizeAll, //!< Combination of SizeHorizontal and SizeVertical
Cross, //!< Crosshair cursor
Help, //!< Help cursor
NotAllowed //!< Action not allowed cursor
};
public:
////////////////////////////////////////////////////////////
/// \brief Default constructor
///
/// This constructor doesn't actually create the cursor;
/// initially the new instance is invalid and must not be
/// used until either loadFromPixels() or loadFromSystem()
/// is called and successfully created a cursor.
///
////////////////////////////////////////////////////////////
Cursor();
////////////////////////////////////////////////////////////
/// \brief Destructor
///
/// This destructor releases the system resources
/// associated with this cursor, if any.
///
////////////////////////////////////////////////////////////
~Cursor();
////////////////////////////////////////////////////////////
/// \brief Create a cursor with the provided image
///
/// \a pixels must be an array of \a width by \a height pixels
/// in 32-bit RGBA format. If not, this will cause undefined behavior.
///
/// If \a pixels is null or either \a width or \a height are 0,
/// the current cursor is left unchanged and the function will
/// return false.
///
/// In addition to specifying the pixel data, you can also
/// specify the location of the hotspot of the cursor. The
/// hotspot is the pixel coordinate within the cursor image
/// which will be located exactly where the mouse pointer
/// position is. Any mouse actions that are performed will
/// return the window/screen location of the hotspot.
///
/// \warning On Unix platforms which do not support colored
/// cursors, the pixels are mapped into a monochrome
/// bitmap: pixels with an alpha channel to 0 are
/// transparent, black if the RGB channel are close
/// to zero, and white otherwise.
///
/// \param pixels Array of pixels of the image
/// \param size Width and height of the image
/// \param hotspot (x,y) location of the hotspot
/// \return true if the cursor was successfully loaded;
/// false otherwise
///
////////////////////////////////////////////////////////////
bool loadFromPixels(const Uint8* pixels, Vector2u size, Vector2u hotspot);
////////////////////////////////////////////////////////////
/// \brief Create a native system cursor
///
/// Refer to the list of cursor available on each system
/// (see sf::Cursor::Type) to know whether a given cursor is
/// expected to load successfully or is not supported by
/// the operating system.
///
/// \param type Native system cursor type
/// \return true if and only if the corresponding cursor is
/// natively supported by the operating system;
/// false otherwise
///
////////////////////////////////////////////////////////////
bool loadFromSystem(Type type);
private:
friend class WindowBase;
////////////////////////////////////////////////////////////
/// \brief Get access to the underlying implementation
///
/// This is primarily designed for sf::Window::setMouseCursor,
/// hence the friendship.
///
/// \return a reference to the OS-specific implementation
///
////////////////////////////////////////////////////////////
const priv::CursorImpl& getImpl() const;
private:
////////////////////////////////////////////////////////////
// Member data
////////////////////////////////////////////////////////////
priv::CursorImpl* m_impl; //!< Platform-specific implementation of the cursor
};
} // namespace sf
#endif // SFML_CURSOR_HPP
////////////////////////////////////////////////////////////
/// \class sf::Cursor
/// \ingroup window
///
/// \warning Features related to Cursor are not supported on
/// iOS and Android.
///
/// This class abstracts the operating system resources
/// associated with either a native system cursor or a custom
/// cursor.
///
/// After loading the cursor the graphical appearance
/// with either loadFromPixels() or loadFromSystem(), the
/// cursor can be changed with sf::Window::setMouseCursor().
///
/// The behaviour is undefined if the cursor is destroyed while
/// in use by the window.
///
/// Usage example:
/// \code
/// sf::Window window;
///
/// // ... create window as usual ...
///
/// sf::Cursor cursor;
/// if (cursor.loadFromSystem(sf::Cursor::Hand))
/// window.setMouseCursor(cursor);
/// \endcode
///
/// \see sf::Window::setMouseCursor
///
////////////////////////////////////////////////////////////
|
