documentation/3.0.1/Cursor_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2025 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.

//


#pragma once


// Headers

#include <SFML/Window/Export.hpp>


#include <SFML/System/Vector2.hpp>


#include <memory>

#include <optional>


#include <cstdint>


namespace sf

{

namespace priv

{

class CursorImpl;

}


class SFML_WINDOW_API Cursor

{

public:


    enum class Type

    {

        Arrow,

        ArrowWait,

        Wait,

        Text,

        Hand,

        SizeHorizontal,

        SizeVertical,

        SizeTopLeftBottomRight,

        SizeBottomLeftTopRight,

        SizeLeft,

        SizeRight,

        SizeTop,

        SizeBottom,

        SizeTopLeft,

        SizeBottomRight,

        SizeBottomLeft,

        SizeTopRight,

        SizeAll,

        Cross,

        Help,

        NotAllowed

    };


    ~Cursor();


    Cursor(const Cursor&) = delete;


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


    Cursor(Cursor&&) noexcept;


    Cursor& operator=(Cursor&&) noexcept;


    Cursor(const std::uint8_t* pixels, Vector2u size, Vector2u hotspot);


    explicit Cursor(Type type);


    [[nodiscard]] static std::optional<Cursor> createFromPixels(const std::uint8_t* pixels, Vector2u size, Vector2u hotspot);


    [[nodiscard]] static std::optional<Cursor> createFromSystem(Type type);


private:

    friend class WindowBase;


    Cursor();


    [[nodiscard]] const priv::CursorImpl& getImpl() const;


    // Member data

    std::unique_ptr<priv::CursorImpl> m_impl;

};


} // namespace sf


Vector2.hpp

Export.hpp

SFML_WINDOW_API
#define SFML_WINDOW_API
Definition Window/Export.hpp:42

sf::Cursor::WindowBase
friend class WindowBase
Definition Cursor.hpp:245

sf::Cursor::createFromSystem
static std::optional< Cursor > createFromSystem(Type type)
Create a native system cursor.

sf::Cursor::~Cursor
~Cursor()
Destructor.

sf::Cursor::Cursor
Cursor(const Cursor &)=delete
Deleted copy constructor.

sf::Cursor::createFromPixels
static std::optional< Cursor > createFromPixels(const std::uint8_t *pixels, Vector2u size, Vector2u hotspot)
Create a cursor with the provided image.

sf::Cursor::Type
Type
Enumeration of the native system cursor types.
Definition Cursor.hpp:90

sf::Cursor::Type::SizeVertical
@ SizeVertical
Vertical double arrow cursor.
Definition Cursor.hpp:97

sf::Cursor::Type::Arrow
@ Arrow
Arrow cursor (default)
Definition Cursor.hpp:91

sf::Cursor::Type::Wait
@ Wait
Busy cursor.
Definition Cursor.hpp:93

sf::Cursor::Type::SizeTopLeftBottomRight
@ SizeTopLeftBottomRight
Double arrow cursor going from top-left to bottom-right.
Definition Cursor.hpp:98

sf::Cursor::Type::SizeHorizontal
@ SizeHorizontal
Horizontal double arrow cursor.
Definition Cursor.hpp:96

sf::Cursor::Type::SizeLeft
@ SizeLeft
Left arrow cursor on Linux, same as SizeHorizontal on other platforms.
Definition Cursor.hpp:100

sf::Cursor::Type::SizeBottom
@ SizeBottom
Down arrow cursor on Linux, same as SizeVertical on other platforms.
Definition Cursor.hpp:103

sf::Cursor::Type::SizeTopLeft
@ SizeTopLeft
Top-left arrow cursor on Linux, same as SizeTopLeftBottomRight on other platforms.
Definition Cursor.hpp:104

sf::Cursor::Type::SizeBottomRight
@ SizeBottomRight
Bottom-right arrow cursor on Linux, same as SizeTopLeftBottomRight on other platforms.
Definition Cursor.hpp:105

sf::Cursor::Type::Help
@ Help
Help cursor.
Definition Cursor.hpp:110

sf::Cursor::Type::SizeAll
@ SizeAll
Combination of SizeHorizontal and SizeVertical.
Definition Cursor.hpp:108

sf::Cursor::Type::SizeTopRight
@ SizeTopRight
Top-right arrow cursor on Linux, same as SizeBottomLeftTopRight on other platforms.
Definition Cursor.hpp:107

sf::Cursor::Type::Text
@ Text
I-beam, cursor when hovering over a field allowing text entry.
Definition Cursor.hpp:94

sf::Cursor::Type::Hand
@ Hand
Pointing hand cursor.
Definition Cursor.hpp:95

sf::Cursor::Type::SizeTop
@ SizeTop
Up arrow cursor on Linux, same as SizeVertical on other platforms.
Definition Cursor.hpp:102

sf::Cursor::Type::SizeBottomLeft
@ SizeBottomLeft
Bottom-left arrow cursor on Linux, same as SizeBottomLeftTopRight on other platforms.
Definition Cursor.hpp:106

sf::Cursor::Type::SizeBottomLeftTopRight
@ SizeBottomLeftTopRight
Double arrow cursor going from bottom-left to top-right.
Definition Cursor.hpp:99

sf::Cursor::Type::ArrowWait
@ ArrowWait
Busy arrow cursor.
Definition Cursor.hpp:92

sf::Cursor::Type::Cross
@ Cross
Crosshair cursor.
Definition Cursor.hpp:109

sf::Cursor::Type::SizeRight
@ SizeRight
Right arrow cursor on Linux, same as SizeHorizontal on other platforms.
Definition Cursor.hpp:101

sf::Cursor::Type::NotAllowed
@ NotAllowed
Action not allowed cursor.
Definition Cursor.hpp:111

sf::Cursor::operator=
Cursor & operator=(const Cursor &)=delete
Deleted copy assignment.

sf::Cursor::Cursor
Cursor(Cursor &&) noexcept
Move constructor.

sf
Definition AudioResource.hpp:36

sf::Vector2u
Vector2< unsigned int > Vector2u
Definition Vector2.hpp:209