gtkmm: Gdk::GLContext Class Reference

A Gdk::GLContext is an OpenGL context abstraction. More...

#include <gdkmm/glcontext.h>

Inheritance diagram for Gdk::GLContext:

Public Member Functions
	GLContext (GLContext&& src) noexcept

GLContext&	operator= (GLContext&& src) noexcept

	~GLContext () noexceptoverride

GdkGLContext*	gobj ()
	Provides access to the underlying C GObject. More...

const GdkGLContext*	gobj () const
	Provides access to the underlying C GObject. More...

GdkGLContext*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Glib::RefPtr< Display >	get_display ()
	Retrieves the Gdk::Display the context is created for. More...

Glib::RefPtr< const Display >	get_display () const
	Retrieves the Gdk::Display the context is created for. More...

Glib::RefPtr< Window >	get_window ()
	Retrieves the Gdk::Window used by the context. More...

Glib::RefPtr< const Window >	get_window () const
	Retrieves the Gdk::Window used by the context. More...

Glib::RefPtr< GLContext >	get_shared_context ()
	Retrieves the Gdk::GLContext that this context share data with. More...

Glib::RefPtr< const GLContext >	get_shared_context () const
	Retrieves the Gdk::GLContext that this context share data with. More...

void	get_version (int& major, int& minor) const
	Retrieves the OpenGL version of the context. More...

bool	is_legacy () const
	Whether the Gdk::GLContext is in legacy mode or not. More...

void	get_required_version (int& major, int& minor) const
	Retrieves the major and minor version requested by calling gdk_gl_context_set_required_version(). More...

void	set_required_version (int major, int minor)
	Sets the major and minor version of OpenGL to request. More...

bool	get_debug_enabled () const
	Retrieves the value set using gdk_gl_context_set_debug_enabled(). More...

void	set_debug_enabled (bool enabled=true)
	Sets whether the Gdk::GLContext should perform extra validations and run time checking. More...

bool	get_forward_compatible () const
	Retrieves the value set using gdk_gl_context_set_forward_compatible(). More...

void	set_forward_compatible (bool compatible=true)
	Sets whether the Gdk::GLContext should be forward compatible. More...

void	set_use_es (bool use_es=true)
	Requests that GDK create a OpenGL ES context instead of an OpenGL one, if the platform and windowing system allows it. More...

bool	get_use_es () const
	Checks whether the context is using an OpenGL or OpenGL ES profile. More...

bool	realize ()
	Realizes the given Gdk::GLContext. More...

::Cairo::RefPtr< ::Cairo::Region >	get_damage () const
	Returns the part of the backbuffer that is known to be damaged and would need to be redrawn. More...

void	make_current ()
	Makes the context the current one. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< GLContext > >	property_shared_context () const
	The Gdk::GLContext that this context is sharing data with, or #`nullptr` More...

Public Member Functions inherited from Gdk::DrawContext
	DrawContext (DrawContext&& src) noexcept

DrawContext&	operator= (DrawContext&& src) noexcept

	~DrawContext () noexceptoverride

GdkDrawContext*	gobj ()
	Provides access to the underlying C GObject. More...

const GdkDrawContext*	gobj () const
	Provides access to the underlying C GObject. More...

GdkDrawContext*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Glib::RefPtr< Display >	get_display ()
	Retrieves the Gdk::Display the context is created for. More...

Glib::RefPtr< const Display >	get_display () const
	Retrieves the Gdk::Display the context is created for. More...

Glib::RefPtr< Window >	get_window ()
	Retrieves the Gdk::Window used by the context. More...

Glib::RefPtr< const Window >	get_window () const
	Retrieves the Gdk::Window used by the context. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Display > >	property_display () const
	The Gdk::Display used to create the Gdk::DrawContext. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Window > >	property_window () const
	The Gdk::Window the gl context is bound to. More...

Public Member Functions inherited from Glib::Object
	Object (const Object &)=delete

Object &	operator= (const Object &)=delete

	Object (Object &&src) noexcept

Object &	operator= (Object &&src) noexcept

void *	get_data (const QueryQuark &key)

void	set_data (const Quark &key, void *data)

void	set_data (const Quark &key, void *data, DestroyNotify notify)

void	remove_data (const QueryQuark &quark)

void *	steal_data (const QueryQuark &quark)

Glib::RefPtr< Glib::Object >	wrap (GObject *object, bool take_copy=false)

Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete

ObjectBase &	operator= (const ObjectBase &)=delete

void	set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)

void	get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const

void	set_property (const Glib::ustring &property_name, const PropertyType &value)

void	get_property (const Glib::ustring &property_name, PropertyType &value) const

PropertyType	get_property (const Glib::ustring &property_name) const

