gtkmm 4.14.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::GLArea Class Reference

A widget used for drawing with OpenGL. More...

#include <gtkmm/glarea.h>

Inheritance diagram for Gtk::GLArea:
Inheritance graph
[legend]

Public Member Functions

 GLArea (GLArea && src) noexcept
 
GLAreaoperator= (GLArea && src) noexcept
 
 GLArea (const GLArea &)=delete
 
GLAreaoperator= (const GLArea &)=delete
 
 ~GLArea () noexcept override
 
GtkGLArea * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkGLArea * gobj () const
 Provides access to the underlying C GObject. More...
 
 GLArea ()
 
Glib::RefPtr< Gdk::GLContextget_context ()
 Retrieves the Gdk::GLContext used by area. More...
 
Glib::RefPtr< const Gdk::GLContextget_context () const
 Retrieves the Gdk::GLContext used by area. More...
 
void make_current ()
 Ensures that the Gdk::GLContext used by area is associated with the Gtk::GLArea. More...
 
void queue_render ()
 Marks the currently rendered data (if any) as invalid, and queues a redraw of the widget. More...
 
void attach_buffers ()
 Binds buffers to the framebuffer. More...
 
bool has_error () const
 Check if any error is currently set on this area. More...
 
void throw_if_error () const
 Will throw the correct Glib::Error subclass if any is currently set on this area. More...
 
void set_error (const Glib::Error & error)
 Sets an error on the area which will be shown instead of GL rendering. More...
 
void unset_error ()
 Clears any previous set error on this area made with set_error(). More...
 
bool get_has_depth_buffer () const
 Returns whether the area has a depth buffer. More...
 
void set_has_depth_buffer (bool has_depth_buffer=true)
 Sets whether the Gtk::GLArea should use a depth buffer. More...
 
bool get_has_stencil_buffer () const
 Returns whether the area has a stencil buffer. More...
 
void set_has_stencil_buffer (bool has_stencil_buffer=true)
 Sets whether the Gtk::GLArea should use a stencil buffer. More...
 
bool get_auto_render () const
 Returns whether the area is in auto render mode or not. More...
 
void set_auto_render (bool auto_render=true)
 Sets whether the Gtk::GLArea is in auto render mode. More...
 
void get_required_version (int & major, int & minor) const
 Retrieves the required version of OpenGL. More...
 
void set_required_version (int major, int minor)
 Sets the required version of OpenGL to be used when creating the context for the widget. More...
 
void set_allowed_apis (Gdk::GLApi apis)
 Sets the allowed APIs to create a context with. More...
 
Gdk::GLApi get_allowed_apis () const
 Gets the allowed APIs. More...
 
Gdk::GLApi get_api () const
 Gets the API that is currently in use. More...
 
bool get_use_es () const
 Returns whether the Gtk::GLArea should use OpenGL ES. More...
 
void set_use_es (bool use_es=true)
 Sets whether the area should create an OpenGL or an OpenGL ES context. More...
 
Glib::PropertyProxy< bool > property_auto_render ()
 If set to true the signal_render() signal will be emitted every time the widget draws. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_auto_render () const
 If set to true the signal_render() signal will be emitted every time the widget draws. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::GLContext > > property_context () const
 The Gdk::GLContext used by the Gtk::GLArea widget. More...
 
Glib::PropertyProxy< bool > property_has_depth_buffer ()
 If set to true the widget will allocate and enable a depth buffer for the target framebuffer. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_depth_buffer () const
 If set to true the widget will allocate and enable a depth buffer for the target framebuffer. More...
 
Glib::PropertyProxy< bool > property_has_stencil_buffer ()
 If set to true the widget will allocate and enable a stencil buffer for the target framebuffer. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_stencil_buffer () const
 If set to true the widget will allocate and enable a stencil buffer for the target framebuffer. More...
 
Glib::PropertyProxy< bool > property_use_es ()
 If set to true the widget will try to create a Gdk::GLContext using OpenGL ES instead of OpenGL. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_use_es () const
 If set to true the widget will try to create a Gdk::GLContext using OpenGL ES instead of OpenGL. More...
 
Glib::PropertyProxy< Gdk::GLApiproperty_allowed_apis ()
 The allowed APIs. More...
 
Glib::PropertyProxy_ReadOnly< Gdk::GLApiproperty_allowed_apis () const
 The allowed APIs. More...
 
Glib::PropertyProxy_ReadOnly< Gdk::GLApiproperty_api () const
 The API currently in use. More...
 
Glib::SignalProxy< Glib::RefPtr< Gdk::GLContext >()> signal_create_context ()
 
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::GLContext > &)> signal_render ()
 
Glib::SignalProxy< void(int, int)> signal_resize ()
 
- Public Member Functions inherited from Gtk::Widget
 Widget (Widget && src) noexcept
 
Widgetoperator= (Widget && src) noexcept
 
 Widget (const Widget &)=delete
 
Widgetoperator= (const Widget &)=delete
 
 ~Widget () noexcept override
 Destroys the widget. More...
 
GtkWidget * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkWidget * gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::RefPtr< ConstraintTargetmake_refptr_constrainttarget ()
 Converts this widget to a reference counted Gtk::ConstraintTarget. More...
 
Glib::RefPtr< const ConstraintTargetmake_refptr_constrainttarget () const
 Converts this widget to a reference counted Gtk::ConstraintTarget. More...
 
void show ()
 Flags a widget to be displayed. More...
 
void hide ()
 Reverses the effects of show(). More...
 
void queue_draw ()
 Schedules this widget to be redrawn in the paint phase of the current or the next frame. More...
 
void queue_resize ()
 Flags a widget to have its size renegotiated. More...
 
void queue_allocate ()
 Flags the widget for a rerun of the size_allocate_vfunc() function. More...
 
void size_allocate (const Allocation & allocation, int baseline)
 Allocates widget with a transformation that translates the origin to the position in allocation. More...
 
SizeRequestMode get_request_mode () const
 Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More...
 
void measure (Orientation orientation, int for_size, int & minimum, int & natural, int & minimum_baseline, int & natural_baseline) const
 Measures widget in the orientation orientation and for the given for_size. More...
 
Measurements measure (Orientation orientation, int for_size=-1) const
 Like the other overload of measure() but returns a structure holding the sizes/baselines instead of using output parameters. More...
 
void get_preferred_size (Requisition & minimum_size, Requisition & natural_size) const
 Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. More...
 
PreferredSize get_preferred_size () const
 Like the other overload of get_preferred_size() but returns a structure holding the sizes instead of using output parameters. More...
 
void set_layout_manager (const Glib::RefPtr< LayoutManager > & layout_manager)
 Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget. More...
 
void unset_layout_manager ()
 Undoes the effect of a previous call to set_layout_manager(). More...
 
Glib::RefPtr< LayoutManagerget_layout_manager ()
 Retrieves the layout manager used by widget. More...
 
Glib::RefPtr< const LayoutManagerget_layout_manager () const
 Retrieves the layout manager used by widget. More...
 
bool mnemonic_activate (bool group_cycling)
 Emits the signal_mnemonic_activate() signal. More...
 
bool activate ()
 For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More...
 
