gtkmm 4.4.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gdk::GLContext Class Reference

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

#include <gdkmm/glcontext.h>

Inheritance diagram for Gdk::GLContext:
Inheritance graph
[legend]

Public Member Functions

 GLContext (GLContext&& src) noexcept
 
GLContextoperator= (GLContext&& src) noexcept
 
 ~GLContext () noexcept override
 
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< Displayget_display ()
 Retrieves the display the context is created for. More...
 
Glib::RefPtr< const Displayget_display () const
 Retrieves the display the context is created for. More...
 
Glib::RefPtr< Surfaceget_surface ()
 Retrieves the surface used by the context. More...
 
Glib::RefPtr< const Surfaceget_surface () const
 Retrieves the surface used by the context. More...
 
Glib::RefPtr< GLContextget_shared_context ()
 Used to retrieves the GdkGLContext that this context share data with. More...
 
Glib::RefPtr< const GLContextget_shared_context () const
 Used to retrieves the GdkGLContext 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 GdkGLContext is in legacy mode or not. More...
 
bool is_shared (const Glib::RefPtr< const GLContext >& other) const
 Checks if the two GL contexts can share resources. More...
 
void get_required_version (int& major, int& minor) const
 Retrieves required OpenGL 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 whether the context is doing extra validations and runtime checking. More...
 
void set_debug_enabled (bool enabled=true)
 Sets whether the GdkGLContext should perform extra validations and runtime checking. More...
 
bool get_forward_compatible () const
 Retrieves whether the context is forward-compatible. More...
 
void set_forward_compatible (bool compatible=true)
 Sets whether the GdkGLContext should be forward-compatible. More...
 
void set_use_es (bool use_es=true)
 Requests that GDK create an OpenGL ES context instead of an OpenGL one, if the platform and windowing system allows it. More...
 
void unset_use_es ()
 Undo a previous call to set_use_es(). More...
 
bool get_use_es () const
 Checks whether the context is using an OpenGL or OpenGL ES profile. More...
 
bool realize ()
 Realizes the given GdkGLContext. More...
 
void make_current ()
 Makes the context the current one. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< GLContext > > property_shared_context () const
 Always nullptr More...
 
- Public Member Functions inherited from Gdk::DrawContext
 DrawContext (DrawContext&& src) noexcept
 
DrawContextoperator= (DrawContext&& src) noexcept
 
 ~DrawContext () noexcept override
 
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< Displayget_display ()
 Retrieves the GdkDisplay the context is created for. More...
 
Glib::RefPtr< const Displayget_display () const
 Retrieves the GdkDisplay the context is created for. More...
 
Glib::RefPtr< Surfaceget_surface ()
 Retrieves the surface that context is bound to. More...
 
Glib::RefPtr< const Surfaceget_surface () const
 Retrieves the surface that context is bound to. More...
 
void begin_frame (const ::Cairo::RefPtr< const ::Cairo::Region >& region)
 Indicates that you are beginning the process of redrawing region on the context's surface. More...
 
void end_frame ()
 Ends a drawing operation started with begin_frame(). More...
 
bool is_in_frame () const
 Returns true if context is in the process of drawing to its surface. More...
 
