FLTK 1.4.0
Fl_Glut_Window Class Reference

GLUT is emulated using this window class and these static variables (plus several more static variables hidden in glut_compatibility.cxx): More...

#include <glut.H>

Inheritance diagram for Fl_Glut_Window:
Fl_Gl_Window Fl_Window Fl_Group Fl_Widget

Public Member Functions

 Fl_Glut_Window (int w, int h, const char *t=0)
 Creates a glut window, registers to the glut windows list.
 
 Fl_Glut_Window (int x, int y, int w, int h, const char *t=0)
 Creates a glut window, registers to the glut windows list.
 
void make_current ()
 
 ~Fl_Glut_Window ()
 Destroys the glut window, first unregister it from the glut windows list.
 
- Public Member Functions inherited from Fl_Gl_Window
Fl_Gl_Window const * as_gl_window () const FL_OVERRIDE
 
Fl_Gl_Windowas_gl_window () FL_OVERRIDE
 Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window. More...
 
int can_do ()
 Returns non-zero if the hardware supports the current OpenGL mode.
 
int can_do_overlay ()
 Returns true if the hardware overlay is possible. More...
 
GLContext context () const
 Returns a pointer to the window's OpenGL rendering context. More...
 
void context (GLContext, int destroy_flag=0)
 Sets a pointer to the GLContext that this window is using. More...
 
char context_valid () const
 Will only be set if the OpenGL context is created or recreated. More...
 
void context_valid (char v)
 See char Fl_Gl_Window::context_valid() const.
 
 Fl_Gl_Window (int W, int H, const char *l=0)
 Creates a new Fl_Gl_Window widget using the given size, and label string. More...
 
 Fl_Gl_Window (int X, int Y, int W, int H, const char *l=0)
 Creates a new Fl_Gl_Window widget using the given position, size, and label string. More...
 
void flush () FL_OVERRIDE
 Forces the window to be drawn, this window is also made current and calls draw(). More...
 
int handle (int) FL_OVERRIDE
 Handle some FLTK events as needed. More...
 
void hide () FL_OVERRIDE
 Hides the window and destroys the OpenGL context. More...
 
void hide_overlay ()
 Hides the window if it is not this window, does nothing in Windows.
 
void invalidate ()
 The invalidate() method turns off valid() and is equivalent to calling value(0).
 
void make_current ()
 The make_current() method selects the OpenGL context for the widget. More...
 
void make_overlay_current ()
 Selects the OpenGL context for the widget's overlay. More...
 
Fl_Mode mode () const
 Returns the current OpenGL capabilities of the window. More...
 
int mode (const int *a)
 Set the OpenGL capabilities of the window using platform-specific data. More...
 
int mode (int a)
 Set or change the OpenGL capabilities of the window. More...
 
void ortho ()
 Sets the projection so 0,0 is in the lower left of the window and each pixel is 1 unit wide/tall. More...
 
int pixel_h ()
 Gives the window height in OpenGL pixels. More...
 
int pixel_w ()
 Gives the window width in OpenGL pixels. More...
 
float pixels_per_unit ()
 The number of pixels per FLTK unit of length for the window. More...
 
void redraw_overlay ()
 Causes draw_overlay() to be called at a later time. More...
 
void resize (int, int, int, int) FL_OVERRIDE
 Changes the size or position of the widget. More...
 
void show () FL_OVERRIDE
 Makes a widget visible. More...
 
void show (int a, char **b)
 Same as Fl_Window::show(int a, char **b)
 
void swap_buffers ()
 The swap_buffers() method swaps the back and front buffers. More...
 
int swap_interval () const
 Gets the rate at which the GL windows swaps buffers. More...
 
void swap_interval (int)
 Sets the rate at which the GL windows swaps buffers. More...
 
char valid () const
 Is turned off when FLTK creates a new context for this window or when the window resizes, and is turned on after draw() is called. More...
 
void valid (char v)
 See char Fl_Gl_Window::valid() const.
 
 ~Fl_Gl_Window ()
 The destructor removes the widget and destroys the OpenGL context associated with it.
 
- Public Member Functions inherited from Fl_Window
virtual class Fl_Double_Windowas_double_window ()
 Return non-null if this is an Fl_Double_Window object. More...
 
virtual class Fl_Overlay_Windowas_overlay_window ()
 Return non-null if this is an Fl_Overlay_Window object. More...
 
Fl_Window const * as_window () const FL_OVERRIDE
 
Fl_Windowas_window () FL_OVERRIDE
 Returns an Fl_Window pointer if this widget is an Fl_Window. More...
 
