QSurfaceFormat Class

成员函数文档

QSurfaceFormat::QSurfaceFormat()

构建一个已进行默认初始化的 QSurfaceFormat。

QSurfaceFormat::QSurfaceFormat(QSurfaceFormat::FormatOptions options)

根据给定的格式 `options` 创建一个 `QSurfaceFormat` 对象。

QSurfaceFormat::QSurfaceFormat(const QSurfaceFormat &other)

创建other 的副本。

[noexcept] QSurfaceFormat::~QSurfaceFormat()

销毁QSurfaceFormat 。

int QSurfaceFormat::alphaBufferSize() const

获取颜色缓冲区中Alpha通道的位数。

另请参阅 setAlphaBufferSize()。

int QSurfaceFormat::blueBufferSize() const

获取颜色缓冲区中蓝色通道的位数。

另请参阅 setBlueBufferSize()。

const QColorSpace &QSurfaceFormat::colorSpace() const

返回颜色空间。

另请参阅 setColorSpace()。

[static] QSurfaceFormat QSurfaceFormat::defaultFormat()

返回全局默认表面格式。

当未调用setDefaultFormat()时，该对象为通过默认构造函数构造的QSurfaceFormat 。

另请参阅 setDefaultFormat()。

int QSurfaceFormat::depthBufferSize() const

返回深度缓冲区的大小。

另请参阅 setDepthBufferSize()。

int QSurfaceFormat::greenBufferSize() const

获取颜色缓冲区中绿色通道的位数。

另请参阅 setGreenBufferSize()。

bool QSurfaceFormat::hasAlpha() const

如果透明度缓冲区大小大于零，则返回true 。

这意味着该曲面可用于实现按像素计算的半透明效果。

int QSurfaceFormat::majorVersion() const

返回 OpenGL 的主版本号。

默认版本为 2.0。

另请参阅 setMajorVersion()。

int QSurfaceFormat::minorVersion() const

返回 OpenGL 的次版本号。

另请参阅 setMinorVersion()。

QSurfaceFormat::FormatOptions QSurfaceFormat::options() const

返回当前设置的格式选项。

另请参阅 setOption()、setOptions() 和testOption()。

QSurfaceFormat::OpenGLContextProfile QSurfaceFormat::profile() const

获取已配置的 OpenGL 上下文配置文件。

如果请求的 OpenGL 版本低于 3.2，则此设置将被忽略。

另请参阅 setProfile()。

int QSurfaceFormat::redBufferSize() const

获取颜色缓冲区中红色通道的位数。

另请参阅 setRedBufferSize()。

QSurfaceFormat::RenderableType QSurfaceFormat::renderableType() const

获取可渲染类型。

在桌面版 OpenGL、OpenGL ES 和OpenVG 之间进行选择。

另请参阅 setRenderableType()。

int QSurfaceFormat::samples() const

返回多采样启用时每个像素的采样数，或多采样禁用时的-1 。默认返回值为-1 。

另请参阅 setSamples()。

void QSurfaceFormat::setAlphaBufferSize(int size)

在颜色缓冲区的Alpha通道中设置所需的size 位。

另请参阅 alphaBufferSize()。

void QSurfaceFormat::setBlueBufferSize(int size)

在颜色缓冲区的蓝色通道中，通过位设置所需的size 值。

另请参阅 blueBufferSize()。

[since 6.0] void QSurfaceFormat::setColorSpace(const QColorSpace &colorSpace)

设置首选的colorSpace 。

例如，这允许在支持 sRGB 的平台上请求默认帧缓冲区支持 sRGB 的窗口。

该函数在 Qt 6.0 中引入。

另请参阅 colorSpace()。

[static] void QSurfaceFormat::setDefaultFormat(const QSurfaceFormat &format)

设置全局默认表面format 。

QOpenGLContext 、QWindow 、QOpenGLWidget 以及类似类默认使用此格式。

可以通过使用相关类自身的 setFormat() 函数，按实例逐个覆盖该格式。 不过，在应用程序启动时一次性为所有窗口设置格式通常更为方便。此外，在需要共享上下文的情况下，这也能保证正确的行为，因为通过此函数设置格式可确保所有上下文和表面（即使是 Qt 内部创建的）都将使用相同的格式。

另请参阅 defaultFormat()。

void QSurfaceFormat::setDepthBufferSize(int size)

将深度缓冲区的最小大小设置为size 。

另请参阅 depthBufferSize()。

void QSurfaceFormat::setGreenBufferSize(int size)

在颜色缓冲区的绿色通道中，通过设置相应位来设定所需的size 值。