void set_can_focus (bool can_focus=true)
 Specifies whether the input focus can enter the widget or any of its children. More...
 
bool get_can_focus () const
 Determines whether the input focus can enter widget or any of its children. More...
 
void set_focusable (bool focusable=true)
 Specifies whether widget can own the input focus. More...
 
bool get_focusable () const
 Determines whether widget can own the input focus. More...
 
bool has_focus () const
 Determines if the widget has the global input focus. More...
 
bool is_focus () const
 Determines if the widget is the focus widget within its toplevel. More...
 
bool has_visible_focus () const
 Determines if the widget should show a visible indication that it has the global input focus. More...
 
bool grab_focus ()
 Causes widget to have the keyboard focus for the Gtk::Window it's inside. More...
 
void set_focus_on_click (bool focus_on_click=true)
 Sets whether the widget should grab focus when it is clicked with the mouse. More...
 
bool get_focus_on_click () const
 Returns whether the widget should grab focus when it is clicked with the mouse. More...
 
void set_can_target (bool can_target=true)
 Sets whether widget can be the target of pointer events. More...
 
bool get_can_target () const
 Queries whether widget can be the target of pointer events. More...
 
bool has_default () const
 Determines whether widget is the current default widget within its toplevel. More...
 
void set_receives_default (bool receives_default=true)
 Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...
 
bool get_receives_default () const
 Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...
 
void set_name (const Glib::ustring & name)
 Sets a widgets name. More...
 
void unset_name ()
 
Glib::ustring get_name () const
 Retrieves the name of a widget. More...
 
void set_state_flags (StateFlags flags, bool clear=true)
 Turns on flag values in the current widget state. More...
 
void unset_state_flags (StateFlags flags)
 Turns off flag values for the current widget state. More...
 
StateFlags get_state_flags () const
 Returns the widget state as a flag set. More...
 
void set_sensitive (bool sensitive=true)
 Sets the sensitivity of a widget. More...
 
bool get_sensitive () const
 Returns the widget’s sensitivity. More...
 
bool is_sensitive () const
 Returns the widget’s effective sensitivity. More...
 
void set_visible (bool visible=true)
 Sets the visibility state of widget. More...
 
bool get_visible () const
 Determines whether the widget is visible. More...
 
bool is_visible () const
 Determines whether the widget and all its parents are marked as visible. More...
 
bool is_drawable () const
 Determines whether widget can be drawn to. More...
 
bool get_realized () const
 Determines whether widget is realized. More...
 
bool get_mapped () const
 Whether the widget is mapped. More...
 
void set_child_visible (bool visible=true)
 Sets whether widget should be mapped along with its parent. More...
 
bool get_child_visible () const
 Gets the value set with set_child_visible(). More...
 
int get_allocated_width () const
 Returns the width that has currently been allocated to widget. More...
 
int get_allocated_height () const
 Returns the height that has currently been allocated to widget. More...
 
int get_allocated_baseline () const
 Returns the baseline that has currently been allocated to widget. More...
 
Allocation get_allocation () const
 Retrieves the widget’s location. More...
 
std::optional< Gdk::Graphene::Rectcompute_bounds (const Widget & target) const
 Computes the bounds for the widget in the coordinate space of target. More...
 
std::optional< Gdk::Graphene::Pointcompute_point (const Widget & target, const Gdk::Graphene::Point & point) const
 Translates the given point in the widget's coordinates to coordinates relative to target’s coordinate system. More...
 
int get_width () const
 Returns the content width of the widget. More...
 
int get_height () const
 Returns the content height of the widget. More...
 
int get_baseline () const
 Returns the baseline that has currently been allocated to widget. More...
 
int get_size (Orientation orientation) const
 Returns the content width or height of the widget. More...
 
Widgetget_parent ()
 Returns the parent widget of widget. More...
 
const Widgetget_parent () const
 Returns the parent widget of widget. More...
 
Rootget_root ()
 Returns the Gtk::Root widget of widget. More...
 
const Rootget_root () const
 Returns the Gtk::Root widget of widget. More...
 
Nativeget_native ()
 Returns the nearest Gtk::Native ancestor of widget. More...
 
const Nativeget_native () const
 Returns the nearest Gtk::Native ancestor of widget. More...
 
bool child_focus (DirectionType direction)
 Called by widgets as the user moves around the window using keyboard shortcuts. More...
 
bool keynav_failed (DirectionType direction)
 Emits the ::keynav-failed signal on the widget. More...
 
void error_bell ()
 Notifies the user about an input-related error on this widget. More...
 
void set_size_request (int width=-1, int height=-1)
 Sets the minimum size of a widget. More...
 
void get_size_request (int & width, int & height) const
 Gets the size request that was explicitly set for the widget using set_size_request(). More...
 
Requisition get_size_request () const
 Like the other overload of get_size_request() but returns a structure holding the sizes instead of using output parameters. More...
 
void set_opacity (double opacity)
 Request the widget to be rendered partially transparent. More...
 
double get_opacity () const
 #Fetches the requested opacity for this widget. More...
 
void set_overflow (Overflow overflow)
 Sets how widget treats content that is drawn outside the widget's content area. More...
 
Overflow get_overflow () const
 Returns the widget’s overflow value. More...
 
Widgetget_ancestor (GType widget_type)
 Gets the first ancestor of widget with type widget_type. More...
 
const Widgetget_ancestor (GType widget_type) const
 Gets the first ancestor of widget with type widget_type. More...
 
int get_scale_factor () const
 Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. More...
 
Glib::RefPtr< Gdk::Displayget_display ()
 Get the Gdk::Display for the toplevel window associated with this widget. More...
 
Glib::RefPtr< const Gdk::Displayget_display () const
 Get the Gdk::Display for the toplevel window associated with this widget. More...
 
Glib::RefPtr< Settingsget_settings ()
 Gets the settings object holding the settings used for this widget. More...
 
Glib::RefPtr< Gdk::Clipboardget_clipboard ()
 Gets the clipboard object for widget. More...
 
Glib::RefPtr< const Gdk::Clipboardget_clipboard () const
 Gets the clipboard object for widget. More...
 
Glib::RefPtr< Gdk::Clipboardget_primary_clipboard ()
 Gets the primary clipboard of widget. More...
 
Glib::RefPtr< const Gdk::Clipboardget_primary_clipboard () const
 Gets the primary clipboard of widget. More...
 
bool get_hexpand () const
 Gets whether the widget would like any available extra horizontal space. More...
 
void set_hexpand (bool expand=true)
 Sets whether the widget would like any available extra horizontal space. More...
 
bool get_hexpand_set () const
 Gets whether set_hexpand() has been used to explicitly set the expand flag on this widget. More...
 
void set_hexpand_set (bool set=true)
 Sets whether the hexpand flag will be used. More...
 
bool get_vexpand () const
 Gets whether the widget would like any available extra vertical space. More...
 
void set_vexpand (bool expand=true)
 Sets whether the widget would like any available extra vertical space. More...
 
bool get_vexpand_set () const
 Gets whether set_vexpand() has been used to explicitly set the expand flag on this widget. More...
 
void set_vexpand_set (bool set=true)
 Sets whether the vexpand flag will be used. More...
 
