From 3d03a5426b649f7c78c2c3dde3e6149e573f9d99 Mon Sep 17 00:00:00 2001
From: ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>
Date: Fri, 7 Jul 2023 15:11:26 +0200
Subject: Improve documentation of Fl::screen_num(int x, int y)

---
 src/screen_xywh.cxx | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'src')

diff --git a/src/screen_xywh.cxx b/src/screen_xywh.cxx
index 59c12c969..87fa2d6ae 100644
--- a/src/screen_xywh.cxx
+++ b/src/screen_xywh.cxx
@@ -133,6 +133,9 @@ void Fl::screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my, int mw, int
   that contains the specified screen position \p x, \p y
   \param[in] x, y the absolute screen position
   \return a screen number ∈ [0 , Fl::screen_count()-1]
+  \attention When the running system contains screens with different scaling factor values, this API
+ may become ambiguous because a given value pair (\p x, \p y) may belong to distinct screens.
+ In that situation, other APIs should be preferred, e.g., Fl_Window::screen_num() and Fl::screen_scale(int).
 */
 int Fl::screen_num(int x, int y)
 {
-- 
cgit v1.2.3