QSurfaceFormat Class

Member Function Documentation

QSurfaceFormat::QSurfaceFormat(const QSurfaceFormat &other)

Constructs a copy of other.

QSurfaceFormat::QSurfaceFormat(QSurfaceFormat::FormatOptions options)

Constructs a QSurfaceFormat with the given format options.

QSurfaceFormat::QSurfaceFormat()

Constructs a default initialized QSurfaceFormat.

Note: By default OpenGL 2.0 is requested since this provides the highest grade of portability between platforms and OpenGL implementations.

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

Assigns other to this object.

QSurfaceFormat::~QSurfaceFormat()

Destroys the QSurfaceFormat.

int QSurfaceFormat::alphaBufferSize() const

Get the size in bits of the alpha channel of the color buffer.

See also setAlphaBufferSize().

int QSurfaceFormat::blueBufferSize() const

Get the size in bits of the blue channel of the color buffer.

See also setBlueBufferSize().

[since 5.10] const QColorSpace &QSurfaceFormat::colorSpace() const

Returns the color space.

This function was introduced in Qt 5.10.

See also setColorSpace().

[static, since 5.4] QSurfaceFormat QSurfaceFormat::defaultFormat()

Returns the global default surface format.

When setDefaultFormat() is not called, this is a default-constructed QSurfaceFormat.

This function was introduced in Qt 5.4.

See also setDefaultFormat().

int QSurfaceFormat::depthBufferSize() const

Returns the depth buffer size.

See also setDepthBufferSize().

int QSurfaceFormat::greenBufferSize() const

Get the size in bits of the green channel of the color buffer.

See also setGreenBufferSize().

bool QSurfaceFormat::hasAlpha() const

Returns true if the alpha buffer size is greater than zero.

This means that the surface might be used with per pixel translucency effects.

int QSurfaceFormat::majorVersion() const

Returns the major OpenGL version.

The default version is 2.0.

See also setMajorVersion().

int QSurfaceFormat::minorVersion() const

Returns the minor OpenGL version.

See also setMinorVersion().

[since 5.3] QSurfaceFormat::FormatOptions QSurfaceFormat::options() const

Returns the currently set format options.

This function was introduced in Qt 5.3.

See also setOption(), setOptions(), and testOption().

QSurfaceFormat::OpenGLContextProfile QSurfaceFormat::profile() const

Get the configured OpenGL context profile.

This setting is ignored if the requested OpenGL version is less than 3.2.

See also setProfile().

int QSurfaceFormat::redBufferSize() const

Get the size in bits of the red channel of the color buffer.

See also setRedBufferSize().

QSurfaceFormat::RenderableType QSurfaceFormat::renderableType() const

Gets the renderable type.

Chooses between desktop OpenGL, OpenGL ES, and OpenVG.

See also setRenderableType().

int QSurfaceFormat::samples() const

Returns the number of samples per pixel when multisampling is enabled, or -1 when multisampling is disabled. The default return value is -1.

See also setSamples().

void QSurfaceFormat::setAlphaBufferSize(int size)

Set the desired size in bits of the alpha channel of the color buffer.

See also alphaBufferSize().

void QSurfaceFormat::setBlueBufferSize(int size)

Set the desired size in bits of the blue channel of the color buffer.

See also blueBufferSize().

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

Sets the preferred colorSpace.

For example, this allows requesting windows with default framebuffers that are sRGB-capable on platforms that support it.

Note: When the requested color space is not supported by the platform, the request is ignored. Query the QSurfaceFormat after window creation to verify if the color space request could be honored or not.

Note: This setting controls if the default framebuffer of the window is capable of updates and blending in a given color space. It does not change applications' output by itself. The applications' rendering code will still have to opt in via the appropriate OpenGL calls to enable updates and blending to be performed in the given color space instead of using the standard linear operations.

This function was introduced in Qt 6.0.

See also colorSpace().

[since 5.10] void QSurfaceFormat::setColorSpace(QSurfaceFormat::ColorSpace colorSpace)

This is an overloaded function.

Sets the colorspace to one of the predefined values.

This function was introduced in Qt 5.10.

See also colorSpace().

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

Sets the global default surface format.

This format is used by default in QOpenGLContext, QWindow, QOpenGLWidget and similar classes.

It can always be overridden on a per-instance basis by using the class in question's own setFormat() function. However, it is often more convenient to set the format for all windows once at the start of the application. It also guarantees proper behavior in cases where shared contexts are required, because settings the format via this function guarantees that all contexts and surfaces, even the ones created internally by Qt, will use the same format.