bool compute_expand (Orientation orientation)
 Computes whether a container should give this widget extra space when possible. More...
 
void set_expand (bool expand=true)
 Sets whether the widget would like any available extra space in both directions. More...
 
Align get_halign () const
 Gets the horizontal alignment of widget. More...
 
void set_halign (Align align)
 Sets the horizontal alignment of widget. More...
 
Align get_valign () const
 Gets the vertical alignment of widget. More...
 
void set_valign (Align align)
 Sets the vertical alignment of widget. More...
 
int get_margin_start () const
 Gets the start margin of widget. More...
 
void set_margin_start (int margin)
 Sets the start margin of widget. More...
 
int get_margin_end () const
 Gets the end margin of widget. More...
 
void set_margin_end (int margin)
 Sets the end margin of widget. More...
 
int get_margin_top () const
 Gets the top margin of widget. More...
 
void set_margin_top (int margin)
 Sets the top margin of widget. More...
 
int get_margin_bottom () const
 Gets the bottom margin of widget. More...
 
void set_margin_bottom (int margin)
 Sets the bottom margin of widget. More...
 
void set_margin (int margin)
 Set all 4 margins to the same value. More...
 
bool is_ancestor (Widget & ancestor) const
 Determines whether widget is somewhere inside ancestor, possibly with intermediate containers. More...
 
bool translate_coordinates (Widget & dest_widget, double src_x, double src_y, double & dest_x, double & dest_y)
 Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More...
 
bool contains (double x, double y) const
 Tests if the point at ( x, y) is contained in widget. More...
 
Widgetpick (double x, double y, PickFlags flags=PickFlags::DEFAULT)
 Finds the descendant of widget closest to the point ( x, y). More...
 
const Widgetpick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const
 Finds the descendant of widget closest to the point ( x, y). More...
 
void add_controller (const Glib::RefPtr< EventController > & controller)
 Adds controller to widget so that it will receive events. More...
 
void remove_controller (const Glib::RefPtr< EventController > & controller)
 Removes controller from widget, so that it doesn't process events anymore. More...
 
Glib::RefPtr< Pango::Context > create_pango_context ()
 Creates a new Pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. More...
 
Glib::RefPtr< Pango::Context > get_pango_context ()
 Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget. More...
 
void set_font_options (const Cairo::FontOptions & options)
 Sets the cairo_font_options_t used for Pango rendering in this widget. More...
 
void unset_font_options ()
 Undoes the effect of previous calls to set_font_options(). More...
 
Cairo::FontOptions get_font_options () const
 Returns the cairo_font_options_t of widget. More...
 
Glib::RefPtr< Pango::Layout > create_pango_layout (const Glib::ustring & text)
 Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. More...
 
void set_direction (TextDirection dir)
 Sets the reading direction on a particular widget. More...
 
TextDirection get_direction () const
 Gets the reading direction for a particular widget. More...
 
void set_cursor (const Glib::RefPtr< Gdk::Cursor > & cursor)
 Sets the cursor to be shown when pointer devices point towards widget. More...
 
void set_cursor (const Glib::ustring & name={})
 Sets a named cursor to be shown when pointer devices point towards the widget. More...
 
Glib::RefPtr< Gdk::Cursorget_cursor ()
 Queries the cursor set on widget. More...
 
Glib::RefPtr< const Gdk::Cursorget_cursor () const
 Queries the cursor set on widget. More...
 
std::vector< Widget * > list_mnemonic_labels ()
 Returns the widgets for which this widget is the target of a mnemonic. More...
 
std::vector< const Widget * > list_mnemonic_labels () const
 Returns the widgets for which this widget is the target of a mnemonic. More...
 
void add_mnemonic_label (Widget & label)
 Adds a widget to the list of mnemonic labels for this widget. More...
 
void remove_mnemonic_label (Widget & label)
 Removes a widget from the list of mnemonic labels for this widget. More...
 
bool drag_check_threshold (int start_x, int start_y, int current_x, int current_y)
 Checks to see if a drag movement has passed the GTK drag threshold. More...
 
Glib::RefPtr< Gdk::FrameClockget_frame_clock ()
 Obtains the frame clock for a widget. More...
 
Glib::RefPtr< const Gdk::FrameClockget_frame_clock () const
 Obtains the frame clock for a widget. More...
 
void set_parent (Widget & parent)
 Sets parent as the parent widget of widget. More...
 
void unparent ()
 Dissociate widget from its parent. More...
 
void map ()
 Causes a widget to be mapped if it isn’t already. More...
 
void unmap ()
 Causes a widget to be unmapped if it’s currently mapped. More...
 
void trigger_tooltip_query ()
 Triggers a tooltip query on the display where the toplevel of widget is located. More...
 
void set_tooltip_text (const Glib::ustring & text)
 Sets text as the contents of the tooltip. More...
 
Glib::ustring get_tooltip_text () const
 Gets the contents of the tooltip for widget. More...
 
void set_tooltip_markup (const Glib::ustring & markup)
 Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More...
 
Glib::ustring get_tooltip_markup () const
 Gets the contents of the tooltip for widget. More...
 
void set_has_tooltip (bool has_tooltip=TRUE)
 Sets the has-tooltip property on widget to has_tooltip. More...
 
bool get_has_tooltip () const
 Returns the current value of the has-tooltip property. More...
 
bool in_destruction () const
 Returns whether the widget is currently being destroyed. More...
 
Glib::RefPtr< StyleContextget_style_context ()
 Returns the style context associated to widget. More...
 
Glib::RefPtr< const StyleContextget_style_context () const
 Returns the style context associated to widget. More...
 
guint add_tick_callback (const SlotTick & slot)
 Queues an animation frame update and adds a callback to be called before each frame. More...
 
void remove_tick_callback (guint id)
 Removes a tick callback previously registered with add_tick_callback(). More...
 
void insert_action_group (const Glib::ustring & name, const Glib::RefPtr< Gio::ActionGroup > & group)
 Inserts group into widget. More...
 
void remove_action_group (const Glib::ustring & name)
 Removes a group from the widget. More...
 
bool activate_action (const Glib::ustring & name, const Glib::VariantBase & args={})
 Looks up the action in the action groups associated with the widget and its ancestors, and activates it. More...
 
void activate_default ()
 Activates the default.activate action from widget. More...
 
void set_font_map (const Glib::RefPtr< Pango::FontMap > & font_map)
 Sets the font map to use for Pango rendering. More...
 
Glib::RefPtr< Pango::FontMap > get_font_map ()
 Gets the font map of widget. More...
 
Glib::RefPtr< const Pango::FontMap > get_font_map () const
 Gets the font map of widget. More...
 
Widgetget_first_child ()
 Returns the widget’s first child. More...
 
const Widgetget_first_child () const
 Returns the widget’s first child. More...
 
Widgetget_last_child ()
 Returns the widget’s last child. More...
 
const Widgetget_last_child () const
 Returns the widget’s last child. More...
 
Widgetget_next_sibling ()
 Returns the widget’s next sibling. More...
 
const Widgetget_next_sibling () const
 Returns the widget’s next sibling. More...
 
Widgetget_prev_sibling ()
 Returns the widget’s previous sibling. More...
 
const Widgetget_prev_sibling () const
 Returns the widget’s previous sibling. More...
 
