QOpenGLContext Class

成员函数文档

[explicit] QOpenGLContext::QOpenGLContext(QObject *parent = nullptr)

创建一个新的 OpenGL 上下文实例，其父对象为parent 。

在使用之前，您需要设置适当的格式并调用create().

另请参阅 create() 和makeCurrent()。

[virtual noexcept] QOpenGLContext::~QOpenGLContext()

销毁QOpenGLContext 对象。

如果这是线程的当前上下文，doneCurrent() 也会被调用。

[signal] void QOpenGLContext::aboutToBeDestroyed()

该信号在底层本地 OpenGL 上下文销毁之前发出，这样用户就可以清理 OpenGL 资源，否则在共享 OpenGL 上下文的情况下，这些资源可能会被闲置。

如果您希望使上下文处于当前状态以便进行清理，请确保只使用直接连接来连接该信号。

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

如果first 和second 上下文共享 OpenGL 资源，则返回true 。

bool QOpenGLContext::create()

尝试使用当前配置创建 OpenGL 上下文。

当前配置包括格式、共享上下文和屏幕。

如果系统上的 OpenGL 实现不支持所请求的 OpenGL 上下文版本，那么QOpenGLContext 将尝试创建最匹配的版本。实际创建的上下文属性可使用format() 函数返回的QSurfaceFormat 进行查询。例如，如果您请求的上下文支持 OpenGL 4.3 核心配置文件，但驱动程序和/或硬件只支持 3.2 版本的核心配置文件上下文，那么您将得到一个 3.2 核心配置文件上下文。

如果本机上下文已成功创建，并可与makeCurrent(),swapBuffers() 等一起使用，则返回true 。

另请参阅 makeCurrent() 和format()。

[static] QOpenGLContext *QOpenGLContext::currentContext()

返回当前线程中最后一次调用makeCurrent 的上下文；如果当前没有上下文，则返回nullptr 。

GLuint QOpenGLContext::defaultFramebufferObject() const

调用该命令可获取当前表面的默认帧缓冲对象。

在某些平台（如 iOS）上，默认帧缓冲对象取决于渲染的表面，可能与 0 不同。因此，如果您希望应用程序在不同的 Qt 平台上运行，则应调用 glBindFramebuffer(ctx->defaultFramebufferObject())，而不是调用 glBindFramebuffer(0)。

如果在QOpenGLFunctions 中使用 glBindFramebuffer()，则不必担心这个问题，因为当传递 0 时，它会自动绑定当前上下文的 defaultFramebufferObject()。

另请参见 QOpenGLFramebufferObject 。

void QOpenGLContext::doneCurrent()

方便函数，用于调用表面值为 0 的makeCurrent 。

这将导致当前线程中没有上下文。

另请参阅 makeCurrent() 和currentContext() 。

QSet<QByteArray> QOpenGLContext::extensions() const

返回此上下文支持的 OpenGL 扩展集。

上下文或共享上下文必须是当前的。

另请参阅 hasExtension()。

QOpenGLExtraFunctions *QOpenGLContext::extraFunctions() const

获取此上下文的QOpenGLExtraFunctions 实例。

QOpenGLContext 这是访问 的便捷方法，无需手动管理。QOpenGLExtraFunctions

上下文或共享上下文必须是当前的。

返回的QOpenGLExtraFunctions 实例可随时使用，无需调用 initializeOpenGLFunctions()。

另请参见 QOpenGLFunctions 和QOpenGLExtraFunctions 。

QSurfaceFormat QOpenGLContext::format() const

如果调用了create() ，则返回底层平台上下文的格式。

否则，返回请求的格式。

请求的格式和实际格式可能不同。请求给定的 OpenGL 版本并不意味着生成的上下文将完全以请求的版本为目标。只要驱动程序能够提供这样的上下文，就只能保证创建的上下文的版本/配置文件/选项组合与请求兼容。

例如，请求一个 OpenGL 3.x 版本的核心配置文件上下文，可能会得到一个 OpenGL 4.x 核心配置文件上下文。同样，请求 OpenGL 2.1 可能会得到启用了过时功能的 OpenGL 3.0 上下文。最后，根据驱动程序的不同，不支持的版本可能会导致上下文创建失败，或导致最高支持版本的上下文。

缓冲区大小也可能存在类似差异，例如，生成的上下文可能比请求的深度缓冲区更大。这完全正常。

另请参见 setFormat().

QOpenGLFunctions *QOpenGLContext::functions() const

获取此上下文的QOpenGLFunctions 实例。

QOpenGLContext 这是访问 的便捷方法，无需手动管理。QOpenGLFunctions

上下文或共享上下文必须是当前的。

返回的QOpenGLFunctions 实例可随时使用，无需调用 initializeOpenGLFunctions()。

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

解析指向 OpenGL 扩展函数的函数指针，该函数由procName

如果找不到该函数，则返回nullptr 。

QFunctionPointer QOpenGLContext::getProcAddress(const char *procName) const

这是一个重载函数。

[static] QOpenGLContext *QOpenGLContext::globalShareContext()

如果存在，则返回整个应用程序的 OpenGL 共享上下文。否则将返回nullptr 。

