QOpenGLContext Class

https:// can be moved to a different thread with https://(). Do not call https://() from a different thread than the one to which the https:// object belongs. A context can only be current in one thread and against one surface at a time, and a thread only has one context current at a time.

Resources such as textures and vertex buffer objects can be shared between contexts. Use https://() before calling https://() to specify that the contexts should share these resources. https:// internally keeps track of a https:// object which can be accessed with https://(), and which can be used to find all the contexts in a given share group. A share group consists of all contexts that have been successfully initialized and are sharing with an existing context in the share group. A non-sharing context has a share group consisting of a single context.

On certain platforms, a framebuffer other than 0 might be the default frame buffer depending on the current surface. Instead of calling glBindFramebuffer(0), it is recommended that you use glBindFramebuffer(ctx->https://()), to ensure that your application is portable between different platforms. However, if you use https://(), this is done automatically for you.

See also https://, QOpenGLBuffer, QOpenGLShaderProgram, QOpenGLFramebufferObject

This enum defines the type of the underlying OpenGL implementation.

This enum was introduced or modified in Qt 5.3.

Creates a new OpenGL context instance with parent object parent.

Before it can be used you need to set the proper format and call https://().

See Also▲

Destroys the https:// object.

If this is the current context for the thread, https://() is also called.

This signal is emitted before the underlying native OpenGL context is destroyed, such that users may clean up OpenGL resources that might otherwise be left dangling in the case of shared OpenGL contexts.

If you wish to make the context current in order to do clean-up, make sure to only connect to the signal using a direct connection.

Returns true if the first and second contexts are sharing OpenGL resources.

Attempts to create the OpenGL context with the current configuration.

The current configuration includes the format, the share context, and the screen.

If the OpenGL implementation on your system does not support the requested version of OpenGL context, then https:// will try to create the closest matching version. The actual created context properties can be queried using the https:// returned by the https://() function. For example, if you request a context that supports OpenGL 4.3 Core profile but the driver and/or hardware only supports version 3.2 Core profile contexts then you will get a 3.2 Core profile context.

Returns true if the native context was successfully created and is ready to be used with https://(), https://(), etc.

See Also▲

Returns the last context which called https:// in the current thread, or nullptr, if no context is current.

Call this to get the default framebuffer object for the current surface.

On some platforms (for instance, iOS) the default framebuffer object depends on the surface being rendered to, and might be different from 0. Thus, instead of calling glBindFramebuffer(0), you should call glBindFramebuffer(ctx->defaultFramebufferObject()) if you want your application to work across different Qt platforms.

If you use the glBindFramebuffer() in https:// you do not have to worry about this, as it automatically binds the current context's defaultFramebufferObject() when 0 is passed.

See Also▲

Convenience function for calling https:// with a 0 surface.

This results in no context being current in the current thread.

See Also▲

Returns the set of OpenGL extensions supported by this context.

The context or a sharing context must be current.

See Also▲

Get the https:// instance for this context.

https:// offers this as a convenient way to access https:// without having to manage it manually.

The context or a sharing context must be current.

The returned https:// instance is ready to be used and it does not need initializeOpenGLFunctions() to be called.

See Also▲

Returns the format of the underlying platform context, if https://() has been called.

Otherwise, returns the requested format.

The requested and the actual format may differ. Requesting a given OpenGL version does not mean the resulting context will target exactly the requested version. It is only guaranteed that the version/profile/options combination for the created context is compatible with the request, as long as the driver is able to provide such a context.

For example, requesting an OpenGL version 3.x core profile context may result in an OpenGL 4.x core profile context. Similarly, a request for OpenGL 2.1 may result in an OpenGL 3.0 context with deprecated functions enabled. Finally, depending on the driver, unsupported versions may result in either a context creation failure or in a context for the highest supported version.

Similar differences are possible in the buffer sizes, for example, the resulting context may have a larger depth buffer than requested. This is perfectly normal.

See Also▲

Get the https:// instance for this context.

https:// offers this as a convenient way to access https:// without having to manage it manually.

The context or a sharing context must be current.

The returned https:// instance is ready to be used and it does not need initializeOpenGLFunctions() to be called.

Resolves the function pointer to an OpenGL extension function, identified by procName

Returns nullptr if no such function can be found.

This is an overloaded function.

This function was introduced in Qt 5.8.

Returns the application-wide shared OpenGL context, if present. Otherwise, returns nullptr.

This is useful if you need to upload OpenGL objects (buffers, textures, etc.) before creating or showing a QOpenGLWidget or QQuickWidget.

This function was introduced in Qt 5.5.

See Also▲

Returns true if this OpenGL context supports the specified OpenGL extension, false otherwise.

The context or a sharing context must be current.

See Also▲

Returns true if the context is an OpenGL ES context.

If the context has not yet been created, the result is based on the requested format set via https://().

This function was introduced in Qt 5.3.

See Also▲

Returns if this context is valid, i.e. has been successfully created.

On some platforms the return value of false for a context that was successfully created previously indicates that the OpenGL context was lost.

The typical way to handle context loss scenarios in applications is to check via this function whenever https://() fails and returns false. If this function then returns false, recreate the underlying native OpenGL context by calling https://(), call https://() again and then reinitialize all OpenGL resources.

On some platforms context loss situations is not something that can avoided. On others however, they may need to be opted-in to. This can be done by enabling https:// in the https://. This will lead to setting RESET_NOTIFICATION_STRATEGY_EXT to LOSE_CONTEXT_ON_RESET_EXT in the underlying native OpenGL context. https:// will then monitor the status via glGetGraphicsResetStatusEXT() in every https://().

See Also▲

Makes the context current in the current thread, against the given surface. Returns true if successful; otherwise returns false. The latter may happen if the surface is not exposed, or the graphics hardware is not available due to e.g. the application being suspended.

If surface is nullptr this is equivalent to calling https://().

Avoid calling this function from a different thread than the one the https:// instance lives in. If you wish to use https:// from a different thread you should first make sure it's not current in the current thread, by calling https://() if necessary. Then call moveToThread(otherThread) before using it in the other thread.

By default Qt employs a check that enforces the above condition on the thread affinity. It is still possible to disable this check by setting the Qt::AA_DontCheckOpenGLContextThreadAffinity application attribute. Be sure to understand the consequences of using QObjects from outside the thread they live in, as explained in the https:// documentation.

See Also▲

Returns a native interface of the given type for the context.

This function provides access to platform specific functionality of https://, as defined in the https:// namespace:

• https://: Native interface to an NSOpenGLContext on macOS.

• https://: Native interface to an EGL context.

• https://: Native interface to a GLX context.

• https://: Native interface to a WGL context on Windows.

If the requested interface is not available a nullptr is returned.

Returns the underlying OpenGL implementation type.

On platforms where the OpenGL implementation is not dynamically loaded, the return value is determined during compile time and never changes.

This function was introduced in Qt 5.3.

Returns the screen the context was created for.

See Also▲

Sets the format the OpenGL context should be compatible with. You need to call https://() before it takes effect.

When the format is not explicitly set via this function, the format returned by https://() will be used. This means that when having multiple contexts, individual calls to this function can be replaced by one single call to https://() before creating the first context.

See Also▲

Sets the screen the OpenGL context should be valid for. You need to call https://() before it takes effect.

See Also▲

Makes this context share textures, shaders, and other OpenGL resources with shareContext. You need to call https://() before it takes effect.

See Also▲

Returns the share context this context was created with.

If the underlying platform was not able to support the requested sharing, this will return 0.

See Also▲

Returns the share group this context belongs to.

Returns true if the platform supports OpenGL rendering outside the main (gui) thread.

The value is controlled by the platform plugin in use and may also depend on the graphics drivers.

This function was introduced in Qt 5.5.

Returns the surface the context has been made current with.

This is the surface passed as an argument to https://().

Swap the back and front buffers of surface.

Call this to finish a frame of OpenGL rendering, and make sure to call https://() again before issuing any further OpenGL commands, for example as part of a new frame.