std::vector< Widget * > get_children ()
 Gets a vector of the widgetʼs current children, from first child to last. More...
 
std::vector< const Widget * > get_children () const
 Gets a vector of the widgetʼs current children, from first child to last. More...
 
Glib::RefPtr< Gio::ListModel > observe_children ()
 Returns a Gio::ListModel to track the children of widget. More...
 
Glib::RefPtr< const Gio::ListModel > observe_children () const
 Returns a Gio::ListModel to track the children of widget. More...
 
Glib::RefPtr< Gio::ListModel > observe_controllers ()
 Returns a Gio::ListModel to track the Gtk::EventControllers of widget. More...
 
Glib::RefPtr< const Gio::ListModel > observe_controllers () const
 Returns a Gio::ListModel to track the Gtk::EventControllers of widget. More...
 
void insert_after (Widget & parent, const Widget & previous_sibling)
 Inserts the Widget into the child widget list of parent after previous_sibling. More...
 
void insert_before (Widget & parent, const Widget & next_sibling)
 Inserts the Widget into the child widget list of parent before next_sibling. More...
 
void insert_at_start (Widget & parent)
 Inserts the Widget at the beginning of the child widget list of parent. More...
 
void insert_at_end (Widget & parent)
 Inserts the Widget at the end of the child widget list of parent. More...
 
void snapshot_child (Widget & child, const Glib::RefPtr< Gtk::Snapshot > & snapshot)
 Snapshot the a child of widget. More...
 
bool should_layout () const
 Returns whether widget should contribute to the measuring and allocation of its parent. More...
 
Glib::ustring get_css_name () const
 Returns the CSS name that is used for self. More...
 
void add_css_class (const Glib::ustring & css_class)
 Adds a style class to widget. More...
 
void remove_css_class (const Glib::ustring & css_class)
 Removes a style from widget. More...
 
bool has_css_class (const Glib::ustring & css_class) const
 Returns whether css_class is currently applied to widget. More...
 
std::vector< Glib::ustring > get_css_classes () const
 Returns the list of style classes applied to widget. More...
 
void set_css_classes (const std::vector< Glib::ustring > & classes)
 Clear all style classes applied to widget and replace them with classes. More...
 
Gdk::RGBA get_color () const
 Gets the current foreground color for the widget's CSS style. More...
 
Glib::SignalProxy< void()> signal_show ()
 
Glib::SignalProxy< void()> signal_hide ()
 
Glib::SignalProxy< void()> signal_map ()
 Emitted on mapping of a widget to the screen. More...
 
Glib::SignalProxy< void()> signal_unmap ()
 
Glib::SignalProxy< void()> signal_realize ()
 Emitted on realization of a widget. More...
 
Glib::SignalProxy< void()> signal_unrealize ()
 
Glib::SignalProxy< void(Gtk::StateFlags)> signal_state_flags_changed ()
 
Glib::SignalProxy< void(TextDirection)> signal_direction_changed ()
 
Glib::SignalProxy< bool(bool)> signal_mnemonic_activate ()
 
Glib::SignalProxy< void()> signal_destroy ()
 Emitted during the dispose phase. More...
 
Glib::SignalProxy< bool(int, int, bool, const Glib::RefPtr< Tooltip > &)> signal_query_tooltip ()
 
Glib::PropertyProxy< Glib::ustring > property_name ()
 The name of the widget. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_name () const
 The name of the widget. More...
 
Glib::PropertyProxy_ReadOnly< Widget * > property_parent () const
 The parent widget of this widget. More...
 
Glib::PropertyProxy_ReadOnly< Root * > property_root () const
 The Gtk::Root widget of the widget tree containing this widget. More...
 
Glib::PropertyProxy< int > property_width_request ()
 Override for width request of the widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_width_request () const
 Override for width request of the widget. More...
 
Glib::PropertyProxy< int > property_height_request ()
 Override for height request of the widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_height_request () const
 Override for height request of the widget. More...
 
Glib::PropertyProxy< bool > property_visible ()
 Whether the widget is visible. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 Whether the widget is visible. More...
 
Glib::PropertyProxy< bool > property_sensitive ()
 Whether the widget responds to input. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 Whether the widget responds to input. More...
 
Glib::PropertyProxy< bool > property_can_focus ()
 Whether the widget or any of its descendents can accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_can_focus () const
 Whether the widget or any of its descendents can accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_focus () const
 Whether the widget has the input focus. More...
 
Glib::PropertyProxy< bool > property_can_target ()
 Whether the widget can receive pointer events. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_can_target () const
 Whether the widget can receive pointer events. More...
 
Glib::PropertyProxy< bool > property_focus_on_click ()
 Whether the widget should grab focus when it is clicked with the mouse. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_focus_on_click () const
 Whether the widget should grab focus when it is clicked with the mouse. More...
 
Glib::PropertyProxy< bool > property_focusable ()
 Whether this widget itself will accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_focusable () const
 Whether this widget itself will accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_default () const
 Whether the widget is the default widget. More...
 
Glib::PropertyProxy< bool > property_receives_default ()
 Whether the widget will receive the default action when it is focused. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_receives_default () const
 Whether the widget will receive the default action when it is focused. More...
 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Cursor > > property_cursor ()
 The cursor used by widget. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Cursor > > property_cursor () const
 The cursor used by widget. More...
 
Glib::PropertyProxy< bool > property_has_tooltip ()
 Enables or disables the emission of the signal_query_tooltip() signal on widget. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_tooltip () const
 Enables or disables the emission of the signal_query_tooltip() signal on widget. More...
 
Glib::PropertyProxy< Glib::ustring > property_tooltip_markup ()
 Sets the text of tooltip to be the given string, which is marked up with Pango markup. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_tooltip_markup () const
 Sets the text of tooltip to be the given string, which is marked up with Pango markup. More...
 
Glib::PropertyProxy< Glib::ustring > property_tooltip_text ()
 Sets the text of tooltip to be the given string. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_tooltip_text () const
 Sets the text of tooltip to be the given string. More...
 
Glib::PropertyProxy< Alignproperty_halign ()
 How to distribute horizontal space if widget gets extra space. More...
 
Glib::PropertyProxy_ReadOnly< Alignproperty_halign () const
 How to distribute horizontal space if widget gets extra space. More...
 
Glib::PropertyProxy< Alignproperty_valign ()
 How to distribute vertical space if widget gets extra space. More...
 
Glib::PropertyProxy_ReadOnly< Alignproperty_valign () const
 How to distribute vertical space if widget gets extra space. More...
 
Glib::PropertyProxy< int > property_margin_start ()
 Margin on start of widget, horizontally. More...
 
Glib::PropertyProxy_ReadOnly< int > property_margin_start () const
 Margin on start of widget, horizontally. More...
 
Glib::PropertyProxy< int > property_margin_end ()
 Margin on end of widget, horizontally. More...
 
Glib::PropertyProxy_ReadOnly< int > property_margin_end () const
 Margin on end of widget, horizontally. More...
 
Glib::PropertyProxy< int > property_margin_top ()
 Margin on top side of widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_margin_top () const
 Margin on top side of widget. More...
 