unsigned int border () const
 Returns whether the window possesses a border.
 
void border (int b)
 Sets whether or not the window manager border is around the window. More...
 
void clear_border ()
 Fast inline function to turn the window manager border off. More...
 
void clear_modal_states ()
 Clears the "modal" flags and converts a "modal" or "non-modal" window back into a "normal" window. More...
 
void copy_label (const char *a)
 Sets the window titlebar label to a copy of a character string.
 
void cursor (const Fl_RGB_Image *, int, int)
 Changes the cursor for this window using the provided image as cursor's shape. More...
 
void cursor (Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE)
 For back compatibility only. More...
 
void cursor (Fl_Cursor)
 Changes the cursor for this window. More...
 
int decorated_h () const
 Returns the window height including any window title bar and any frame added by the window manager. More...
 
int decorated_w () const
 Returns the window width including any frame added by the window manager. More...
 
void default_cursor (Fl_Cursor c, Fl_Color, Fl_Color=FL_WHITE)
 For back compatibility only. More...
 
void default_cursor (Fl_Cursor)
 Sets the default window cursor. More...
 
void draw_backdrop ()
 Draw the background image if one is set and is aligned inside.
 
 Fl_Window (int w, int h, const char *title=0)
 Creates a window from the given width w, height h, and title. More...
 
 Fl_Window (int x, int y, int w, int h, const char *title=0)
 Creates a window from the given position (x, y), size (w, h) and title. More...
 
void free_position ()
 Undoes the effect of a previous resize() or show() so that the next time show() is called the window manager is free to position the window. More...
 
void fullscreen ()
 Makes the window completely fill one or more screens, without any window manager border visible. More...
 
unsigned int fullscreen_active () const
 Returns non zero if FULLSCREEN flag is set, 0 otherwise.
 
void fullscreen_off ()
 Turns off any side effects of fullscreen()
 
void fullscreen_off (int X, int Y, int W, int H)
 Turns off any side effects of fullscreen() and does resize(x,y,w,h).
 
void fullscreen_screens (int top, int bottom, int left, int right)
 Sets which screens should be used when this window is in fullscreen mode. More...
 
int handle (int) FL_OVERRIDE
 Handles the specified event. More...
 
void hide () FL_OVERRIDE
 Removes the window from the screen. More...
 
void hotspot (const Fl_Widget &p, int offscreen=0)
 See void Fl_Window::hotspot(int x, int y, int offscreen = 0)
 
void hotspot (const Fl_Widget *, int offscreen=0)
 See void Fl_Window::hotspot(int x, int y, int offscreen = 0)
 
void hotspot (int x, int y, int offscreen=0)
 Positions the window so that the mouse is pointing at the given position, or at the center of the given widget, which may be the window itself. More...
 
const void * icon () const
 Gets the current icon window target dependent data. More...
 
void icon (const Fl_RGB_Image *)
 Sets or resets a single window icon. More...
 
void icon (const void *ic)
 Platform-specific method to set the window icon usable on Windows and X11 only. More...
 
void iconize ()
 Iconifies the window. More...
 
const char * iconlabel () const
 See void Fl_Window::iconlabel(const char*)

 
void iconlabel (const char *)
 Sets the icon label.
 
void icons (const Fl_RGB_Image *[], int)
 Sets the window icons. More...
 
void icons (HICON big_icon, HICON small_icon)
 Sets the window icons using HICON handles (Windows platform only). More...
 
const char * label () const
 See void Fl_Window::label(const char*)

 
void label (const char *)
 Sets the window title bar label.
 
void label (const char *label, const char *iconlabel)
 Sets the icon label.
 
void make_current ()
 Sets things up so that the drawing functions in <FL/fl_draw.H> will go into this window. More...
 
void maximize ()
 Maximizes a top-level window to its current screen. More...
 
unsigned int maximize_active () const
 Returns whether the window is currently maximized.
 
unsigned int menu_window () const
 Returns true if this window is a menu window.
 
unsigned int modal () const
 Returns true if this window is modal. More...
 
unsigned int non_modal () const
 Returns true if this window is modal or non-modal.
 
fl_uintptr_t os_id ()
 Returns a platform-specific identification of a shown window, or 0 if not shown. More...
 
unsigned int override () const
 Returns non zero if OVERRIDE flag is set, 0 otherwise.
 
void resize (int X, int Y, int W, int H) FL_OVERRIDE
 Changes the size and position of the window. More...
 
int screen_num ()
 The number of the screen containing the mapped window.
 
void screen_num (int screen_num)
 Set the number of the screen where to map the window. More...
 
