Documentation of SFML 2.6.0

Warning: this page refers to an old version of SFML. Click here to switch to the latest version.
Loading...
Searching...
No Matches
Cursor.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2023 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
46class SFML_WINDOW_API Cursor : NonCopyable
47{
48public:
49
86 enum Type
87 {
108 NotAllowed
109 };
110
111public:
112
123
132
163 bool loadFromPixels(const Uint8* pixels, Vector2u size, Vector2u hotspot);
164
180
181private:
182
183 friend class WindowBase;
184
194 const priv::CursorImpl& getImpl() const;
195
196private:
197
199 // Member data
201 priv::CursorImpl* m_impl;
202};
203
204} // namespace sf
205
206
207#endif // SFML_CURSOR_HPP
208
209
Cursor defines the appearance of a system cursor.
Definition: Cursor.hpp:47
Cursor()
Default constructor.
~Cursor()
Destructor.
Type
Enumeration of the native system cursor types.
Definition: Cursor.hpp:87
@ SizeHorizontal
Horizontal double arrow cursor.
Definition: Cursor.hpp:93
@ ArrowWait
Busy arrow cursor.
Definition: Cursor.hpp:89
@ Text
I-beam, cursor when hovering over a field allowing text entry.
Definition: Cursor.hpp:91
@ SizeAll
Combination of SizeHorizontal and SizeVertical.
Definition: Cursor.hpp:105
@ SizeTopLeft
Top-left arrow cursor on Linux, same as SizeTopLeftBottomRight on other platforms.
Definition: Cursor.hpp:101
@ SizeLeft
Left arrow cursor on Linux, same as SizeHorizontal on other platforms.
Definition: Cursor.hpp:97
@ SizeBottomRight
Bottom-right arrow cursor on Linux, same as SizeTopLeftBottomRight on other platforms.
Definition: Cursor.hpp:102
@ SizeTop
Up arrow cursor on Linux, same as SizeVertical on other platforms.
Definition: Cursor.hpp:99
@ SizeBottomLeft
Bottom-left arrow cursor on Linux, same as SizeBottomLeftTopRight on other platforms.
Definition: Cursor.hpp:103
@ SizeTopRight
Top-right arrow cursor on Linux, same as SizeBottomLeftTopRight on other platforms.
Definition: Cursor.hpp:104
@ Arrow
Arrow cursor (default)
Definition: Cursor.hpp:88
@ SizeTopLeftBottomRight
Double arrow cursor going from top-left to bottom-right.
Definition: Cursor.hpp:95
@ SizeBottom
Down arrow cursor on Linux, same as SizeVertical on other platforms.
Definition: Cursor.hpp:100
@ SizeVertical
Vertical double arrow cursor.
Definition: Cursor.hpp:94
@ Wait
Busy cursor.
Definition: Cursor.hpp:90
@ SizeBottomLeftTopRight
Double arrow cursor going from bottom-left to top-right.
Definition: Cursor.hpp:96
@ Hand
Pointing hand cursor.
Definition: Cursor.hpp:92
@ SizeRight
Right arrow cursor on Linux, same as SizeHorizontal on other platforms.
Definition: Cursor.hpp:98
@ Help
Help cursor.
Definition: Cursor.hpp:107
@ Cross
Crosshair cursor.
Definition: Cursor.hpp:106
bool loadFromPixels(const Uint8 *pixels, Vector2u size, Vector2u hotspot)
Create a cursor with the provided image.
bool loadFromSystem(Type type)
Create a native system cursor.
Utility class that makes any derived class non-copyable.
Definition: NonCopyable.hpp:42
Window that serves as a base for other windows.
Definition: WindowBase.hpp:57