Glib::PropertyProxy< int > property_margin_bottom ()
 Margin on bottom side of widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_margin_bottom () const
 Margin on bottom side of widget. More...
 
Glib::PropertyProxy< bool > property_hexpand ()
 Whether to expand horizontally. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand () const
 Whether to expand horizontally. More...
 
Glib::PropertyProxy< bool > property_hexpand_set ()
 Whether to use the hexpand property. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand_set () const
 Whether to use the hexpand property. More...
 
Glib::PropertyProxy< bool > property_vexpand ()
 Whether to expand vertically. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand () const
 Whether to expand vertically. More...
 
Glib::PropertyProxy< bool > property_vexpand_set ()
 Whether to use the vexpand property. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand_set () const
 Whether to use the vexpand property. More...
 
Glib::PropertyProxy< double > property_opacity ()
 The requested opacity of the widget. More...
 
Glib::PropertyProxy_ReadOnly< double > property_opacity () const
 The requested opacity of the widget. More...
 
Glib::PropertyProxy< Overflowproperty_overflow ()
 How content outside the widget's content area is treated. More...
 
Glib::PropertyProxy_ReadOnly< Overflowproperty_overflow () const
 How content outside the widget's content area is treated. More...
 
Glib::PropertyProxy_ReadOnly< int > property_scale_factor () const
 The scale factor of the widget. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_css_name () const
 The name of this widget in the CSS tree. More...
 
Glib::PropertyProxy< std::vector< Glib::ustring > > property_css_classes ()
 A list of css classes applied to this widget. More...
 
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > property_css_classes () const
 A list of css classes applied to this widget. More...
 
Glib::PropertyProxy< Glib::RefPtr< LayoutManager > > property_layout_manager ()
 The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< LayoutManager > > property_layout_manager () const
 The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More...
 
- Public Member Functions inherited from Gtk::Object
 Object (Object && src) noexcept
 
Objectoperator= (Object && src) noexcept
 
 ~Object () noexcept override
 
- Public Member Functions inherited from Gtk::Accessible
 Accessible (Accessible && src) noexcept
 
Accessibleoperator= (Accessible && src) noexcept
 
 ~Accessible () noexcept override
 
GtkAccessible * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkAccessible * gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::RefPtr< ATContextget_at_context ()
 Retrieves the accessible implementation for the given Gtk::Accessible. More...
 
Glib::RefPtr< const ATContextget_at_context () const
 Retrieves the accessible implementation for the given Gtk::Accessible. More...
 
bool get_platform_state (PlatformState state) const
 Query a platform state, such as focus. More...
 
Glib::RefPtr< Accessibleget_accessible_parent ()
 Retrieves the accessible parent for an accessible object. More...
 
Glib::RefPtr< const Accessibleget_accessible_parent () const
 Retrieves the accessible parent for an accessible object. More...
 
void set_accessible_parent (const Glib::RefPtr< Accessible > & parent, const Glib::RefPtr< Accessible > & next_sibling)
 Sets the parent and sibling of an accessible object. More...
 
Glib::RefPtr< Accessibleget_first_accessible_child ()
 Retrieves the first accessible child of an accessible object. More...
 
Glib::RefPtr< const Accessibleget_first_accessible_child () const
 Retrieves the first accessible child of an accessible object. More...
 
Glib::RefPtr< Accessibleget_next_accessible_sibling ()
 Retrieves the next accessible sibling of an accessible object. More...
 
Glib::RefPtr< const Accessibleget_next_accessible_sibling () const
 Retrieves the next accessible sibling of an accessible object. More...
 
void update_next_accessible_sibling (const Glib::RefPtr< Accessible > & new_sibling)
 Updates the next accessible sibling of self. More...
 
bool get_bounds (int & x, int & y, int & width, int & height) const
 Queries the coordinates and dimensions of this accessible. More...
 
Role get_accessible_role () const
 Retrieves the accessible role of an accessible object. More...
 
void update_state (State state, const Glib::ValueBase & value)
 Updates an accessible state. More...
 
void update_property (Property property, const Glib::ValueBase & value)
 Updates an accessible property. More...
 
void update_relation (Relation relation, const Glib::ValueBase & value)
 Updates an accessible relation. More...
 
void reset_state (State state)
 Resets the accessible state to its default value. More...
 
void reset_property (Property property)
 Resets the accessible property to its default value. More...
 
void reset_relation (Relation relation)
 Resets the accessible relation to its default value. More...
 
void announce (const Glib::ustring & message, AnnouncementPriority priority)
 Requests the user's screen reader to announce the given message. More...
 
Glib::PropertyProxy< Roleproperty_accessible_role ()
 The accessible role of the given Gtk::Accessible implementation. More...
 
Glib::PropertyProxy_ReadOnly< Roleproperty_accessible_role () const
 The accessible role of the given Gtk::Accessible implementation. More...
 
- Public Member Functions inherited from Gtk::Buildable
 Buildable (Buildable && src) noexcept
 
Buildableoperator= (Buildable && src) noexcept
 
 ~Buildable () noexcept override
 
GtkBuildable * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkBuildable * gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::ustring get_buildable_id () const
 Gets the ID of the buildable object. More...
 
- Public Member Functions inherited from Gtk::ConstraintTarget
 ConstraintTarget (ConstraintTarget && src) noexcept
 
ConstraintTargetoperator= (ConstraintTarget && src) noexcept
 
 ~ConstraintTarget () noexcept override
 
GtkConstraintTarget * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkConstraintTarget * gobj () const
 Provides access to the underlying C GObject. More...
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Static Public Member Functions inherited from Gtk::Widget
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static void set_default_direction (TextDirection dir)
 Sets the default reading direction for widgets. More...
 
static TextDirection get_default_direction ()
 Obtains the current default reading direction. More...
 
- Static Public Member Functions inherited from Gtk::Accessible
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Static Public Member Functions inherited from Gtk::Buildable
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Static Public Member Functions inherited from Gtk::ConstraintTarget
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Protected Member Functions

virtual Glib::RefPtr< Gdk::GLContexton_create_context ()
 This is a default handler for the signal signal_create_context(). More...
 
virtual bool on_render (const Glib::RefPtr< Gdk::GLContext > & context)
 This is a default handler for the signal signal_render(). More...
 
virtual void on_resize (int width, int height)
 This is a default handler for the signal signal_resize(). More...
 
- Protected Member Functions inherited from Gtk::Widget
virtual void root_vfunc ()
 
virtual void unroot_vfunc ()
 
virtual void size_allocate_vfunc (int width, int height, int baseline)
 
virtual SizeRequestMode get_request_mode_vfunc () const
 
virtual void measure_vfunc (Orientation orientation, int for_size, int & minimum, int & natural, int & minimum_baseline, int & natural_baseline) const
 
virtual bool grab_focus_vfunc ()
 
virtual void set_focus_child_vfunc (Widget * child)
 Sets the focused child of widget. More...
 
virtual void compute_expand_vfunc (bool & hexpand_p, bool & vexpand_p)
 
virtual bool contains_vfunc (double x, double y) const
 
virtual void snapshot_vfunc (const Glib::RefPtr< Gtk::Snapshot > & snapshot)
 
 Widget ()
 