void set_menu_window ()
 Marks the window as a menu window. More...
 
void set_modal ()
 A "modal" window, when shown(), will prevent any events from being delivered to other windows in the same program, and will also remain on top of the other windows (if the X window manager supports the "transient for" property). More...
 
void set_non_modal ()
 A "non-modal" window (terminology borrowed from Microsoft Windows) acts like a modal() one in that it remains on top, but it has no effect on event delivery. More...
 
void set_override ()
 Activates the flags NOBORDER|OVERRIDE.
 
void set_tooltip_window ()
 Marks the window as a tooltip window. More...
 
const Fl_Imageshape ()
 Returns the image controlling the window shape or NULL.
 
void shape (const Fl_Image &b)
 Set the window's shape with an Fl_Image. More...
 
void shape (const Fl_Image *img)
 Assigns a non-rectangular shape to the window. More...
 
void show () FL_OVERRIDE
 Puts the window on the screen. More...
 
void show (int argc, char **argv)
 Puts the window on the screen with show() and parses command-line arguments. More...
 
int shown ()
 Returns non-zero if show() has been called (but not hide() ). More...
 
void size_range (int minw, int minh, int maxw=0, int maxh=0, int dw=0, int dh=0, int aspect=0)
 Sets the allowable range the user can resize this window to. More...
 
unsigned int tooltip_window () const
 Returns true if this window is a tooltip window.
 
void un_maximize ()
 Returns a previously maximized top-level window to its previous size. More...
 
void wait_for_expose ()
 Waits for the window to be displayed after calling show(). More...
 
int x_root () const
 Gets the x position of the window on the screen.
 
const char * xclass () const
 Returns the xclass for this window, or a default. More...
 
void xclass (const char *c)
 Sets the xclass for this window. More...
 
int y_root () const
 Gets the y position of the window on the screen.
 
virtual ~Fl_Window ()
 The destructor also deletes all the children. More...
 
- Public Member Functions inherited from Fl_Group
Fl_Widget *& _ddfdesign_kludge ()
 This is for forms compatibility only.
 
void add (Fl_Widget &)
 The widget is removed from its current group (if any) and then added to the end of this group.
 
void add (Fl_Widget *o)
 See void Fl_Group::add(Fl_Widget &w)
 
void add_resizable (Fl_Widget &o)
 Adds a widget to the group and makes it the resizable widget.
 
Fl_Widget *const * array () const
 Returns a pointer to the array of children. More...
 
Fl_Group const * as_group () const FL_OVERRIDE
 
Fl_Groupas_group () FL_OVERRIDE
 Returns an Fl_Group pointer if this widget is an Fl_Group. More...
 
void begin ()
 Sets the current group so you can build the widget tree by just constructing the widgets. More...
 
Fl_Widgetchild (int n) const
 Returns array()[n]. More...
 
int children () const
 Returns how many child widgets the group has.
 
void clear ()
 Deletes all child widgets from memory recursively. More...
 
unsigned int clip_children ()
 Returns the current clipping mode. More...
 
void clip_children (int c)
 Controls whether the group widget clips the drawing of child widgets to its bounding box. More...
 
virtual int delete_child (int n)
 Removes the widget at index from the group and deletes it. More...
 
void end ()
 Exactly the same as current(this->parent()). More...
 
int find (const Fl_Widget &o) const
 See int Fl_Group::find(const Fl_Widget *w) const.
 
int find (const Fl_Widget *) const
 Searches the child array for the widget and returns the index. More...
 
 Fl_Group (int, int, int, int, const char *=0)
 Creates a new Fl_Group widget using the given position, size, and label string. More...
 
void focus (Fl_Widget *W)
 
void forms_end ()
 This is for forms compatibility only.
 
int handle (int) FL_OVERRIDE
 Handles the specified event. More...
 
void init_sizes ()
 Resets the internal array of widget sizes and positions. More...
 
void insert (Fl_Widget &, int i)
 The widget is removed from its current group (if any) and then inserted into this group. More...
 
void insert (Fl_Widget &o, Fl_Widget *before)
 This does insert(w, find(before)). More...
 
void remove (Fl_Widget &)
 Removes a widget from the group but does not delete it. More...
 
void remove (Fl_Widget *o)
 Removes the widget o from the group. More...
 
void remove (int index)
 Removes the widget at index from the group but does not delete it. More...
 
Fl_Widgetresizable () const
 Returns the group's resizable widget. More...
 
void resizable (Fl_Widget &o)
 Sets the group's resizable widget. More...
 
