Joystick.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/String.hpp>

namespace sf::Joystick
{
// NOLINTBEGIN(readability-identifier-naming)
static constexpr unsigned int Count{8};        
static constexpr unsigned int ButtonCount{32}; 
static constexpr unsigned int AxisCount{8};    
// NOLINTEND(readability-identifier-naming)

enum class Axis
{
    X,    
    Y,    
    Z,    
    R,    
    U,    
    V,    
    PovX, 
    PovY  
};

struct SFML_WINDOW_API Identification
{
    String       name{"No Joystick"}; 
    unsigned int vendorId{};          
    unsigned int productId{};         
};

[[nodiscard]] SFML_WINDOW_API bool isConnected(unsigned int joystick);

[[nodiscard]] SFML_WINDOW_API unsigned int getButtonCount(unsigned int joystick);

[[nodiscard]] SFML_WINDOW_API bool hasAxis(unsigned int joystick, Axis axis);

[[nodiscard]] SFML_WINDOW_API bool isButtonPressed(unsigned int joystick, unsigned int button);

[[nodiscard]] SFML_WINDOW_API float getAxisPosition(unsigned int joystick, Axis axis);

[[nodiscard]] SFML_WINDOW_API Identification getIdentification(unsigned int joystick);

SFML_WINDOW_API void update();
} // namespace sf::Joystick