void realize ()
 Creates the GDK resources associated with a widget. More...
 
void unrealize ()
 Causes a widget to be unrealized (frees all GDK resources associated with the widget). More...
 
void realize_if_needed ()
 
void set_focus_child (Widget & child)
 Set child as the current focus child of widget. More...
 
void unset_focus_child ()
 Unsets the focus child of the widget. More...
 
Widgetget_focus_child ()
 Returns the current focus child of widget. More...
 
const Widgetget_focus_child () const
 Returns the current focus child of widget. More...
 
virtual void on_show ()
 This is a default handler for the signal signal_show(). More...
 
virtual void on_hide ()
 This is a default handler for the signal signal_hide(). More...
 
virtual void on_map ()
 This is a default handler for the signal signal_map(). More...
 
virtual void on_unmap ()
 This is a default handler for the signal signal_unmap(). More...
 
virtual void on_realize ()
 This is a default handler for the signal signal_realize(). More...
 
virtual void on_unrealize ()
 This is a default handler for the signal signal_unrealize(). More...
 
virtual void on_state_flags_changed (Gtk::StateFlags previous_state_flags)
 This is a default handler for the signal signal_state_flags_changed(). More...
 
virtual void on_direction_changed (TextDirection direction)
 This is a default handler for the signal signal_direction_changed(). More...
 
virtual bool on_mnemonic_activate (bool group_cycling)
 This is a default handler for the signal signal_mnemonic_activate(). More...
 
virtual bool on_query_tooltip (int x, int y, bool keyboard_tooltip, const Glib::RefPtr< Tooltip > & tooltip)
 This is a default handler for the signal signal_query_tooltip(). More...
 
- Protected Member Functions inherited from Gtk::Accessible
 Accessible ()
 You should derive from this class to use it. More...
 
- Protected Member Functions inherited from Gtk::Buildable
 Buildable ()
 You should derive from this class to use it. More...
 
- Protected Member Functions inherited from Gtk::ConstraintTarget
 ConstraintTarget ()
 You should derive from this class to use it. More...
 

Related Functions

(Note that these are not member functions.)

Gtk::GLAreawrap (GtkGLArea * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

- Public Types inherited from Gtk::Widget
using PreferredSize = MinimumNatural< Requisition >
 Structure returned by the non-output-parameter overload of get_preferred_size(). More...
 
using SlotTick = sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock > &)>
 Callback type for adding a function to update animations. More...
 
- Public Types inherited from Gtk::Accessible
enum class  Role {
  Role::ALERT ,
  Role::ALERT_DIALOG ,
  Role::BANNER ,
  Role::BUTTON ,
  Role::CAPTION ,
  Role::CELL ,
  Role::CHECKBOX ,
  Role::COLUMN_HEADER ,
  Role::COMBO_BOX ,
  Role::COMMAND ,
  Role::COMPOSITE ,
  Role::DIALOG ,
  Role::DOCUMENT ,
  Role::FEED ,
  Role::FORM ,
  Role::GENERIC ,
  Role::GRID ,
  Role::GRID_CELL ,
  Role::GROUP ,
  Role::HEADING ,
  Role::IMG ,
  Role::INPUT ,
  Role::LABEL ,
  Role::LANDMARK ,
  Role::LEGEND ,
  Role::LINK ,
  Role::LIST ,
  Role::LIST_BOX ,
  Role::LIST_ITEM ,
  Role::LOG ,
  Role::MAIN ,
  Role::MARQUEE ,
  Role::MATH ,
  Role::METER ,
  Role::MENU ,
  Role::MENU_BAR ,
  Role::MENU_ITEM ,
  Role::MENU_ITEM_CHECKBOX ,
  Role::MENU_ITEM_RADIO ,
  Role::NAVIGATION ,
  Role::NONE ,
  Role::NOTE ,
  Role::OPTION ,
  Role::PRESENTATION ,
  Role::PROGRESS_BAR ,
  Role::RADIO ,
  Role::RADIO_GROUP ,
  Role::RANGE ,
  Role::REGION ,
  Role::ROW ,
  Role::ROW_GROUP ,
  Role::ROW_HEADER ,
  Role::SCROLLBAR ,
  Role::SEARCH ,
  Role::SEARCH_BOX ,
  Role::SECTION ,
  Role::SECTION_HEAD ,
  Role::SELECT ,
  Role::SEPARATOR ,
  Role::SLIDER ,
  Role::SPIN_BUTTON ,
  Role::STATUS ,
  Role::STRUCTURE ,
  Role::SWITCH ,
  Role::TAB ,
  Role::TABLE ,
  Role::TAB_LIST ,
  Role::TAB_PANEL ,
  Role::TEXT_BOX ,
  Role::TIME ,
  Role::TIMER ,
  Role::TOOLBAR ,
  Role::TOOLTIP ,
  Role::TREE ,
  Role::TREE_GRID ,
  Role::TREE_ITEM ,
  Role::WIDGET ,
  Role::WINDOW ,
  Role::TOGGLE_BUTTON ,
  Role::APPLICATION ,
  Role::PARAGRAPH ,
  Role::BLOCK_QUOTE ,
  Role::ARTICLE ,
  Role::COMMENT ,
  Role::TERMINAL
}
 The accessible role for a Gtk::Accessible implementation. More...
 
enum class  State {
  State::BUSY ,
  State::CHECKED ,
  State::DISABLED ,
  State::EXPANDED ,
  State::HIDDEN ,
  State::INVALID ,
  State::PRESSED ,
  State::SELECTED ,
  State::VISITED
}
 The possible accessible states of a Gtk::Accessible. More...
 
enum class  Property {
  Property::AUTOCOMPLETE ,
  Property::DESCRIPTION ,
  Property::HAS_POPUP ,
  Property::KEY_SHORTCUTS ,
  Property::LABEL ,
  Property::LEVEL ,
  Property::MODAL ,
  Property::MULTI_LINE ,
  Property::MULTI_SELECTABLE ,
  Property::ORIENTATION ,
  Property::PLACEHOLDER ,
  Property::READ_ONLY ,
  Property::REQUIRED ,
  Property::ROLE_DESCRIPTION ,
  Property::SORT ,
  Property::VALUE_MAX ,
  Property::VALUE_MIN ,
  Property::VALUE_NOW ,
  Property::VALUE_TEXT
}
 The possible accessible properties of a Gtk::Accessible. More...
 
enum class  Relation {
  Relation::ACTIVE_DESCENDANT ,
  Relation::COL_COUNT ,
  Relation::COL_INDEX ,
  Relation::COL_INDEX_TEXT ,
  Relation::COL_SPAN ,
  Relation::CONTROLS ,
  Relation::DESCRIBED_BY ,
  Relation::DETAILS ,
  Relation::ERROR_MESSAGE ,
  Relation::FLOW_TO ,
  Relation::LABELLED_BY ,
  Relation::OWNS ,
  Relation::POS_IN_SET ,
  Relation::ROW_COUNT ,
  Relation::ROW_INDEX ,
  Relation::ROW_INDEX_TEXT ,
  Relation::ROW_SPAN ,
  Relation::SET_SIZE
}
 The possible accessible relations of a Gtk::Accessible. More...
 
