Add warning about XButton1 and 2 on X11.

SFML · Mar 8, 2022 · c70418b · c70418b
1 parent 7dfc7f0
commit c70418b
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/include/SFML/Window/Mouse.hpp b/include/SFML/Window/Mouse.hpp
@@ -53,8 +53,8 @@ class SFML_WINDOW_API Mouse
         Left,       //!< The left mouse button
         Right,      //!< The right mouse button
         Middle,     //!< The middle (wheel) mouse button
-        XButton1,   //!< The first extra mouse button
-        XButton2,   //!< The second extra mouse button
+        XButton1,   //!< The first extra mouse button (not available on Linux)
+        XButton2,   //!< The second extra mouse button (not available on Linux)
 
         ButtonCount //!< Keep last -- the total number of mouse buttons
     };
@@ -172,6 +172,8 @@ class SFML_WINDOW_API Mouse
 /// sf::Mouse::setPosition(sf::Vector2i(100, 200), window);
 /// \endcode
 ///
+/// \warning sf::Mouse::XButton1 and sf::Mouse::XButton2 are not available on Linux.
+///
 /// \see sf::Joystick, sf::Keyboard, sf::Touch
 ///
 ////////////////////////////////////////////////////////////