另请参阅 greenBufferSize()。

void QSurfaceFormat::setMajorVersion(int major)

设置所需的major OpenGL版本。

另请参阅 majorVersion()。

void QSurfaceFormat::setMinorVersion(int minor)

设置所需的minor OpenGL版本。

默认版本为 2.0。

另请参阅 minorVersion()。

void QSurfaceFormat::setOption(QSurfaceFormat::FormatOption option, bool on = true)

如果 `on ` 为真，则设置格式选项 `option `；否则，清除该选项。

要验证选项是否被正确应用，请在创建表面/上下文后，将实际格式与请求的格式进行比较。

另请参阅 setOptions()、options() 和testOption()。

void QSurfaceFormat::setOptions(QSurfaceFormat::FormatOptions options)

将格式选项设置为options 。

要验证某项选项是否已被采用，请在创建表面/上下文后，将实际格式与请求的格式进行比较。

另请参阅 options() 和testOption()。

void QSurfaceFormat::setProfile(QSurfaceFormat::OpenGLContextProfile profile)

设置所需的 OpenGL 上下文profile 。

如果请求的 OpenGL 版本低于 3.2，则此设置将被忽略。

另请参阅 profile()。

void QSurfaceFormat::setRedBufferSize(int size)

在颜色缓冲区的红色通道中，将所需的size 设置为特定位。

另请参阅 redBufferSize()。

void QSurfaceFormat::setRenderableType(QSurfaceFormat::RenderableType type)

设置所需的可渲染对象type 。

在桌面版 OpenGL、OpenGL ES 和OpenVG 之间进行选择。

另请参阅 renderableType()。

void QSurfaceFormat::setSamples(int numSamples)

启用多采样时，将每个像素的首选采样数设置为numSamples 。默认情况下，多采样处于禁用状态。

另请参阅 samples()。

void QSurfaceFormat::setStencilBufferSize(int size)

将首选的模板缓冲区大小设置为size 位。

另请参阅 stencilBufferSize()。

void QSurfaceFormat::setStereo(bool enable)

如果enable 为true，则启用立体声缓冲；否则禁用立体声缓冲。

默认情况下，立体缓冲功能处于禁用状态。

立体缓冲会提供额外的颜色缓冲区，用于生成左眼和右眼图像。

另请参阅 stereo()。

void QSurfaceFormat::setSwapBehavior(QSurfaceFormat::SwapBehavior behavior)

设置曲面的交换模式behavior 。

交换行为指定了希望采用单缓冲、双缓冲还是三缓冲。默认值DefaultSwapBehavior 将采用平台的默认交换行为。

另请参阅 swapBehavior()。

void QSurfaceFormat::setSwapInterval(int interval)

设置首选的缓冲区交换间隔。缓冲区交换间隔指定在发生缓冲区交换之前显示的最小视频帧数。这可用于将窗口中的 GL 绘制操作与屏幕的垂直刷新率进行同步。

将interval 的值设为0将关闭垂直刷新同步，任何大于0的值都将开启垂直同步。将interval 设为较大值（例如10），将导致每次缓冲区交换之间有10次垂直回扫。

默认间隔为 1。

底层平台可能不支持更改交换间隔。在此情况下，该请求将被静默忽略。

另请参阅 swapInterval()。

void QSurfaceFormat::setVersion(int major, int minor)

设置所需的major 和minor OpenGL版本。

默认版本为 2.0。

另请参阅 version()。

int QSurfaceFormat::stencilBufferSize() const

返回模板缓冲区的大小（以位为单位）。

另请参阅 setStencilBufferSize()。

bool QSurfaceFormat::stereo() const

如果启用了立体声缓冲，则返回true ；否则返回false。默认情况下，立体声缓冲处于禁用状态。

另请参阅 setStereo()。

QSurfaceFormat::SwapBehavior QSurfaceFormat::swapBehavior() const

返回已配置的交换行为。

另请参阅 setSwapBehavior()。

int QSurfaceFormat::swapInterval() const

返回交换间隔。

另请参阅 setSwapInterval()。

bool QSurfaceFormat::testOption(QSurfaceFormat::FormatOption option) const

如果设置了格式选项option ，则返回 true；否则返回 false。

另请参阅 options()。

std::pair<int, int> QSurfaceFormat::version() const

返回一个表示 OpenGL 版本的 std::pair<int, int>。

适用于版本检查，例如 format.version() >= std::pair(3, 2)

另请参阅 setVersion()。

QSurfaceFormat &QSurfaceFormat::operator=(const QSurfaceFormat &other)

将other 分配给此对象。