void resizable (Fl_Widget *o)
 The resizable widget defines both the resizing box and the resizing behavior of the group and its children. More...
 
void resize (int, int, int, int) FL_OVERRIDE
 Resizes the Fl_Group widget and all of its children. More...
 
virtual ~Fl_Group ()
 The destructor also deletes all the children. More...
 
- Public Member Functions inherited from Fl_Widget
void _clear_fullscreen ()
 
void _set_fullscreen ()
 
void activate ()
 Activates the widget. More...
 
unsigned int active () const
 Returns whether the widget is active. More...
 
int active_r () const
 Returns whether the widget and all of its parents are active. More...
 
Fl_Align align () const
 Gets the label alignment. More...
 
void align (Fl_Align alignment)
 Sets the label alignment. More...
 
long argument () const
 Gets the current user data (long) argument that is passed to the callback function. More...
 
void argument (long v)
 Sets the current user data (long) argument that is passed to the callback function. More...
 
virtual class Fl_Gl_Windowas_gl_window ()
 Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window. More...
 
virtual class Fl_Gl_Window const * as_gl_window () const
 
virtual Fl_Groupas_group ()
 Returns an Fl_Group pointer if this widget is an Fl_Group. More...
 
virtual Fl_Group const * as_group () const
 
virtual Fl_Windowas_window ()
 Returns an Fl_Window pointer if this widget is an Fl_Window. More...
 
virtual Fl_Window const * as_window () const
 
void bind_deimage (Fl_Image *img)
 Sets the image to use as part of the widget label when in the inactive state. More...
 
void bind_deimage (int f)
 Bind the inactive image to the widget, so the widget will delete the image when it is no longer needed. More...
 
void bind_image (Fl_Image *img)
 Sets the image to use as part of the widget label when in the active state. More...
 
void bind_image (int f)
 Bind the image to the widget, so the widget will delete the image when it is no longer needed. More...
 
Fl_Boxtype box () const
 Gets the box type of the widget. More...
 
void box (Fl_Boxtype new_box)
 Sets the box type for the widget. More...
 
Fl_Callback_p callback () const
 Gets the current callback function for the widget. More...
 
void callback (Fl_Callback *cb)
 Sets the current callback function for the widget. More...
 
void callback (Fl_Callback *cb, Fl_Callback_User_Data *p, bool auto_free)
 Sets the current callback function and managed user data for the widget. More...
 
void callback (Fl_Callback *cb, void *p)
 Sets the current callback function and data for the widget. More...
 
void callback (Fl_Callback0 *cb)
 Sets the current callback function for the widget. More...
 
void callback (Fl_Callback1 *cb, long p=0)
 Sets the current callback function for the widget. More...
 
unsigned int changed () const
 Checks if the widget value changed since the last callback. More...
 
void clear_active ()
 Marks the widget as inactive without sending events or changing focus. More...
 
void clear_changed ()
 Marks the value of the widget as unchanged. More...
 
void clear_damage (uchar c=0)
 Clears or sets the damage flags. More...
 
void clear_output ()
 Sets a widget to accept input. More...
 
void clear_visible ()
 Hides the widget. More...
 
void clear_visible_focus ()
 Disables keyboard focus navigation with this widget. More...
 
Fl_Color color () const
 Gets the background color of the widget. More...
 
void color (Fl_Color bg)
 Sets the background color of the widget. More...
 
void color (Fl_Color bg, Fl_Color sel)
 Sets the background and selection color of the widget. More...
 
Fl_Color color2 () const
 For back compatibility only. More...
 
void color2 (unsigned a)
 For back compatibility only. More...
 
int contains (const Fl_Widget *w) const
 Checks if w is a child of this widget. More...
 
void copy_label (const char *new_label)
 Sets the current label. More...
 
void copy_tooltip (const char *text)
 Sets the current tooltip text. More...
 
uchar damage () const
 Returns non-zero if draw() needs to be called. More...
 
void damage (uchar c)
 Sets the damage bits for the widget. More...
 
void damage (uchar c, int x, int y, int w, int h)
 Sets the damage bits for an area inside the widget. More...
 
int damage_resize (int, int, int, int)
 Internal use only.
 
void deactivate ()
 Deactivates the widget. More...
 
Fl_Imagedeimage ()
 Gets the image that is used as part of the widget label when in the inactive state. More...
 
const Fl_Imagedeimage () const
 Gets the image that is used as part of the widget label when in the inactive state. More...
 
void deimage (Fl_Image &img)
 Sets the image to use as part of the widget label when in the inactive state. More...
 