enum class  PlatformState {
  PlatformState::FOCUSABLE ,
  PlatformState::FOCUSED ,
  PlatformState::ACTIVE
}
 The various platform states which can be queried using Gtk::Accessible::get_platform_state(). More...
 
enum class  AnnouncementPriority {
  AnnouncementPriority::LOW ,
  AnnouncementPriority::MEDIUM ,
  AnnouncementPriority::HIGH
}
 The priority of an accessibility announcement. More...
 

Detailed Description

A widget used for drawing with OpenGL.

Since gtkmm 3.18:

Constructor & Destructor Documentation

◆ GLArea() [1/3]

Gtk::GLArea::GLArea ( GLArea &&  src)
noexcept

◆ GLArea() [2/3]

Gtk::GLArea::GLArea ( const GLArea )
delete

◆ ~GLArea()

Gtk::GLArea::~GLArea ( )
overridenoexcept

◆ GLArea() [3/3]

Gtk::GLArea::GLArea ( )

Member Function Documentation

◆ attach_buffers()

void Gtk::GLArea::attach_buffers ( )

Binds buffers to the framebuffer.

Ensures that the area framebuffer object is made the current draw and read target, and that all the required buffers for the area are created and bound to the framebuffer.

This function is automatically called before emitting the signal_render() signal, and doesn't normally need to be called by application code.

Since gtkmm 3.18:

◆ get_allowed_apis()

Gdk::GLApi Gtk::GLArea::get_allowed_apis ( ) const

Gets the allowed APIs.

See set_allowed_apis().

Since gtkmm 4.12:
Returns
The allowed APIs.

◆ get_api()

Gdk::GLApi Gtk::GLArea::get_api ( ) const

Gets the API that is currently in use.

If the GL area has not been realized yet, 0 is returned.

Since gtkmm 4.12:
Returns
The currently used API.

◆ get_auto_render()

bool Gtk::GLArea::get_auto_render ( ) const

Returns whether the area is in auto render mode or not.

Since gtkmm 3.18:
Returns
true if the area is auto rendering, false otherwise.

◆ get_context() [1/2]

Glib::RefPtr< Gdk::GLContext > Gtk::GLArea::get_context ( )

Retrieves the Gdk::GLContext used by area.

Since gtkmm 3.18:
Returns
The Gdk::GLContext.

◆ get_context() [2/2]

Glib::RefPtr< const Gdk::GLContext > Gtk::GLArea::get_context ( ) const

Retrieves the Gdk::GLContext used by area.

Since gtkmm 3.18:
Returns
The Gdk::GLContext.

◆ get_has_depth_buffer()

bool Gtk::GLArea::get_has_depth_buffer ( ) const

Returns whether the area has a depth buffer.

Since gtkmm 3.18:
Returns
true if the area has a depth buffer, false otherwise.

◆ get_has_stencil_buffer()

bool Gtk::GLArea::get_has_stencil_buffer ( ) const

Returns whether the area has a stencil buffer.

Since gtkmm 3.18:
Returns
true if the area has a stencil buffer, false otherwise.

◆ get_required_version()

void Gtk::GLArea::get_required_version ( int &  major,
int &  minor 
) const

Retrieves the required version of OpenGL.

See set_required_version().

Since gtkmm 3.18:
Parameters
majorReturn location for the required major version.
minorReturn location for the required minor version.

◆ get_type()

static GType Gtk::GLArea::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ get_use_es()

bool Gtk::GLArea::get_use_es ( ) const

Returns whether the Gtk::GLArea should use OpenGL ES.

See set_use_es().

Deprecated: 4.12: Use get_api()

Deprecated:
Use get_api() instead.
Returns
true if the Gtk::GLArea should create an OpenGL ES context and false otherwise.

◆ gobj() [1/2]

GtkGLArea * Gtk::GLArea::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkGLArea * Gtk::GLArea::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ has_error()

bool Gtk::GLArea::has_error ( ) const

Check if any error is currently set on this area.

The error may be obtained by using throw_if_error() and set using set_error().

Since gtkmm 3.18:
Returns
true if an error is currently set.

◆ make_current()

void Gtk::GLArea::make_current ( )

Ensures that the Gdk::GLContext used by area is associated with the Gtk::GLArea.

This function is automatically called before emitting the signal_render() signal, and doesn't normally need to be called by application code.

Since gtkmm 3.18:

◆ on_create_context()

virtual Glib::RefPtr< Gdk::GLContext > Gtk::GLArea::on_create_context ( )
protectedvirtual

This is a default handler for the signal signal_create_context().

◆ on_render()

virtual bool Gtk::GLArea::on_render ( const Glib::RefPtr< Gdk::GLContext > &  context)
protectedvirtual

This is a default handler for the signal signal_render().

◆ on_resize()

virtual void Gtk::GLArea::on_resize ( int  width,
int  height 
)
protectedvirtual

This is a default handler for the signal signal_resize().

◆ operator=() [1/2]

GLArea & Gtk::GLArea::operator= ( const GLArea )
delete

◆ operator=() [2/2]

GLArea & Gtk::GLArea::operator= ( GLArea &&  src)
noexcept

◆ property_allowed_apis() [1/2]

Glib::PropertyProxy< Gdk::GLApi > Gtk::GLArea::property_allowed_apis ( )

The allowed APIs.

Since gtkmm 4.12:

Default value: Gdk::GLApi::GL | Gdk::GLApi::GLES

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_allowed_apis() [2/2]

Glib::PropertyProxy_ReadOnly< Gdk::GLApi > Gtk::GLArea::property_allowed_apis ( ) const

The allowed APIs.

Since gtkmm 4.12:

Default value: Gdk::GLApi::GL | Gdk::GLApi::GLES

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_api()

Glib::PropertyProxy_ReadOnly< Gdk::GLApi > Gtk::GLArea::property_api ( ) const

The API currently in use.

Since gtkmm 4.12:

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_auto_render() [1/2]

Glib::PropertyProxy< bool > Gtk::GLArea::property_auto_render ( )

If set to true the signal_render() signal will be emitted every time the widget draws.

This is the default and is useful if drawing the widget is faster.

If set to false the data from previous rendering is kept around and will be used for drawing the widget the next time, unless the window is resized. In order to force a rendering Gtk::GLArea::queue_render() must be called. This mode is useful when the scene changes seldom, but takes a long time to redraw.

Since gtkmm 3.18:

Default value: true

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_auto_render() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::GLArea::property_auto_render ( ) const

If set to true the signal_render() signal will be emitted every time the widget draws.

This is the default and is useful if drawing the widget is faster.

If set to false the data from previous rendering is kept around and will be used for drawing the widget the next time, unless the window is resized. In order to force a rendering Gtk::GLArea::queue_render() must be called. This mode is useful when the scene changes seldom, but takes a long time to redraw.

Since gtkmm 3.18:

Default value: true

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_context()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::GLContext > > Gtk::GLArea::property_context ( ) const

The Gdk::GLContext used by the Gtk::GLArea widget.

The Gtk::GLArea widget is responsible for creating the Gdk::GLContext instance. If you need to render with other kinds of buffers (stencil, depth, etc), use render buffers.

