summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2024-03-19 08:52:49 +0100
committerManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2024-03-19 08:52:49 +0100
commit3a8daf70c05692d73ded3a64d004a685c5ea2df6 (patch)
treebf65788fc0645cf8b28dfd08b8f7db03f612ba79 /src
parenta77f68693c2d2b14fe0d251844ae8f811ec790a3 (diff)
Document fl_close_display()
Diffstat (limited to 'src')
-rw-r--r--src/Fl.cxx7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/Fl.cxx b/src/Fl.cxx
index 0501483a6..16672cfcc 100644
--- a/src/Fl.cxx
+++ b/src/Fl.cxx
@@ -2198,12 +2198,19 @@ void Fl::disable_im()
Opens the display.
Automatically called by the library when the first window is show()'n.
Does nothing if the display is already open.
+ \note Requires ##include <FL/platform.H>
*/
void fl_open_display()
{
Fl::screen_driver()->open_display();
}
+/** Closes the connection to the windowing system when that's possible.
+You do \e not need to call this to exit, and in fact it is faster to not do so. It may be
+useful to call this if you want your program to continue without
+a GUI. You cannot open the display again, and cannot call any FLTK functions.
+ \note Requires ##include <FL/platform.H>
+*/
void fl_close_display()
{
Fl::screen_driver()->close_display();