Note: When setting Qt::AA_ShareOpenGLContexts, it is strongly recommended to place the call to this function before the construction of the QGuiApplication or QApplication. Otherwise format will not be applied to the global share context and therefore issues may arise with context sharing afterwards.

This function was introduced in Qt 5.4.

See also defaultFormat().

void QSurfaceFormat::setDepthBufferSize(int size)

Set the minimum depth buffer size to size.

See also depthBufferSize().

void QSurfaceFormat::setGreenBufferSize(int size)

Set the desired size in bits of the green channel of the color buffer.

See also greenBufferSize().

void QSurfaceFormat::setMajorVersion(int major)

Sets the desired major OpenGL version.

See also majorVersion().

void QSurfaceFormat::setMinorVersion(int minor)

Sets the desired minor OpenGL version.

The default version is 2.0.

See also minorVersion().

[since 5.3] void QSurfaceFormat::setOption(QSurfaceFormat::FormatOption option, bool on = true)

Sets the format option option if on is true; otherwise, clears the option.

To verify that an option was respected, compare the actual format to the requested format after surface/context creation.

This function was introduced in Qt 5.3.

See also setOptions(), options(), and testOption().

[since 5.3] void QSurfaceFormat::setOptions(QSurfaceFormat::FormatOptions options)

Sets the format options to options.

To verify that an option was respected, compare the actual format to the requested format after surface/context creation.

This function was introduced in Qt 5.3.

See also options() and testOption().

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

Sets the desired OpenGL context profile.

This setting is ignored if the requested OpenGL version is less than 3.2.

See also profile().

void QSurfaceFormat::setRedBufferSize(int size)

Set the desired size in bits of the red channel of the color buffer.

See also redBufferSize().

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

Sets the desired renderable type.

Chooses between desktop OpenGL, OpenGL ES, and OpenVG.

See also renderableType().

void QSurfaceFormat::setSamples(int numSamples)

Set the preferred number of samples per pixel when multisampling is enabled to numSamples. By default, multisampling is disabled.

See also samples().

void QSurfaceFormat::setStencilBufferSize(int size)

Set the preferred stencil buffer size to size bits.

See also stencilBufferSize().

void QSurfaceFormat::setStereo(bool enable)

If enable is true enables stereo buffering; otherwise disables stereo buffering.

Stereo buffering is disabled by default.

Stereo buffering provides extra color buffers to generate left-eye and right-eye images.

See also stereo().

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

Set the swap behavior of the surface.

The swap behavior specifies whether single, double, or triple buffering is desired. The default, DefaultSwapBehavior, gives the default swap behavior of the platform.

See also swapBehavior().

[since 5.3] void QSurfaceFormat::setSwapInterval(int interval)

Sets the preferred swap interval. The swap interval specifies the minimum number of video frames that are displayed before a buffer swap occurs. This can be used to sync the GL drawing into a window to the vertical refresh of the screen.

Setting an interval value of 0 will turn the vertical refresh syncing off, any value higher than 0 will turn the vertical syncing on. Setting interval to a higher value, for example 10, results in having 10 vertical retraces between every buffer swap.

The default interval is 1.

Changing the swap interval may not be supported by the underlying platform. In this case, the request will be silently ignored.

This function was introduced in Qt 5.3.

See also swapInterval().

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

Sets the desired major and minor OpenGL versions.

The default version is 2.0.

See also version().

int QSurfaceFormat::stencilBufferSize() const

Returns the stencil buffer size in bits.

See also setStencilBufferSize().

bool QSurfaceFormat::stereo() const

Returns true if stereo buffering is enabled; otherwise returns false. Stereo buffering is disabled by default.

See also setStereo().

QSurfaceFormat::SwapBehavior QSurfaceFormat::swapBehavior() const

Returns the configured swap behaviour.

See also setSwapBehavior().

[since 5.3] int QSurfaceFormat::swapInterval() const

Returns the swap interval.

This function was introduced in Qt 5.3.

See also setSwapInterval().

[since 5.3] bool QSurfaceFormat::testOption(QSurfaceFormat::FormatOption option) const

Returns true if the format option option is set; otherwise returns false.

This function was introduced in Qt 5.3.

See also options().

QPair<int, int> QSurfaceFormat::version() const

Returns a QPair<int, int> representing the OpenGL version.

Useful for version checks, for example format.version() >= qMakePair(3, 2)

See also setVersion().