::Cairo::RefPtr< const ::Cairo::Regionget_frame_region () const
 Retrieves the region that is currently being repainted. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Display > > property_display () const
 The GdkDisplay used to create the GdkDrawContext. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Surface > > property_surface () const
 The GdkSurface the context is bound to. More...
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (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::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (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
 

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< GLContextget_current ()
 Retrieves the current GdkGLContext. More...
 
static void clear_current ()
 Clears the current GdkGLContext. 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 () noexcept override
 
- 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
 
ObjectBaseoperator= (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::GLContextwrap (GdkGLContext* 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)
 

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

◆ GLContext() [1/2]

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

◆ ~GLContext()

Gdk::GLContext::~GLContext ( )
overridenoexcept

◆ GLContext() [2/2]

Gdk::GLContext::GLContext ( )
protected

Member Function Documentation

◆ clear_current()

static void Gdk::GLContext::clear_current ( )
static

Clears the current GdkGLContext.

Any OpenGL call after this function returns will be ignored until [method Gdk.GLContext.make_current] is called.

Since gtkmm 3.18:

◆ get_current()

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

Retrieves the current GdkGLContext.

Since gtkmm 3.18:
Returns
The current GdkGLContext.

◆ get_debug_enabled()

bool Gdk::GLContext::get_debug_enabled ( ) const

Retrieves whether the context is doing extra validations and runtime checking.

See [method Gdk.GLContext.set_debug_enabled].

Since gtkmm 3.18:
Returns
true if debugging is enabled.

◆ get_display() [1/2]

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

Retrieves the display the context is created for.

Since gtkmm 3.18:
Returns
A GdkDisplay.

◆ get_display() [2/2]

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

Retrieves the display the context is created for.

Since gtkmm 3.18:
Returns
A GdkDisplay.

◆ get_forward_compatible()

bool Gdk::GLContext::get_forward_compatible ( ) const

Retrieves whether the context is forward-compatible.

See [method Gdk.GLContext.set_forward_compatible].

Since gtkmm 3.18:
Returns
true if the context should be forward-compatible.

◆ get_required_version()

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

Retrieves required OpenGL version.

See [method Gdk.GLContext.set_required_version].

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

◆ get_shared_context() [1/2]

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

Used to retrieves the GdkGLContext that this context share data with.

As many contexts can share data now and no single shared context exists anymore, this function has been deprecated and now always returns nullptr.

Deprecated: 4.4: Use [method Gdk.GLContext.is_shared] to check if contexts can be shared.

Since gtkmm 3.18:
Deprecated:
Always returns an empty RefPtr.
Returns
nullptr.

◆ get_shared_context() [2/2]

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

Used to retrieves the GdkGLContext that this context share data with.

As many contexts can share data now and no single shared context exists anymore, this function has been deprecated and now always returns nullptr.

Deprecated: 4.4: Use [method Gdk.GLContext.is_shared] to check if contexts can be shared.

Since gtkmm 3.18:
Deprecated:
Always returns an empty RefPtr.
Returns
nullptr.

◆ get_surface() [1/2]

Glib::RefPtr< Surface > Gdk::GLContext::get_surface ( )

Retrieves the surface used by the context.

Since gtkmm 3.18:
Returns
A GdkSurface.

◆ get_surface() [2/2]

Glib::RefPtr< const Surface > Gdk::GLContext::get_surface ( ) const

Retrieves the surface used by the context.

Since gtkmm 3.18:
Returns
A GdkSurface.

◆ get_type()

static GType Gdk::GLContext::get_type ( )
static

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

◆ get_use_es()

bool Gdk::GLContext::get_use_es ( ) const

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

Returns
true if the GdkGLContext is using an OpenGL ES profile.

◆ get_version()

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
majorReturn location for the major version.
minorReturn location for the minor version.

◆ gobj() [1/2]

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

Provides access to the underlying C GObject.

◆ gobj() [2/2]

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

Provides access to the underlying C GObject.

◆ gobj_copy()

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.

◆ is_legacy()

bool Gdk::GLContext::is_legacy ( ) const

Whether the GdkGLContext is in legacy mode or not.

The GdkGLContext 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.

Returns
true if the GL context is in legacy mode.

◆ is_shared()

bool Gdk::GLContext::is_shared ( const Glib::RefPtr< const GLContext >&  other) const

Checks if the two GL contexts can share resources.

When they can, the texture IDs from other can be used in self. This is particularly useful when passing GdkGLTexture objects between different contexts.

Contexts created for the same display with the same properties will always be compatible, even if they are created for different surfaces. For other contexts it depends on the GL backend.

Both contexts must be realized for this check to succeed. If either one is not, this function will return false.

Since gtkmm 4.4:
Parameters
otherThe GdkGLContext that should be compatible with self.
Returns
true if the two GL contexts are compatible.

◆ make_current()

void Gdk::GLContext::make_current ( )

Makes the context the current one.

Since gtkmm 3.18:

◆ operator=()

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

◆ property_shared_context()

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

Always nullptr

As many contexts can share data now and no single shared context exists anymore, this function has been deprecated and now always returns nullptr.

Deprecated: 4.4: Use [method Gdk.GLContext.is_shared] to check if contexts can be shared.

Since gtkmm 3.18:
Deprecated:
Always returns an empty RefPtr. Use is_shared() to check if contexts can be shared.
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ realize()

bool Gdk::GLContext::realize ( )

Realizes the given GdkGLContext.

It is safe to call this function on a realized GdkGLContext.

Since gtkmm 3.18:
Returns
true if the context is realized.
Exceptions
Glib::Error

◆ set_debug_enabled()

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

Sets whether the GdkGLContext should perform extra validations and runtime checking.

This is useful during development, but has additional overhead.

The GdkGLContext must not be realized or made current prior to calling this function.

Since gtkmm 3.18:
Parameters
enabledWhether to enable debugging in the context.

◆ set_forward_compatible()

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

Sets whether the GdkGLContext should be forward-compatible.

Forward-compatible 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 GdkGLContext must not be realized or made current prior to calling this function.

Since gtkmm 3.18:
Parameters
compatibleWhether the context should be forward-compatible.

◆ set_required_version()

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 GdkGLContext must not be realized or made current prior to calling this function.

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

◆ set_use_es()

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

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

The GLContext 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 GLContext is realized.

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

Since gtkmm 3.22:
Parameters
use_esWhether the context should use OpenGL ES instead of OpenGL.

◆ unset_use_es()

void Gdk::GLContext::unset_use_es ( )

Undo a previous call to set_use_es().

GDK will attempt to automatically detect whether the underlying GL implementation is OpenGL or OpenGL ES once the GLContext is realized.

Since gtkmm 3.24:

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gdk::GLContext > wrap ( GdkGLContext *  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.