diff options
| author | ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com> | 2022-11-28 10:08:44 +0100 |
|---|---|---|
| committer | ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com> | 2022-11-28 10:08:44 +0100 |
| commit | 401b3dc008f81c11fd08d786ed251127e122860f (patch) | |
| tree | 4d27ec3b073d75a6b3a91a1e3f641f431be8fb6f /src | |
| parent | c827292ec9c9170a7a87d0a3f3eda3db171ae031 (diff) | |
Doc: repeat that screens are numbered starting from 0 in the API
Diffstat (limited to 'src')
| -rw-r--r-- | src/Fl.cxx | 4 | ||||
| -rw-r--r-- | src/screen_xywh.cxx | 5 |
2 files changed, 6 insertions, 3 deletions
diff --git a/src/Fl.cxx b/src/Fl.cxx index aa2c9f41e..15eee143e 100644 --- a/src/Fl.cxx +++ b/src/Fl.cxx @@ -2162,13 +2162,13 @@ int Fl::get_font_sizes(Fl_Font fnum, int*& sizep) { return Fl_Graphics_Driver::default_driver().get_font_sizes(fnum, sizep); } -/** Current value of the GUI scaling factor for screen number \p n */ +/** Current value of the GUI scaling factor for screen number \p n (n ∈ [0 , Fl::screen_count()-1]) */ float Fl::screen_scale(int n) { if (!Fl::screen_scaling_supported() || n < 0 || n >= Fl::screen_count()) return 1.; return Fl::screen_driver()->scale(n); } -/** Sets the value of the GUI scaling factor for screen number \p n. +/** Sets the value of the GUI scaling factor for screen number \p n (n ∈ [0 , Fl::screen_count()-1]). Also sets the scale factor value of all windows mapped to screen number \p n, if any. */ void Fl::screen_scale(int n, float factor) { diff --git a/src/screen_xywh.cxx b/src/screen_xywh.cxx index 2f652c2f4..59c12c969 100644 --- a/src/screen_xywh.cxx +++ b/src/screen_xywh.cxx @@ -56,7 +56,8 @@ int Fl::h() /** - Gets the number of available screens. + Gets the total count of available screens. + \note Screen numbers range from 0 to Fl::screen_count()-1 in the FLTK API. */ int Fl::screen_count() { @@ -131,6 +132,7 @@ void Fl::screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my, int mw, int Gets the screen number of a screen 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] */ int Fl::screen_num(int x, int y) { @@ -143,6 +145,7 @@ int Fl::screen_num(int x, int y) which intersects the most with the rectangle defined by \p x, \p y, \p w, \p h. \param[in] x, y, w, h the rectangle to search for intersection with + \return a screen number ∈ [0 , Fl::screen_count()-1] */ int Fl::screen_num(int x, int y, int w, int h) { |