Member Function Documentation

QOpenGLContext::​QOpenGLContext(QObject * parent = 0)

Creates a new OpenGL context instance with parent object parent.

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

See also create() and makeCurrent().

QOpenGLContext::​~QOpenGLContext()

Destroys the QOpenGLContext object.

This implicitly calls destroy(), so if this is the current context for the thread, doneCurrent() is also called.

See also destroy().

[signal] void QOpenGLContext::​aboutToBeDestroyed()

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.

[static] bool QOpenGLContext::​areSharing(QOpenGLContext * first, QOpenGLContext * second)

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

bool QOpenGLContext::​create()

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 QOpenGLContext will try to create the closest matching version. The actual created context properties can be queried using the QSurfaceFormat returned by the format() 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 makeCurrent(), swapBuffers(), etc.

Note: If the context is already created, this function will first call destroy(), and then create a new OpenGL context.

See also makeCurrent(), destroy(), and format().

[static] QOpenGLContext * QOpenGLContext::​currentContext()

Returns the last context which called makeCurrent in the current thread, or 0, if no context is current.

GLuint QOpenGLContext::​defaultFramebufferObject() const

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

On some platforms 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 QOpenGLFunctions you do not have to worry about this, as it automatically binds the current context's defaultFramebufferObject() when 0 is passed.

void QOpenGLContext::​doneCurrent()

Convenience function for calling makeCurrent with a 0 surface.

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

See also makeCurrent() and currentContext().

QSet<QByteArray> QOpenGLContext::​extensions() const

Returns the set of OpenGL extensions supported by this context.

The context or a sharing context must be current.

See also hasExtension().

QSurfaceFormat QOpenGLContext::​format() const

Returns the format of the underlying platform context, if create() 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 setFormat().

QOpenGLFunctions * QOpenGLContext::​functions() const

Get the QOpenGLFunctions instance for this context.

QOpenGLContext offers this as a convenient way to access QOpenGLFunctions without having to manage it manually.

The context or a sharing context must be current.

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

QFunctionPointer QOpenGLContext::​getProcAddress(const QByteArray & procName) const

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

Returns 0 if no such function can be found.

bool QOpenGLContext::​hasExtension(const QByteArray & extension) const

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

The context or a sharing context must be current.

See also extensions().

bool QOpenGLContext::​isOpenGLES() const

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 setFormat().

This function was introduced in Qt 5.3.

See also create(), format(), and setFormat().

bool QOpenGLContext::​isValid() const

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

See also create().

bool QOpenGLContext::​makeCurrent(QSurface * surface)

Makes the context current in the current thread, against the given surface. Returns true if successful.

If surface is 0 this is equivalent to calling doneCurrent().

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

See also functions() and doneCurrent().

QVariant QOpenGLContext::​nativeHandle() const

Returns the native handle for the context.

This function provides access to the QOpenGLContext's underlying native context. The returned variant contains a platform-specific value type. These classes can be found in the module QtPlatformHeaders.

On platforms where retrieving the native handle is not supported, or if neither create() nor setNativeHandle() was called, a null variant is returned.

This function was introduced in Qt 5.4.

See also setNativeHandle().

[static] void * QOpenGLContext::​openGLModuleHandle()

Returns the platform-specific handle for the OpenGL implementation that is currently in use. (for example, a HMODULE on Windows)

On platforms that do not use dynamic GL switch the return value is null.

The library might be GL-only, meaning that windowing system interface functions (for example EGL) may live in another, separate library.

Note: This function requires that the QGuiApplication instance is already created.

This function was introduced in Qt 5.3.

See also openGLModuleType().

[static] OpenGLModuleType QOpenGLContext::​openGLModuleType()

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.

Note: A desktop OpenGL implementation may be capable of creating ES-compatible contexts too. Therefore in most cases it is more appropriate to check QSurfaceFormat::renderableType() or using the the convenience function isOpenGLES().

Note: This function requires that the QGuiApplication instance is already created.

This function was introduced in Qt 5.3.

QScreen * QOpenGLContext::​screen() const

Returns the screen the context was created for.

See also setScreen().

void QOpenGLContext::​setFormat(const QSurfaceFormat & format)

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

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