void deimage (Fl_Image *img)
 Sets the image to use as part of the widget label when in the inactive state. More...
 
int deimage_bound () const
 Returns whether the inactive image is managed by the widget. More...
 
void do_callback (Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
 Calls the widget callback function with default arguments. More...
 
void do_callback (Fl_Widget *widget, long arg, Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
 Calls the widget callback function with arbitrary arguments. More...
 
void do_callback (Fl_Widget *widget, void *arg=0, Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
 Calls the widget callback function with arbitrary arguments. More...
 
virtual void draw ()=0
 Draws the widget. More...
 
void draw_label (int, int, int, int, Fl_Align) const
 Draws the label in an arbitrary bounding box with an arbitrary alignment. More...
 
int h () const
 Gets the widget height. More...
 
virtual int handle (int event)
 Handles the specified event. More...
 
virtual void hide ()
 Makes a widget invisible. More...
 
Fl_Imageimage ()
 Gets the image that is used as part of the widget label when in the active state. More...
 
const Fl_Imageimage () const
 Gets the image that is used as part of the widget label when in the active state. More...
 
void image (Fl_Image &img)
 Sets the image to use as part of the widget label when in the active state. More...
 
void image (Fl_Image *img)
 Sets the image to use as part of the widget label when in the active state. More...
 
int image_bound () const
 Returns whether the image is managed by the widget. More...
 
int inside (const Fl_Widget *wgt) const
 Checks if this widget is a child of wgt. More...
 
int is_label_copied () const
 Returns whether the current label was assigned with copy_label(). More...
 
const char * label () const
 Gets the current label text. More...
 
void label (const char *text)
 Sets the current label pointer. More...
 
void label (Fl_Labeltype a, const char *b)
 Shortcut to set the label text and type in one call. More...
 
Fl_Color labelcolor () const
 Gets the label color. More...
 
void labelcolor (Fl_Color c)
 Sets the label color. More...
 
Fl_Font labelfont () const
 Gets the font to use. More...
 
void labelfont (Fl_Font f)
 Sets the font to use. More...
 
Fl_Fontsize labelsize () const
 Gets the font size in pixels. More...
 
void labelsize (Fl_Fontsize pix)
 Sets the font size in pixels. More...
 
Fl_Labeltype labeltype () const
 Gets the label type. More...
 
void labeltype (Fl_Labeltype a)
 Sets the label type. More...
 
void measure_label (int &ww, int &hh) const
 Sets width ww and height hh accordingly with the label size. More...
 
bool needs_keyboard () const
 Returns whether this widget needs a keyboard. More...
 
void needs_keyboard (bool needs)
 Sets whether this widget needs a keyboard. More...
 
unsigned int output () const
 Returns if a widget is used for output only. More...
 
Fl_Groupparent () const
 Returns a pointer to the parent widget. More...
 
void parent (Fl_Group *p)
 Internal use only - "for hacks only". More...
 
void position (int X, int Y)
 Repositions the window or widget. More...
 
void redraw ()
 Schedules the drawing of the widget. More...
 
void redraw_label ()
 Schedules the drawing of the label. More...
 
virtual void resize (int x, int y, int w, int h)
 Changes the size or position of the widget. More...
 
Fl_Color selection_color () const
 Gets the selection color. More...
 
void selection_color (Fl_Color a)
 Sets the selection color. More...
 
void set_active ()
 Marks the widget as active without sending events or changing focus. More...
 
void set_changed ()
 Marks the value of the widget as changed. More...
 
void set_output ()
 Sets a widget to output only. More...
 
void set_visible ()
 Makes the widget visible. More...
 
void set_visible_focus ()
 Enables keyboard focus navigation with this widget. More...
 
int shortcut_label () const
 Returns whether the widget's label uses '&' to indicate shortcuts. More...
 
void shortcut_label (int value)
 Sets whether the widget's label uses '&' to indicate shortcuts. More...
 
virtual void show ()
 Makes a widget visible. More...
 
void size (int W, int H)
 Changes the size of the widget. More...
 
int take_focus ()
 Gives the widget the keyboard focus. More...
 
unsigned int takesevents () const
 Returns if the widget is able to take events. More...
 
int test_shortcut ()
 Returns true if the widget's label contains the entered '&x' shortcut. More...
 
const char * tooltip () const
 Gets the current tooltip text. More...
 
void tooltip (const char *text)
 Sets the current tooltip text. More...
 
Fl_Windowtop_window () const
 Returns a pointer to the top-level window for the widget. More...
 
Fl_Windowtop_window_offset (int &xoff, int &yoff) const
 Finds the x/y offset of the current widget relative to the top-level window. More...
 
uchar type () const
 Gets the widget type. More...
 
void type (uchar t)
 Sets the widget type. More...
 
int use_accents_menu ()
 Returns non zero if MAC_USE_ACCENTS_MENU flag is set, 0 otherwise.
 
void * user_data () const
 Gets the user data for this widget. More...
 
void user_data (Fl_Callback_User_Data *v, bool auto_free)
 Sets the user data for this widget.
 
void user_data (void *v)
 Sets the user data for this widget.
 
unsigned int visible () const
 Returns whether a widget is visible. More...
 
unsigned int visible_focus () const
 Checks whether this widget has a visible focus. More...
 
void visible_focus (int v)
 Modifies keyboard focus navigation. More...
 
int visible_r () const
 Returns whether a widget and all its parents are visible. More...
 
int w () const
 Gets the widget width. More...
 
Fl_When when () const
 Returns the conditions under which the callback is called. More...
 
void when (uchar i)
 Sets the flags used to decide when a callback is called. More...
 
Fl_Windowwindow () const
 Returns a pointer to the nearest parent window up the widget hierarchy. More...
 
int x () const
 Gets the widget position in its window. More...
 
int y () const
 Gets the widget position in its window. More...
 
virtual ~Fl_Widget ()
 Destroys the widget. More...
 

Public Attributes

void(* display )()
 
void(* entry )(int)
 
void(* keyboard )(uchar, int x, int y)
 
int menu [3]
 
void(* motion )(int x, int y)
 
void(* mouse )(int b, int state, int x, int y)
 
int number
 
void(* overlaydisplay )()
 
void(* passivemotion )(int x, int y)
 
void(* reshape )(int w, int h)
 
void(* special )(int, int x, int y)
 
void(* visibility )(int)
 

Protected Member Functions

void draw () FL_OVERRIDE
 Draws the Fl_Gl_Window. More...
 
void draw_overlay () FL_OVERRIDE
 You must implement this virtual function if you want to draw into the overlay. More...
 
int handle (int) FL_OVERRIDE
 Handle some FLTK events as needed. More...
 
- Protected Member Functions inherited from Fl_Gl_Window
void draw () FL_OVERRIDE
 Draws the Fl_Gl_Window. More...
 
void draw_begin ()
 Supports drawing to an Fl_Gl_Window with the FLTK 2D drawing API. More...
 
void draw_end ()
 To be used as a match for a previous call to Fl_Gl_Window::draw_begin(). More...
 
- Protected Member Functions inherited from Fl_Window
void default_size_range ()
 Protected method to calculate the default size range of a window. More...
 
void draw () FL_OVERRIDE
 Draws the widget. More...
 
virtual void flush ()
 Forces the window to be drawn, this window is also made current and calls draw(). More...
 
int force_position () const
 Returns the internal state of the window's FORCE_POSITION flag. More...
 
void force_position (int force)
 Sets an internal flag that tells FLTK and the window manager to honor position requests. More...
 
void free_icons ()
 Deletes all icons previously attached to the window. More...
 
int is_resizable ()
 Protected method to determine whether a window is resizable. More...
 
- Protected Member Functions inherited from Fl_Group
Fl_Rectbounds ()
 Returns the internal array of widget sizes and positions. More...
 
void draw () FL_OVERRIDE
 Draws the widget. More...
 
void draw_child (Fl_Widget &widget) const
 Forces a child to redraw. More...
 
void draw_children ()
 Draws all children of the group. More...
 
void draw_outside_label (const Fl_Widget &widget) const
 Parents normally call this to draw outside labels of child widgets.
 
virtual int on_insert (Fl_Widget *, int)
 Allow derived groups to act when a widget is added as a child. More...
 
virtual int on_move (int, int)
 Allow derived groups to act when a widget is moved within the group. More...
 
virtual void on_remove (int)
 Allow derived groups to act when a child widget is removed from the group. More...
 
int * sizes ()
 Returns the internal array of widget sizes and positions. More...
 
void update_child (Fl_Widget &widget) const
 Draws a child only if it needs it. More...
 
- Protected Member Functions inherited from Fl_Widget
void clear_flag (unsigned int c)
 Clears a flag in the flags mask.
 
void draw_backdrop () const
 If FL_ALIGN_IMAGE_BACKDROP is set, the image or deimage will be drawn.
 
void draw_box () const
 Draws the widget box according its box style.
 
void draw_box (Fl_Boxtype t, Fl_Color c) const
 Draws a box of type t, of color c at the widget's position and size.
 
void draw_box (Fl_Boxtype t, int x, int y, int w, int h, Fl_Color c) const
 Draws a box of type t, of color c at the position X,Y and size W,H.
 
void draw_focus () const
 Draws a focus rectangle around the widget. More...
 
void draw_focus (Fl_Boxtype t, int X, int Y, int W, int H) const
 Draws a focus rectangle around the widget. More...
 
void draw_focus (Fl_Boxtype t, int x, int y, int w, int h, Fl_Color bg) const
 Draws a focus box for the widget at the given position and size. More...
 
void draw_label () const
 Draws the widget's label at the defined label position. More...
 
void draw_label (int, int, int, int) const
 Draws the label in an arbitrary bounding box. More...
 
 Fl_Widget (int x, int y, int w, int h, const char *label=0L)
 Creates a widget at the given position and size. More...
 
unsigned int flags () const
 Gets the widget flags mask.
 
void h (int v)
 Internal use only. More...
 
void set_flag (unsigned int c)
 Sets a flag in the flags mask.
 
void w (int v)
 Internal use only. More...
 
void x (int v)
 Internal use only. More...
 
void y (int v)
 Internal use only. More...
 

Additional Inherited Members

- Public Types inherited from Fl_Window
typedef struct HICON__ * HICON
 
- Static Public Member Functions inherited from Fl_Gl_Window
static int can_do (const int *m)
 Returns non-zero if the hardware supports the given OpenGL mode. More...
 
static int can_do (int m)
 Returns non-zero if the hardware supports the given OpenGL mode.
 
- Static Public Member Functions inherited from Fl_Window
static Fl_Windowcurrent ()
 Returns the last window that was made current. More...
 
static void default_callback (Fl_Window *, void *v)
 Back compatibility: Sets the default callback v for win to call on close event.
 
static void default_icon (const Fl_RGB_Image *)
 Sets a single default window icon. More...
 
static void default_icons (const Fl_RGB_Image *[], int)
 Sets the default window icons. More...
 
static void default_icons (HICON big_icon, HICON small_icon)
 Sets the default window icons (Windows platform only). More...
 
static const char * default_xclass ()
 Returns the default xclass. More...
 
static void default_xclass (const char *)
 Sets the default window xclass. More...
 
static bool is_a_rescale ()
 Returns true when a window is being rescaled.
 
static char show_next_window_iconic ()
 Returns the static flag whether the next window should be opened iconified. More...
 
static void show_next_window_iconic (char stat)
 Sets a static flag whether the next window should be opened iconified. More...
 
- Static Public Member Functions inherited from Fl_Group
static Fl_Groupcurrent ()
 Returns the currently active group. More...
 
static void current (Fl_Group *g)
 Sets the current group. More...
 
- Static Public Member Functions inherited from Fl_Widget
static void default_callback (Fl_Widget *widget, void *data)
 The default callback for all widgets that don't set a callback. More...
 
static unsigned int label_shortcut (const char *t)
 Returns the Unicode value of the '&x' shortcut in a given text. More...
 
static int test_shortcut (const char *, const bool require_alt=false)
 Returns true if the given text t contains the entered '&x' shortcut. More...
 
- Protected Types inherited from Fl_Widget
enum  {
  INACTIVE = 1<<0 , INVISIBLE = 1<<1 , OUTPUT = 1<<2 , NOBORDER = 1<<3 ,
  FORCE_POSITION = 1<<4 , NON_MODAL = 1<<5 , SHORTCUT_LABEL = 1<<6 , CHANGED = 1<<7 ,
  OVERRIDE = 1<<8 , VISIBLE_FOCUS = 1<<9 , COPIED_LABEL = 1<<10 , CLIP_CHILDREN = 1<<11 ,
  MENU_WINDOW = 1<<12 , TOOLTIP_WINDOW = 1<<13 , MODAL = 1<<14 , NO_OVERLAY = 1<<15 ,
  GROUP_RELATIVE = 1<<16 , COPIED_TOOLTIP = 1<<17 , FULLSCREEN = 1<<18 , MAC_USE_ACCENTS_MENU = 1<<19 ,
  NEEDS_KEYBOARD = 1<<20 , IMAGE_BOUND = 1<<21 , DEIMAGE_BOUND = 1<<22 , AUTO_DELETE_USER_DATA = 1<<23 ,
  MAXIMIZED = 1<<24 , POPUP = 1<<25 , USERFLAG3 = 1<<29 , USERFLAG2 = 1<<30 ,
  USERFLAG1 = 1<<31
}
 flags possible values enumeration. More...
 
- Static Protected Attributes inherited from Fl_Window
static Fl_Windowcurrent_
 Stores the last window that was made current. More...
 

Detailed Description

GLUT is emulated using this window class and these static variables (plus several more static variables hidden in glut_compatibility.cxx):

Member Function Documentation

◆ draw()

void Fl_Glut_Window::draw ( void  )
protectedvirtual

Draws the Fl_Gl_Window.

You must subclass Fl_Gl_Window and provide an implementation for draw(). You may also provide an implementation of draw_overlay() if you want to draw into the overlay planes. You can avoid reinitializing the viewport and lights and other things by checking valid() at the start of draw() and only doing the initialization if it is false.

The draw() method can only use OpenGL calls. Do not attempt to call X, any of the functions in <FL/fl_draw.H>, or glX directly. Do not call gl_start() or gl_finish().

If double-buffering is enabled in the window, the back and front buffers are swapped after this function is completed.

The following pseudo-code shows how to use "if (!valid())" to initialize the viewport:

void mywindow::draw() {
if (!valid()) {
glViewport(0,0,pixel_w(),pixel_h());
glFrustum(...) or glOrtho(...)
...other initialization...
}
if (!context_valid()) {
...load textures, etc. ...
}
// clear screen
glClearColor(...);
glClear(...);
... draw your geometry here ...
}
char context_valid() const
Will only be set if the OpenGL context is created or recreated.
Definition: Fl_Gl_Window.H:125
int pixel_h()
Gives the window height in OpenGL pixels.
Definition: Fl_Gl_Window.H:235
int pixel_w()
Gives the window width in OpenGL pixels.
Definition: Fl_Gl_Window.H:225
char valid() const
Is turned off when FLTK creates a new context for this window or when the window resizes,...
Definition: Fl_Gl_Window.H:112
void draw() FL_OVERRIDE
Draws the Fl_Gl_Window.
Definition: glut_compatibility.cxx:53

Actual example code to clear screen to black and draw a 2D white "X":

void mywindow::draw() {
if (!valid()) {
glLoadIdentity();
glViewport(0,0,pixel_w(),pixel_h());
glOrtho(-w(),w(),-h(),h(),-1,1);
}
// Clear screen
glClear(GL_COLOR_BUFFER_BIT);
// Draw white 'X'
glColor3f(1.0, 1.0, 1.0);
glBegin(GL_LINE_STRIP); glVertex2f(w(), h()); glVertex2f(-w(),-h()); glEnd();
glBegin(GL_LINE_STRIP); glVertex2f(w(),-h()); glVertex2f(-w(), h()); glEnd();
}
int h() const
Gets the widget height.
Definition: Fl_Widget.H:368
int w() const
Gets the widget width.
Definition: Fl_Widget.H:363

Regular FLTK widgets can be added as children to the Fl_Gl_Window. To correctly overlay the widgets, Fl_Gl_Window::draw() must be called after rendering the main scene.

void mywindow::draw() {
// draw 3d graphics scene
// -- or --
// other 2d drawing calls, overlays, etc.
}
void draw_end()
To be used as a match for a previous call to Fl_Gl_Window::draw_begin().
Definition: Fl_Gl_Window.cxx:421
void draw_begin()
Supports drawing to an Fl_Gl_Window with the FLTK 2D drawing API.
Definition: Fl_Gl_Window.cxx:382
void draw() FL_OVERRIDE
Draws the Fl_Gl_Window.
Definition: Fl_Gl_Window.cxx:502
void draw() FL_OVERRIDE
Draws the widget.
Definition: Fl_Window.cxx:491

Reimplemented from Fl_Gl_Window.

◆ draw_overlay()

void Fl_Glut_Window::draw_overlay ( )
protectedvirtual

You must implement this virtual function if you want to draw into the overlay.

The overlay is cleared before this is called. You should draw anything that is not clear using OpenGL. You must use gl_color(i) to choose colors (it allocates them from the colormap using system-specific calls), and remember that you are in an indexed OpenGL mode and drawing anything other than flat-shaded will probably not work.

Both this function and Fl_Gl_Window::draw() should check Fl_Gl_Window::valid() and set the same transformation. If you don't your code may not work on other systems. Depending on the OS, and on whether overlays are real or simulated, the OpenGL context may be the same or different between the overlay and main window.

Reimplemented from Fl_Gl_Window.

◆ handle()

int Fl_Glut_Window::handle ( int  event)
protectedvirtual

Handle some FLTK events as needed.

Reimplemented from Fl_Gl_Window.


The documentation for this class was generated from the following files: