Mouse.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 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>
 
 
namespace sf
{
class WindowBase;

namespace Mouse
{
enum class Button
{
    Left,   
    Right,  
    Middle, 
    Extra1, 
    Extra2  
};
 
// NOLINTNEXTLINE(readability-identifier-naming)
static constexpr unsigned int ButtonCount{5}; 

enum class Wheel
{
    Vertical,  
    Horizontal 
};

[[nodiscard]] SFML_WINDOW_API bool isButtonPressed(Button button);

[[nodiscard]] SFML_WINDOW_API Vector2i getPosition();

[[nodiscard]] SFML_WINDOW_API Vector2i getPosition(const WindowBase& relativeTo);

SFML_WINDOW_API void setPosition(Vector2i position);

SFML_WINDOW_API void setPosition(Vector2i position, const WindowBase& relativeTo);
} // namespace Mouse
 
} // namespace sf