Since gtkmm 3.18:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_has_depth_buffer() [1/2]

Glib::PropertyProxy< bool > Gtk::GLArea::property_has_depth_buffer ( )

If set to true the widget will allocate and enable a depth buffer for the target framebuffer.

Setting this property will enable GL's depth testing as a side effect. If you don't need depth testing, you should call glDisable(GL_DEPTH_TEST) in your GtkGLArea::render handler.

Since gtkmm 3.18:

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_has_depth_buffer() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::GLArea::property_has_depth_buffer ( ) const

If set to true the widget will allocate and enable a depth buffer for the target framebuffer.

Setting this property will enable GL's depth testing as a side effect. If you don't need depth testing, you should call glDisable(GL_DEPTH_TEST) in your GtkGLArea::render handler.

Since gtkmm 3.18:

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_has_stencil_buffer() [1/2]

Glib::PropertyProxy< bool > Gtk::GLArea::property_has_stencil_buffer ( )

If set to true the widget will allocate and enable a stencil buffer for the target framebuffer.

Since gtkmm 3.18:

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_has_stencil_buffer() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::GLArea::property_has_stencil_buffer ( ) const

If set to true the widget will allocate and enable a stencil buffer for the target framebuffer.

Since gtkmm 3.18:

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_use_es() [1/2]

Glib::PropertyProxy< bool > Gtk::GLArea::property_use_es ( )

If set to true the widget will try to create a Gdk::GLContext using OpenGL ES instead of OpenGL.

Deprecated: 4.12: Use property_allowed_apis()

Deprecated:
Use property_allowed_apis() instead.

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_use_es() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::GLArea::property_use_es ( ) const

If set to true the widget will try to create a Gdk::GLContext using OpenGL ES instead of OpenGL.

Deprecated: 4.12: Use property_allowed_apis()

Deprecated:
Use property_allowed_apis() instead.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ queue_render()

void Gtk::GLArea::queue_render ( )

Marks the currently rendered data (if any) as invalid, and queues a redraw of the widget.

This ensures that the signal_render() signal is emitted during the draw.

This is only needed when set_auto_render() has been called with a false value. The default behaviour is to emit signal_render() on each draw.

Since gtkmm 3.18:

◆ set_allowed_apis()

void Gtk::GLArea::set_allowed_apis ( Gdk::GLApi  apis)

Sets the allowed APIs to create a context with.

You should check property_api() before drawing with either API.

By default, all APIs are allowed.

Since gtkmm 4.12:
Parameters
apisThe allowed APIs.

◆ set_auto_render()

void Gtk::GLArea::set_auto_render ( bool  auto_render = true)

Sets whether the Gtk::GLArea is in auto render mode.

If auto_render is true the signal_render() signal will be emitted every time the widget draws. This is the default and is useful if drawing the widget is faster.

If auto_render is false the data from previous rendering is kept around and will be used for drawing the widget the next time, unless the window is resized. In order to force a rendering queue_render() must be called. This mode is useful when the scene changes seldom, but takes a long time to redraw.

Since gtkmm 3.18:
Parameters
auto_renderA boolean.

◆ set_error()

void Gtk::GLArea::set_error ( const Glib::Error &  error)

Sets an error on the area which will be shown instead of GL rendering.

This is useful in the signal_create_context() handler if GL context creation fails.

Since gtkmm 3.18:
Parameters
errorThe error to set on the area.

◆ set_has_depth_buffer()

void Gtk::GLArea::set_has_depth_buffer ( bool  has_depth_buffer = true)

Sets whether the Gtk::GLArea should use a depth buffer.

If has_depth_buffer is true the widget will allocate and enable a depth buffer for the target framebuffer. Otherwise there will be none.

Since gtkmm 3.18:
Parameters
has_depth_buffertrue to add a depth buffer.

◆ set_has_stencil_buffer()

void Gtk::GLArea::set_has_stencil_buffer ( bool  has_stencil_buffer = true)

Sets whether the Gtk::GLArea should use a stencil buffer.

If has_stencil_buffer is true the widget will allocate and enable a stencil buffer for the target framebuffer. Otherwise there will be none.

Since gtkmm 3.18:
Parameters
has_stencil_buffertrue to add a stencil buffer.

◆ set_required_version()

void Gtk::GLArea::set_required_version ( int  major,
int  minor 
)

Sets the required version of OpenGL to be used when creating the context for the widget.

This function must be called before the area has been realized.

Since gtkmm 3.18:
Parameters
majorThe major version.
minorThe minor version.

◆ set_use_es()

void Gtk::GLArea::set_use_es ( bool  use_es = true)

Sets whether the area should create an OpenGL or an OpenGL ES context.

You should check the capabilities of the Gdk::GLContext before drawing with either API.

Deprecated: 4.12: Use set_allowed_apis()

Deprecated:
Use set_allowed_apis() instead.
Parameters
use_esWhether to use OpenGL or OpenGL ES.

◆ signal_create_context()

Glib::SignalProxy< Glib::RefPtr< Gdk::GLContext >()> Gtk::GLArea::signal_create_context ( )
Slot Prototype:
Glib::RefPtr<Gdk::GLContext> on_my_create_context()

Flags: Run Last

Emitted when the widget is being realized.

This allows you to override how the GL context is created. This is useful when you want to reuse an existing GL context, or if you want to try creating different kinds of GL options.

If context creation fails then the signal handler can use Gtk::GLArea::set_error() to register a more detailed error of how the construction failed.

Since gtkmm 3.18:
Returns
A newly created Gdk::GLContext; the Gtk::GLArea widget will take ownership of the returned value.

◆ signal_render()

Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::GLContext > &)> Gtk::GLArea::signal_render ( )
Slot Prototype:
bool on_my_render(const Glib::RefPtr<Gdk::GLContext>& context)

Flags: Run Last

Emitted every time the contents of the Gtk::GLArea should be redrawn.

The context is bound to the area prior to emitting this function, and the buffers are painted to the window once the emission terminates.

Since gtkmm 3.18:
Parameters
contextThe Gdk::GLContext used by area.
Returns
true to stop other handlers from being invoked for the event. false to propagate the event further.

◆ signal_resize()

Glib::SignalProxy< void(int, int)> Gtk::GLArea::signal_resize ( )
Slot Prototype:
void on_my_resize(int width, int height)

Flags: Run Last

Emitted once when the widget is realized, and then each time the widget is changed while realized.

This is useful in order to keep GL state up to date with the widget size, like for instance camera properties which may depend on the width/height ratio.

The GL context for the area is guaranteed to be current when this signal is emitted.

The default handler sets up the GL viewport.

Since gtkmm 3.18:
Parameters
widthThe width of the viewport.
heightThe height of the viewport.

◆ throw_if_error()

void Gtk::GLArea::throw_if_error ( ) const

Will throw the correct Glib::Error subclass if any is currently set on this area.

Since gtkmm 3.18:
Exceptions
Throwsany currently set error (e.g. Gdk::GLError).

◆ unset_error()

void Gtk::GLArea::unset_error ( )

Clears any previous set error on this area made with set_error().

Since gtkmm 3.18:

Friends And Related Function Documentation

◆ wrap()

Gtk::GLArea * wrap ( GtkGLArea *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.