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/screen_xywh.cxx | |
| parent | c827292ec9c9170a7a87d0a3f3eda3db171ae031 (diff) | |
Doc: repeat that screens are numbered starting from 0 in the API
Diffstat (limited to 'src/screen_xywh.cxx')
| -rw-r--r-- | src/screen_xywh.cxx | 5 |
1 files changed, 4 insertions, 1 deletions
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) { |