See also format().

void QOpenGLContext::​setNativeHandle(const QVariant & handle)

Set the native handles for this context. When create() is called and a native handle is set, configuration settings, like format(), are ignored since this QOpenGLContext will wrap an already created native context instead of creating a new one from scratch.

On some platforms the native context handle is not sufficient and other related handles (for example, for a window or display) have to be provided in addition. Therefore handle is variant containing a platform-specific value type. These classes can be found in the QtPlatformHeaders module.

When create() is called with native handles set, the handles' ownership are not taken, meaning that destroy() will not destroy the native context.

Note: Some frameworks track the current context and surfaces internally. Making the adopted QOpenGLContext current via Qt will have no effect on such other frameworks' internal state. Therefore a subsequent makeCurrent done via the other framework may have no effect. It is therefore advisable to make explicit calls to make no context and surface current to reset the other frameworks' internal state after performing OpenGL operations via Qt.

Note: Using foreign contexts with Qt windows and Qt contexts with windows and surfaces created by other frameworks may give unexpected results, depending on the platform, due to potential mismatches in context and window pixel formats. To make sure this does not happen, avoid making contexts and surfaces from different frameworks current together. Instead, prefer approaches based on context sharing where OpenGL resources like textures are accessible both from Qt's and the foreign framework's contexts.

This function was introduced in Qt 5.4.

See also nativeHandle().

void QOpenGLContext::​setScreen(QScreen * screen)

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

See also screen().

void QOpenGLContext::​setShareContext(QOpenGLContext * shareContext)

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

See also shareContext().

QOpenGLContext * QOpenGLContext::​shareContext() const

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 setShareContext().

QOpenGLContextGroup * QOpenGLContext::​shareGroup() const

Returns the share group this context belongs to.

QSurface * QOpenGLContext::​surface() const

Returns the surface the context has been made current with.

This is the surface passed as an argument to makeCurrent().

void QOpenGLContext::​swapBuffers(QSurface * surface)

Swap the back and front buffers of surface.

Call this to finish a frame of OpenGL rendering, and make sure to call makeCurrent() again before you begin a new frame.

QAbstractOpenGLFunctions * QOpenGLContext::​versionFunctions(const QOpenGLVersionProfile & versionProfile = QOpenGLVersionProfile()) const

Returns a pointer to an object that provides access to all functions for the versionProfile of this context. Before using any of the functions they must be initialized by calling QAbstractOpenGLFunctions::initializeOpenGLFunctions() with this context being the current context.

Usually one would use the template version of this function to automatically have the result cast to the correct type.

TYPE * QOpenGLContext::​versionFunctions() const

This function overloads versionFunctions().

Returns a pointer to an object that provides access to all functions for the version and profile of this context. Before using any of the functions they must be initialized by calling QAbstractOpenGLFunctions::initializeOpenGLFunctions() with this context being the current context.

Usually one would use the template version of this function to automatically have the result cast to the correct type.

QOpenGLFunctions_3_3_Core* funcs = 0;
funcs = context->versionFunctions<QOpenGLFunctions_3_3_Core>();
if (!funcs) {
    qWarning() << "Could not obtain required OpenGL context version";
    exit(1);
}
funcs->initializeOpenGLFunctions();

It is possible to request a functions object for a different version and profile than that for which the context was created. To do this either use the template version of this function specifying the desired functions object type as the template parameter or by passing in a QOpenGLVersionProfile object as an argument to the non-template function.

Note that requests for function objects of other versions or profiles can fail and in doing so will return a null pointer. Situations in which creation of the functions object can fail are if the request cannot be satisfied due to asking for functions that are not in the version or profile of this context. For example:

• Requesting a 3.3 core profile functions object would succeed.
• Requesting a 3.3 compatibility profile functions object would fail. We would fail to resolve the deprecated functions.
• Requesting a 4.3 core profile functions object would fail. We would fail to resolve the new core functions introduced in versions 4.0-4.3.
• Requesting a 3.1 functions object would succeed. There is nothing in 3.1 that is not also in 3.3 core.

Note that if creating a functions object via this method that the QOpenGLContext retains ownership of the object. This is to allow the object to be cached and shared.