如果您需要在创建或显示QOpenGLWidget 或QQuickWidget 之前上传 OpenGL 对象（缓冲区、纹理等），这将非常有用。

另请参阅 Qt::AA_ShareOpenGLContexts 、setShareContext() 和makeCurrent()。

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

如果此 OpenGL 上下文支持指定的 OpenGLextension ，则返回true ，否则返回false 。

上下文或共享上下文必须是当前的。

另请参阅 extensions().

bool QOpenGLContext::isOpenGLES() const

如果上下文是 OpenGL ES 上下文，则返回 true。

如果上下文尚未创建，结果将基于通过setFormat() 设置的请求格式。

另请参阅 create(),format() 和setFormat().

bool QOpenGLContext::isValid() const

返回该上下文是否有效，即是否已成功创建。

在某些平台上，如果先前成功创建的上下文返回值为false ，则表示 OpenGL 上下文已丢失。

在应用程序中处理上下文丢失情况的典型方法是，每当makeCurrent() 失败并返回false 时，通过此函数进行检查。如果该函数返回false ，则通过调用create() 重新创建底层本地 OpenGL 上下文，然后再次调用makeCurrent() 并重新初始化所有 OpenGL 资源。

在某些平台上，上下文丢失的情况是无法避免的。但在其他平台上，可能需要选择加入。这可以通过在QSurfaceFormat 中启用ResetNotification 来实现。这将导致在底层本地 OpenGL 上下文中将RESET_NOTIFICATION_STRATEGY_EXT 设置为LOSE_CONTEXT_ON_RESET_EXT 。然后，QOpenGLContext 将通过glGetGraphicsResetStatusEXT() 在每个makeCurrent() 中监控状态。

另请参阅 create() 。

bool QOpenGLContext::makeCurrent(QSurface *surface)

使当前线程中的上下文与给定的surface 一致。如果成功，则返回true ；否则返回false 。如果曲面未暴露，或由于应用程序暂停等原因导致图形硬件不可用，则可能出现后一种情况。

如果surface 是nullptr ，则相当于调用doneCurrent() 。

请避免在与QOpenGLContext 实例所在线程不同的线程中调用此函数。如果希望在不同的线程中使用QOpenGLContext ，应首先确保它不在当前线程中，必要时可调用doneCurrent() 。然后调用 moveToThread(otherThread) 才能在其他线程中使用。

默认情况下，Qt 会对线程亲和性进行检查，以执行上述条件。仍可通过设置Qt::AA_DontCheckOpenGLContextThreadAffinity 应用程序属性来禁用该检查。请务必了解从所处线程之外使用 QObjects 的后果，如QObject thread affinity 文档中所述。

另请参阅 functions(),doneCurrent() 和Qt::AA_DontCheckOpenGLContextThreadAffinity 。

template <typename QNativeInterface> QNativeInterface *QOpenGLContext::nativeInterface() const

返回上下文中给定类型的本地接口。

该函数提供了对QOpenGLContext 平台特定功能的访问，这些功能在QNativeInterface 命名空间中定义：

如果请求的接口不可用，将返回nullptr 。

[static] QOpenGLContext::OpenGLModuleType QOpenGLContext::openGLModuleType()

返回底层 OpenGL 实现类型。

在未动态加载 OpenGL 实现的平台上，返回值在编译时确定，不会更改。

QScreen *QOpenGLContext::screen() const

返回创建上下文的屏幕。

另请参阅 setScreen()。

void QOpenGLContext::setFormat(const QSurfaceFormat &format)

设置 OpenGL 上下文应兼容的format 。需要调用create() 才能生效。

如果未通过此函数明确设置格式，则将使用QSurfaceFormat::defaultFormat() 返回的格式。这就意味着，当有多个上下文时，可以在创建第一个上下文之前调用一次QSurfaceFormat::setDefaultFormat() 来代替对该函数的单独调用。

另请参见 format()。

void QOpenGLContext::setScreen(QScreen *screen)

设置 OpenGL 上下文的有效期screen 。需要调用create() 才能生效。

另请参阅 screen().

void QOpenGLContext::setShareContext(QOpenGLContext *shareContext)

使该上下文与shareContext 共享纹理、着色器和其他 OpenGL 资源。需要调用create() 才能生效。

另请参阅 shareContext() 。

QOpenGLContext *QOpenGLContext::shareContext() const

返回此上下文创建时的共享上下文。

如果底层平台不支持所请求的共享，则返回 0。

另请参阅 setShareContext()。

QOpenGLContextGroup *QOpenGLContext::shareGroup() const

返回此上下文所属的共享组。

[static] bool QOpenGLContext::supportsThreadedOpenGL()

如果平台支持主（gui）线程外的 OpenGL 渲染，则返回true 。

该值由所使用的平台插件控制，也可能取决于图形驱动程序。

QSurface *QOpenGLContext::surface() const

返回上下文当前使用的曲面。

这是作为makeCurrent() 的参数传递的曲面。

void QOpenGLContext::swapBuffers(QSurface *surface)

交换surface 的前后缓冲区。

调用该命令完成一帧 OpenGL 渲染，并确保在发出任何其他 OpenGL 命令（例如作为新帧的一部分）之前再次调用makeCurrent() 。