QSurfaceFormat class represents the format of a QSurface . 更多...
| 头： | #include <QSurfaceFormat> |
| qmake: | QT += gui |
| Since: | Qt 5.0 |
| enum | FormatOption { StereoBuffers, DebugContext, DeprecatedFunctions, ResetNotification } |
| flags | FormatOptions |
| enum | OpenGLContextProfile { NoProfile, CoreProfile, CompatibilityProfile } |
| enum | RenderableType { DefaultRenderableType, OpenGL, OpenGLES, OpenVG } |
| enum | SwapBehavior { DefaultSwapBehavior, SingleBuffer, DoubleBuffer, TripleBuffer } |
| QSurfaceFormat () | |
| QSurfaceFormat (FormatOptions options ) | |
| QSurfaceFormat (const QSurfaceFormat & other ) | |
| ~QSurfaceFormat () | |
| int | alphaBufferSize () const |
| int | blueBufferSize () const |
| int | depthBufferSize () const |
| int | greenBufferSize () const |
| bool | hasAlpha () const |
| int | majorVersion () const |
| int | minorVersion () const |
| QSurfaceFormat::FormatOptions | options () const |
| OpenGLContextProfile | profile () const |
| int | redBufferSize () const |
| RenderableType | renderableType () const |
| int | samples () const |
| void | setAlphaBufferSize (int size ) |
| void | setBlueBufferSize (int size ) |
| void | setDepthBufferSize (int size ) |
| void | setGreenBufferSize (int size ) |
| void | setMajorVersion (int major ) |
| void | setMinorVersion (int minor ) |
| void | setOption (FormatOption option , bool on = true) |
| void | setOptions (QSurfaceFormat::FormatOptions options ) |
| void | setProfile (OpenGLContextProfile profile ) |
| void | setRedBufferSize (int size ) |
| void | setRenderableType (RenderableType type ) |
| void | setSamples (int numSamples ) |
| void | setStencilBufferSize (int size ) |
| void | setStereo (bool enable ) |
| void | setSwapBehavior (SwapBehavior behavior ) |
| void | setSwapInterval (int interval ) |
| void | setVersion (int major , int minor ) |
| int | stencilBufferSize () const |
| bool | stereo () const |
| SwapBehavior | swapBehavior () const |
| int | swapInterval () const |
| bool | testOption (FormatOption option ) const |
| QPair<int, int> | version () const |
| QSurfaceFormat & | operator= (const QSurfaceFormat & other ) |
| QSurfaceFormat | defaultFormat () |
| void | setDefaultFormat (const QSurfaceFormat & format ) |
| bool | operator!= (const QSurfaceFormat & a , const QSurfaceFormat & b ) |
| bool | operator== (const QSurfaceFormat & a , const QSurfaceFormat & b ) |
QSurfaceFormat class represents the format of a QSurface .
The format includes the size of the color buffers, red, green, and blue; the size of the alpha buffer; the size of the depth and stencil buffers; and number of samples per pixel for multisampling. In addition, the format contains surface configuration parameters such as OpenGL profile and version for rendering, whether or not to enable stereo buffers, and swap behaviour.
This enum contains format options for use with QSurfaceFormat .
| 常量 | 值 | 描述 |
|---|---|---|
QSurfaceFormat::StereoBuffers
|
0x0001
|
Used to request stereo buffers in the surface format. |
QSurfaceFormat::DebugContext
|
0x0002
|
Used to request a debug context with extra debugging information. |
QSurfaceFormat::DeprecatedFunctions
|
0x0004
|
Used to request that deprecated functions be included in the OpenGL context profile. If not specified, you should get a forward compatible context without support functionality marked as deprecated. This requires OpenGL version 3.0 or higher. |
QSurfaceFormat::ResetNotification
|
0x0008
|
Enables notifications about resets of the OpenGL context. The status is then queryable via the context's isValid() function. Note that not setting this flag does not guarantee that context state loss never occurs. Additionally, some implementations may choose to report context loss regardless of this flag. |
FormatOptions 类型是 typedef 对于 QFlags <FormatOption>. It stores an OR combination of FormatOption values.
This enum is used to specify the OpenGL context profile, in conjunction with QSurfaceFormat::setMajorVersion () 和 QSurfaceFormat::setMinorVersion ().
Profiles are exposed in OpenGL 3.2 and above, and are used to choose between a restricted core profile, and a compatibility profile which might contain deprecated support functionality.
Note that the core profile might still contain functionality that is deprecated and scheduled for removal in a higher version. To get access to the deprecated functionality for the core profile in the set OpenGL version you can use the QSurfaceFormat format option QSurfaceFormat::DeprecatedFunctions .
| 常量 | 值 | 描述 |
|---|---|---|
QSurfaceFormat::NoProfile
|
0
|
OpenGL version is lower than 3.2. For 3.2 and newer this is same as CoreProfile. |
QSurfaceFormat::CoreProfile
|
1
|
Functionality deprecated in OpenGL version 3.0 is not available. |
QSurfaceFormat::CompatibilityProfile
|
2
|
Functionality from earlier OpenGL versions is available. |
此枚举指定表面的渲染后端。
| 常量 | 值 | 描述 |
|---|---|---|
QSurfaceFormat::DefaultRenderableType
|
0x0
|
默认，未指定渲染方法 |
QSurfaceFormat::OpenGL
|
0x1
|
桌面 OpenGL 渲染 |
QSurfaceFormat::OpenGLES
|
0x2
|
OpenGL ES 2.0 渲染 |
QSurfaceFormat::OpenVG
|
0x4
|
开放向量图形渲染 |
此枚举用于 QSurfaceFormat to specify the swap behaviour of a surface. The swap behaviour is mostly transparent to the application, but it affects factors such as rendering latency and throughput.
| 常量 | 值 | 描述 |
|---|---|---|
QSurfaceFormat::DefaultSwapBehavior
|
0
|
默认，平台未指定交换行为。 |
QSurfaceFormat::SingleBuffer
|
1
|
Used to request single buffering, which might result in flickering when OpenGL rendering is done directly to screen without an intermediate offscreen buffer. |
QSurfaceFormat::DoubleBuffer
|
2
|
This is typically the default swap behaviour on desktop platforms, consisting of one back buffer and one front buffer. Rendering is done to the back buffer, and then the back buffer and front buffer are swapped, or the contents of the back buffer are copied to the front buffer, depending on the implementation. |
QSurfaceFormat::TripleBuffer
|
3
|
This swap behaviour is sometimes used in order to decrease the risk of skipping a frame when the rendering rate is just barely keeping up with the screen refresh rate. Depending on the platform it might also lead to slightly more efficient use of the GPU due to improved pipelining behaviour. Triple buffering comes at the cost of an extra frame of memory usage and latency, and might not be supported depending on the underlying platform. |
Constructs a default initialized QSurfaceFormat .
注意： 默认情况下 OpenGL 2.0 is requested since this provides the highest grade of portability between platforms and OpenGL implementations.
构造 QSurfaceFormat with the given format options .
构造副本为 other .
销毁 QSurfaceFormat .
Get the size in bits of the alpha channel of the color buffer.
另请参阅 setAlphaBufferSize ().
Get the size in bits of the blue channel of the color buffer.
另请参阅 setBlueBufferSize ().
[static]
QSurfaceFormat
QSurfaceFormat::
defaultFormat
()
返回全局默认表面格式。
当 setDefaultFormat () 未被调用，这是默认构造的 QSurfaceFormat .
该函数在 Qt 5.4 引入。
另请参阅 setDefaultFormat ().
返回深度缓冲大小。
另请参阅 setDepthBufferSize ().
Get the size in bits of the green channel of the color buffer.
另请参阅 setGreenBufferSize ().
返回
true
if the alpha buffer size is greater than zero.
This means that the surface might be used with per pixel translucency effects.
Returns the major OpenGL version.
默认版本为 2.0。
另请参阅 setMajorVersion ().
Returns the minor OpenGL version.
另请参阅 setMinorVersion ().
Returns the currently set format options.
该函数在 Qt 5.3 引入。
另请参阅 setOption (), setOptions ()，和 testOption ().
Get the configured OpenGL context profile.
This setting is ignored if the requested OpenGL version is less than 3.2.
另请参阅 setProfile ().
Get the size in bits of the red channel of the color buffer.
另请参阅 setRedBufferSize ().
获取可渲染类型。
Chooses between desktop OpenGL , OpenGL ES, and OpenVG .
另请参阅 setRenderableType ().
Returns the number of samples per pixel when multisampling is enabled. By default, multisampling is disabled.
另请参阅 setSamples ().
设置期望 size in bits of the alpha channel of the color buffer.
另请参阅 alphaBufferSize ().
设置期望 size in bits of the blue channel of the color buffer.
注意： On Mac OSX, be sure to set the buffer size of all color channels, otherwise this setting will have no effect. If one of the buffer sizes is not set, the current bit-depth of the screen is used.
另请参阅 blueBufferSize ().
[static]
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.
注意： 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.
该函数在 Qt 5.4 引入。
另请参阅 defaultFormat ().
Set the minimum depth buffer size to size .
另请参阅 depthBufferSize ().
设置期望 size in bits of the green channel of the color buffer.
注意： On Mac OSX, be sure to set the buffer size of all color channels, otherwise this setting will have no effect. If one of the buffer sizes is not set, the current bit-depth of the screen is used.
另请参阅 greenBufferSize ().
设置期望 major OpenGL version.
另请参阅 majorVersion ().
设置期望 minor OpenGL version.
默认版本为 2.0。
另请参阅 minorVersion ().
Sets the format option option if on is true; otherwise, clears the option.
该函数在 Qt 5.3 引入。
另请参阅 setOptions (), options ()，和 testOption ().
Sets the format options to options .
该函数在 Qt 5.3 引入。
另请参阅 options () 和 testOption ().
设置期望 OpenGL context profile .
This setting is ignored if the requested OpenGL version is less than 3.2.
另请参阅 profile ().
设置期望 size in bits of the red channel of the color buffer.
注意： On Mac OSX, be sure to set the buffer size of all color channels, otherwise this setting will have no effect. If one of the buffer sizes is not set, the current bit-depth of the screen is used.
另请参阅 redBufferSize ().
设置期望可渲染 type .
Chooses between desktop OpenGL , OpenGL ES, and OpenVG .
另请参阅 renderableType ().
Set the preferred number of samples per pixel when multisampling is enabled to numSamples . By default, multisampling is disabled.
另请参阅 samples ().
将首选蜡纸缓冲大小设为 size 位。
另请参阅 stencilBufferSize ().
若 enable is true enables stereo buffering; otherwise disables stereo buffering.
默认情况下，立体缓冲是禁用的。
Stereo buffering provides extra color buffers to generate left-eye and right-eye images.
另请参阅 stereo ().
设置交换 behavior 为表面。
The swap behavior specifies whether single, double, or triple buffering is desired. The default, DefaultSwapBehavior , gives the default swap behavior of the platform.
另请参阅 swapBehavior ().
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.
默认间隔为 1。
Changing the swap interval may not be supported by the underlying platform. In this case, the request will be silently ignored.
该函数在 Qt 5.3 引入。
另请参阅 swapInterval ().
设置期望 major and minor OpenGL versions.
默认版本为 2.0。
另请参阅 version ().
返回蜡纸缓冲大小 (以位为单位)。
另请参阅 setStencilBufferSize ().
返回
true
if stereo buffering is enabled; otherwise returns false. Stereo buffering is disabled by default.
另请参阅 setStereo ().
返回配置的交换行为。
另请参阅 setSwapBehavior ().
返回交换间隔。
该函数在 Qt 5.3 引入。
另请参阅 setSwapInterval ().
返回 true 若格式选项 option 有设置；否则返回 false。
该函数在 Qt 5.3 引入。
另请参阅 options ().
返回 QPair <int, int> representing the OpenGL version.
Useful for version checks, for example format.version() >= qMakePair (3, 2)
另请参阅 setVersion ().
赋值 other 到此对象。
返回
false
若所有选项对于两
QSurfaceFormat
对象
a
and
b
相等；否则返回
true
.
返回
true
若所有选项对于两
QSurfaceFormat
对象
a
and
b
相等。