sigc::connection	connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)

sigc::connection	connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot)

void	freeze_notify ()

void	thaw_notify ()

virtual void	reference () const

virtual void	unreference () const

GObject *	gobj ()

const GObject *	gobj () const

GObject *	gobj_copy () const

Public Member Functions inherited from sigc::trackable
	trackable () noexcept

	trackable (const trackable &src) noexcept

	trackable (trackable &&src)

	~trackable ()

void	add_destroy_notify_callback (void *data, func_destroy_notify func) const

void	notify_callbacks ()

trackable &	operator= (const trackable &src)

trackable &	operator= (trackable &&src)

void	remove_destroy_notify_callback (void *data) const

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr< GLContext >	get_current ()
	Retrieves the current Gdk::GLContext. More...

static void	clear_current ()
	Clears the current Gdk::GLContext. More...

Static Public Member Functions inherited from Gdk::DrawContext
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
	GLContext ()

Protected Member Functions inherited from Gdk::DrawContext
	DrawContext ()
	This constructor is protected because only derived classes shall be instantiated. More...

Protected Member Functions inherited from Glib::Object
	Object ()

	Object (const Glib::ConstructParams &construct_params)

	Object (GObject *castitem)

	~Object () noexceptoverride

Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()

	ObjectBase (const char *custom_type_name)

	ObjectBase (const std::type_info &custom_type_info)

	ObjectBase (ObjectBase &&src) noexcept

ObjectBase &	operator= (ObjectBase &&src) noexcept

virtual	~ObjectBase () noexcept=0

void	initialize (GObject *castitem)

