QSurfaceFormat Class

成员函数文档

QSurfaceFormat::QSurfaceFormat()

构造默认初始化的 QSurfaceFormat。

QSurfaceFormat::QSurfaceFormat(QSurfaceFormat::FormatOptions options)

用给定的格式构建一个 QSurfaceFormatoptions 。

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

如果 alpha 缓冲区的大小大于零，则返回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 的平台上请求带有默认帧缓冲器的窗口。

此函数在 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 为 true，则设置格式选项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 。