void	initialize_move (GObject castitem, Glib::ObjectBase previous_wrapper)

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gdk::GLContext >	wrap (GdkGLContext* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Gdk::DrawContext
Glib::RefPtr< Gdk::DrawContext >	wrap (GdkDrawContext* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Additional Inherited Members
Public Types inherited from Glib::Object
typedef void(*)(gpointer data	DestroyNotify)

Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify	func_destroy_notify

Detailed Description

A Gdk::GLContext is an OpenGL context abstraction.

It's a low-level object, used to implement high-level objects such as Gtk::GLArea on the GTK+ level.

Since gtkmm 3.18:

Constructor & Destructor Documentation

Gdk::GLContext::GLContext ( GLContext&& src )

noexcept

Gdk::GLContext::~GLContext ( )

overridenoexcept

Gdk::GLContext::GLContext ( )

protected

Member Function Documentation

static void Gdk::GLContext::clear_current ( )

static

Clears the current Gdk::GLContext.

Any OpenGL call after this function returns will be ignored until gdk_gl_context_make_current() is called.

Since gtkmm 3.18:

static Glib::RefPtr<GLContext> Gdk::GLContext::get_current ( )

static

Retrieves the current Gdk::GLContext.

Since gtkmm 3.18:

Returns: The current Gdk::GLContext, or nullptr.

::Cairo::RefPtr< ::Cairo::Region> Gdk::GLContext::get_damage ( ) const

Returns the part of the backbuffer that is known to be damaged and would need to be redrawn.

This is the area that needs to be respected in addition to areas invalidated by GTK or the windowing system itself.

Returns: The damage to the backbuffer.

bool Gdk::GLContext::get_debug_enabled ( ) const

Retrieves the value set using gdk_gl_context_set_debug_enabled().

Since gtkmm 3.18:

Returns: true if debugging is enabled.

Glib::RefPtr<Display> Gdk::GLContext::get_display ( )

Retrieves the Gdk::Display the context is created for.

Since gtkmm 3.18:

Returns: A Gdk::Display or nullptr.

Glib::RefPtr<const Display> Gdk::GLContext::get_display ( ) const

Retrieves the Gdk::Display the context is created for.

Since gtkmm 3.18:

Returns: A Gdk::Display or nullptr.

bool Gdk::GLContext::get_forward_compatible ( ) const

Retrieves the value set using gdk_gl_context_set_forward_compatible().

Since gtkmm 3.18:

Returns: true if the context should be forward compatible.

void Gdk::GLContext::get_required_version	(	int &	major,
		int &	minor
	)		const

Retrieves the major and minor version requested by calling gdk_gl_context_set_required_version().

Since gtkmm 3.18:

Parameters

major	Return location for the major version to request.
minor	Return location for the minor version to request.

Glib::RefPtr<GLContext> Gdk::GLContext::get_shared_context ( )

Retrieves the Gdk::GLContext that this context share data with.

Since gtkmm 3.18:

Returns: A Gdk::GLContext or nullptr.

Glib::RefPtr<const GLContext> Gdk::GLContext::get_shared_context ( ) const

Retrieves the Gdk::GLContext that this context share data with.

Since gtkmm 3.18:

Returns: A Gdk::GLContext or nullptr.

static GType Gdk::GLContext::get_type ( )

static

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

bool Gdk::GLContext::get_use_es ( ) const

Checks whether the context is using an OpenGL or OpenGL ES profile.

Since gtkmm 3.22:

Returns: true if the Gdk::GLContext is using an OpenGL ES profile.

void Gdk::GLContext::get_version	(	int &	major,
		int &	minor
	)		const

Retrieves the OpenGL version of the context.

The context must be realized prior to calling this function.

Since gtkmm 3.18:

Parameters

major	Return location for the major version.
minor	Return location for the minor version.

Glib::RefPtr<Window> Gdk::GLContext::get_window ( )

Retrieves the Gdk::Window used by the context.

Since gtkmm 3.18:

Returns: A Gdk::Window or nullptr.

Glib::RefPtr<const Window> Gdk::GLContext::get_window ( ) const

Retrieves the Gdk::Window used by the context.

Since gtkmm 3.18:

Returns: A Gdk::Window or nullptr.

GdkGLContext* Gdk::GLContext::gobj ( )

inline

Provides access to the underlying C GObject.

const GdkGLContext* Gdk::GLContext::gobj ( ) const

inline

Provides access to the underlying C GObject.

GdkGLContext* Gdk::GLContext::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

bool Gdk::GLContext::is_legacy ( ) const

Whether the Gdk::GLContext is in legacy mode or not.

The Gdk::GLContext must be realized before calling this function.

When realizing a GL context, GDK will try to use the OpenGL 3.2 core profile; this profile removes all the OpenGL API that was deprecated prior to the 3.2 version of the specification. If the realization is successful, this function will return false.

If the underlying OpenGL implementation does not support core profiles, GDK will fall back to a pre-3.2 compatibility profile, and this function will return true.

You can use the value returned by this function to decide which kind of OpenGL API to use, or whether to do extension discovery, or what kind of shader programs to load.

Since gtkmm 3.20:

Returns: true if the GL context is in legacy mode.

void Gdk::GLContext::make_current ( )

Makes the context the current one.

Since gtkmm 3.18:

GLContext& Gdk::GLContext::operator= ( GLContext&& src )

noexcept

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<GLContext> > Gdk::GLContext::property_shared_context ( ) const

The Gdk::GLContext that this context is sharing data with, or #nullptr

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.

bool Gdk::GLContext::realize ( )

Realizes the given Gdk::GLContext.

It is safe to call this function on a realized Gdk::GLContext.

Since gtkmm 3.18:

Returns: true if the context is realized.

void Gdk::GLContext::set_debug_enabled ( bool enabled = true )

Sets whether the Gdk::GLContext should perform extra validations and run time checking.

This is useful during development, but has additional overhead.

The Gdk::GLContext must not be realized or made current prior to calling this function.

Since gtkmm 3.18:

Parameters

enabled Whether to enable debugging in the context.

void Gdk::GLContext::set_forward_compatible ( bool compatible = true )

Sets whether the Gdk::GLContext should be forward compatible.

Forward compatibile contexts must not support OpenGL functionality that has been marked as deprecated in the requested version; non-forward compatible contexts, on the other hand, must support both deprecated and non deprecated functionality.

The Gdk::GLContext must not be realized or made current prior to calling this function.

Since gtkmm 3.18:

Parameters

compatible Whether the context should be forward compatible.

void Gdk::GLContext::set_required_version	(	int	major,
		int	minor
	)

Sets the major and minor version of OpenGL to request.

Setting major and minor to zero will use the default values.

The Gdk::GLContext must not be realized or made current prior to calling this function.

Since gtkmm 3.18:

Parameters

major	The major version to request.
minor	The minor version to request.

void Gdk::GLContext::set_use_es ( bool use_es = true )

Requests that GDK create a OpenGL ES context instead of an OpenGL one, if the platform and windowing system allows it.

The context must not have been realized.

By default, GDK will attempt to automatically detect whether the underlying GL implementation is OpenGL or OpenGL ES once the context is realized.

You should check the return value of gdk_gl_context_get_use_es() after calling gdk_gl_context_realize() to decide whether to use the OpenGL or OpenGL ES API, extensions, or shaders.

Since gtkmm 3.22:

Parameters

use_es Whether the context should use OpenGL ES instead of OpenGL, or -1 to allow auto-detection.

Friends And Related Function Documentation

Glib::RefPtr< Gdk::GLContext > wrap	(	GdkGLContext *	object,
		bool	take_copy = `false`
	)

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

Parameters

object	The C instance.
take_copy	False 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.

gtkmm: Gdk::GLContext Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation