Qt 4.8
|
The QGLFormat class specifies the display format of an OpenGL rendering context. More...
#include <qgl.h>
Public Types | |
enum | OpenGLContextProfile { NoProfile, CoreProfile, CompatibilityProfile } |
This enum describes the OpenGL context profiles that can be specified for contexts implementing OpenGL version 3. More... | |
enum | OpenGLVersionFlag { OpenGL_Version_None = 0x00000000, OpenGL_Version_1_1 = 0x00000001, OpenGL_Version_1_2 = 0x00000002, OpenGL_Version_1_3 = 0x00000004, OpenGL_Version_1_4 = 0x00000008, OpenGL_Version_1_5 = 0x00000010, OpenGL_Version_2_0 = 0x00000020, OpenGL_Version_2_1 = 0x00000040, OpenGL_ES_Common_Version_1_0 = 0x00000080, OpenGL_ES_CommonLite_Version_1_0 = 0x00000100, OpenGL_ES_Common_Version_1_1 = 0x00000200, OpenGL_ES_CommonLite_Version_1_1 = 0x00000400, OpenGL_ES_Version_2_0 = 0x00000800, OpenGL_Version_3_0 = 0x00001000, OpenGL_Version_3_1 = 0x00002000, OpenGL_Version_3_2 = 0x00004000, OpenGL_Version_3_3 = 0x00008000, OpenGL_Version_4_0 = 0x00010000 } |
This enum describes the various OpenGL versions that are recognized by Qt. More... | |
Public Functions | |
bool | accum () const |
Returns true if the accumulation buffer is enabled; otherwise returns false. More... | |
int | accumBufferSize () const |
Returns the accumulation buffer size. More... | |
bool | alpha () const |
Returns true if the alpha buffer in the framebuffer is enabled; otherwise returns false. More... | |
int | alphaBufferSize () const |
Returns the alpha buffer size. More... | |
int | blueBufferSize () const |
Returns the blue buffer size. More... | |
bool | depth () const |
Returns true if the depth buffer is enabled; otherwise returns false. More... | |
int | depthBufferSize () const |
Returns the depth buffer size. More... | |
bool | directRendering () const |
Returns true if direct rendering is enabled; otherwise returns false. More... | |
bool | doubleBuffer () const |
Returns true if double buffering is enabled; otherwise returns false. More... | |
int | greenBufferSize () const |
Returns the green buffer size. More... | |
bool | hasOverlay () const |
Returns true if overlay plane is enabled; otherwise returns false. More... | |
int | majorVersion () const |
Returns the OpenGL major version. More... | |
int | minorVersion () const |
Returns the OpenGL minor version. More... | |
QGLFormat & | operator= (const QGLFormat &other) |
Assigns other to this object. More... | |
int | plane () const |
Returns the plane of this format. More... | |
OpenGLContextProfile | profile () const |
Returns the OpenGL context profile. More... | |
QGLFormat () | |
Constructs a QGLFormat object with the following default settings: More... | |
QGLFormat (QGL::FormatOptions options, int plane=0) | |
Creates a QGLFormat object that is a copy of the current defaultFormat(). More... | |
QGLFormat (const QGLFormat &other) | |
Constructs a copy of other. More... | |
int | redBufferSize () const |
Returns the red buffer size. More... | |
bool | rgba () const |
Returns true if RGBA color mode is set. More... | |
bool | sampleBuffers () const |
Returns true if multisample buffer support is enabled; otherwise returns false. More... | |
int | samples () const |
Returns the number of samples per pixel when multisampling is enabled. More... | |
void | setAccum (bool enable) |
If enable is true enables the accumulation buffer; otherwise disables the accumulation buffer. More... | |
void | setAccumBufferSize (int size) |
Set the preferred accumulation buffer size, where size is the bit depth for each RGBA component. More... | |
void | setAlpha (bool enable) |
If enable is true enables the alpha buffer; otherwise disables the alpha buffer. More... | |
void | setAlphaBufferSize (int size) |
Set the preferred alpha buffer size to size. More... | |
void | setBlueBufferSize (int size) |
Set the preferred blue buffer size to size. More... | |
void | setDepth (bool enable) |
If enable is true enables the depth buffer; otherwise disables the depth buffer. More... | |
void | setDepthBufferSize (int size) |
Set the minimum depth buffer size to size. More... | |
void | setDirectRendering (bool enable) |
If enable is true enables direct rendering; otherwise disables direct rendering. More... | |
void | setDoubleBuffer (bool enable) |
If enable is true sets double buffering; otherwise sets single buffering. More... | |
void | setGreenBufferSize (int size) |
Set the preferred green buffer size to size. More... | |
void | setOption (QGL::FormatOptions opt) |
Sets the format option to opt. More... | |
void | setOverlay (bool enable) |
If enable is true enables an overlay plane; otherwise disables the overlay plane. More... | |
void | setPlane (int plane) |
Sets the requested plane to plane. More... | |
void | setProfile (OpenGLContextProfile profile) |
Set the OpenGL context profile to profile. More... | |
void | setRedBufferSize (int size) |
Set the preferred red buffer size to size. More... | |
void | setRgba (bool enable) |
If enable is true sets RGBA mode. More... | |
void | setSampleBuffers (bool enable) |
If enable is true, a GL context with multisample buffer support is picked; otherwise ignored. More... | |
void | setSamples (int numSamples) |
Set the preferred number of samples per pixel when multisampling is enabled to numSamples. More... | |
void | setStencil (bool enable) |
If enable is true enables the stencil buffer; otherwise disables the stencil buffer. More... | |
void | setStencilBufferSize (int size) |
Set the preferred stencil buffer size to size. More... | |
void | setStereo (bool enable) |
If enable is true enables stereo buffering; otherwise disables stereo buffering. More... | |
void | setSwapInterval (int interval) |
Set the preferred swap interval. More... | |
void | setVersion (int major, int minor) |
Set the OpenGL version to the major and minor numbers. More... | |
bool | stencil () const |
Returns true if the stencil buffer is enabled; otherwise returns false. More... | |
int | stencilBufferSize () const |
Returns the stencil buffer size. More... | |
bool | stereo () const |
Returns true if stereo buffering is enabled; otherwise returns false. More... | |
int | swapInterval () const |
Returns the currently set swap interval. More... | |
bool | testOption (QGL::FormatOptions opt) const |
Returns true if format option opt is set; otherwise returns false. More... | |
~QGLFormat () | |
Destroys the QGLFormat. More... | |
Static Public Functions | |
static QGLFormat | defaultFormat () |
static QGLFormat | defaultOverlayFormat () |
Returns the default QGLFormat for overlay contexts. More... | |
static bool | hasOpenGL () |
Returns true if the window system has any OpenGL support; otherwise returns false. More... | |
static bool | hasOpenGLOverlays () |
Returns true if the window system supports OpenGL overlays; otherwise returns false. More... | |
static OpenGLVersionFlags | openGLVersionFlags () |
static void | setDefaultFormat (const QGLFormat &f) |
Sets a new default QGLFormat for the application to f. More... | |
static void | setDefaultOverlayFormat (const QGLFormat &f) |
Sets a new default QGLFormat for overlay contexts to f. More... | |
Private Functions | |
void | detach () |
Properties | |
QGLFormatPrivate * | d |
Friends | |
Q_OPENGL_EXPORT bool | operator!= (const QGLFormat &, const QGLFormat &) |
Returns false if all the options of the two QGLFormat objects a and b are equal; otherwise returns true. More... | |
Q_OPENGL_EXPORT QDebug | operator<< (QDebug, const QGLFormat &) |
Q_OPENGL_EXPORT bool | operator== (const QGLFormat &, const QGLFormat &) |
Returns true if all the options of the two QGLFormat objects a and b are equal; otherwise returns false. More... | |
The QGLFormat class specifies the display format of an OpenGL rendering context.
A display format has several characteristics:
You can also specify preferred bit depths for the color buffer, depth buffer, alpha buffer, accumulation buffer and the stencil buffer with the functions: setRedBufferSize(), setGreenBufferSize(), setBlueBufferSize(), setDepthBufferSize(), setAlphaBufferSize(), setAccumBufferSize() and setStencilBufferSize().
Note that even if you specify that you prefer a 32 bit depth buffer (e.g. with setDepthBufferSize(32)), the format that is chosen may not have a 32 bit depth buffer, even if there is a format available with a 32 bit depth buffer. The main reason for this is how the system dependant picking algorithms work on the different platforms, and some format options may have higher precedence than others.
You create and tell a QGLFormat object what rendering options you want from an OpenGL rendering context.
OpenGL drivers or accelerated hardware may or may not support advanced features such as alpha channel or stereographic viewing. If you request some features that the driver/hardware does not provide when you create a QGLWidget, you will get a rendering context with the nearest subset of features.
There are different ways to define the display characteristics of a rendering context. One is to create a QGLFormat and make it the default for the entire application:
Or you can specify the desired format when creating an object of your QGLWidget subclass:
After the widget has been created, you can find out which of the requested features the system was able to provide:
OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries.
This enum describes the OpenGL context profiles that can be specified for contexts implementing OpenGL version 3.
2 or higher. These profiles are different from OpenGL ES profiles.
Enumerator | |
---|---|
NoProfile | |
CoreProfile | |
CompatibilityProfile |
This enum describes the various OpenGL versions that are recognized by Qt.
Use the QGLFormat::openGLVersionFlags() function to identify which versions that are supported at runtime.
See also static bool cachedDefault = false; static OpenGLVersionFlags defaultVersionFlags = OpenGL_Version_None; QGLContext *currentCtx = const_cast<QGLContext *>(QGLContext::currentContext()); QGLTemporaryContext *tmpContext = 0; if (currentCtx && currentCtx->d_func()->version_flags_cached) return currentCtx->d_func()->version_flags; if (!currentCtx) { if (cachedDefault) { return defaultVersionFlags; else { if (!hasOpenGL()) return defaultVersionFlags; tmpContext = new QGLTemporaryContext; cachedDefault = true; } }
QString versionString(QLatin1String(reinterpret_cast<const char*>(glGetString(GL_VERSION)))); OpenGLVersionFlags versionFlags = qOpenGLVersionFlagsFromString(versionString); if (currentCtx) { currentCtx->d_func()->version_flags_cached = true; currentCtx->d_func()->version_flags = versionFlags; } if (tmpContext) { defaultVersionFlags = versionFlags; delete tmpContext; }
return versionFlags; }
/*! Returns the default QGLFormat for the application. All QGLWidget objects that are created use this format unless another format is specified, e.g. when they are constructed.
If no special default format has been set using setDefaultFormat(), the default format is the same as that created with QGLFormat().
Definition at line 261 of file qgl.h.
QGLFormat::QGLFormat | ( | ) |
Constructs a QGLFormat object with the following default settings:
Definition at line 449 of file qgl.cpp.
QGLFormat::QGLFormat | ( | QGL::FormatOptions | options, |
int | plane = 0 |
||
) |
Creates a QGLFormat object that is a copy of the current defaultFormat().
If options is not 0, the default format is modified by the specified format options. The options parameter should be QGL::FormatOption values OR'ed together.
This constructor makes it easy to specify a certain desired format in classes derived from QGLWidget, for example:
Note that there are QGL::FormatOption values to turn format settings both on and off, e.g. QGL::DepthBuffer and QGL::NoDepthBuffer, QGL::DirectRendering and QGL::IndirectRendering, etc.
The plane parameter defaults to 0 and is the plane which this format should be associated with. Not all OpenGL implementations supports overlay/underlay rendering planes.
Definition at line 478 of file qgl.cpp.
QGLFormat::QGLFormat | ( | const QGLFormat & | other | ) |
|
inline |
Returns true if the accumulation buffer is enabled; otherwise returns false.
The accumulation buffer is disabled by default.
Definition at line 633 of file qgl.h.
Referenced by buildSpec(), QGLContext::choosePixelFormat(), QGLContext::chooseVisual(), nearest_gl_texture_size(), pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
int QGLFormat::accumBufferSize | ( | ) | const |
Returns the accumulation buffer size.
Definition at line 1159 of file qgl.cpp.
Referenced by buildSpec(), nearest_gl_texture_size(), pfiToQGLFormat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
|
inline |
Returns true if the alpha buffer in the framebuffer is enabled; otherwise returns false.
The alpha buffer is disabled by default.
Definition at line 628 of file qgl.h.
Referenced by QGLWindowSurface::beginPaint(), buildSpec(), QGLContext::choosePixelFormat(), QGLContext::chooseVisual(), nearest_gl_texture_size(), pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), qt_eglproperties_set_glformat(), qt_format_to_attrib_list(), QGLContextPrivate::tryFormat(), and QGLContext::tryVisual().
int QGLFormat::alphaBufferSize | ( | ) | const |
Returns the alpha buffer size.
Definition at line 1132 of file qgl.cpp.
Referenced by buildSpec(), QGLPaintDevice::metric(), nearest_gl_texture_size(), QGLOverlayWidget::paintGL(), pfiToQGLFormat(), qt_eglproperties_set_glformat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
int QGLFormat::blueBufferSize | ( | ) | const |
Returns the blue buffer size.
Definition at line 1105 of file qgl.cpp.
Referenced by buildSpec(), QGLPaintDevice::metric(), nearest_gl_texture_size(), pfiToQGLFormat(), qt_eglproperties_set_glformat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
|
static |
Definition at line 1518 of file qgl.cpp.
Referenced by QWSGLWindowSurface::context(), QX11GLPixmapData::glFormat(), QGLPixelBuffer::hasOpenGLPbuffers(), qt_format_to_attrib_list(), qt_resolve_stencil_face_extension(), and qt_resolve_version_1_3_functions().
|
static |
Returns the default QGLFormat for overlay contexts.
The default overlay format is:
Definition at line 1559 of file qgl.cpp.
Referenced by QGLContext::choosePixelFormat(), QGLOverlayWidget::paintGL(), and qStoreColors().
|
inline |
Returns true if the depth buffer is enabled; otherwise returns false.
The depth buffer is enabled by default.
Definition at line 618 of file qgl.h.
Referenced by buildSpec(), QGLContext::choosePixelFormat(), QGLContext::chooseVisual(), nearest_gl_texture_size(), pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), qt_eglproperties_set_glformat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
int QGLFormat::depthBufferSize | ( | ) | const |
Returns the depth buffer size.
Definition at line 1000 of file qgl.cpp.
Referenced by buildSpec(), nearest_gl_texture_size(), pfiToQGLFormat(), qt_eglproperties_set_glformat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
|
private |
Definition at line 491 of file qgl.cpp.
|
inline |
Returns true if direct rendering is enabled; otherwise returns false.
Direct rendering is enabled by default.
Definition at line 648 of file qgl.h.
Referenced by QGLContext::choosePixelFormat(), and pfiToQGLFormat().
|
inline |
Returns true if double buffering is enabled; otherwise returns false.
Double buffering is enabled by default.
Definition at line 613 of file qgl.h.
Referenced by buildSpec(), QGLContext::choosePixelFormat(), QGLContext::chooseVisual(), QGLWindowSurface::flush(), pfiToQGLFormat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
int QGLFormat::greenBufferSize | ( | ) | const |
Returns the green buffer size.
Definition at line 1070 of file qgl.cpp.
Referenced by buildSpec(), QGLPaintDevice::metric(), nearest_gl_texture_size(), pfiToQGLFormat(), qt_eglproperties_set_glformat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
|
static |
Returns true if the window system has any OpenGL support; otherwise returns false.
Definition at line 186 of file qgl_egl.cpp.
Referenced by qglx_getProcAddress(), qwglError(), and QGLTemporaryContext::~QGLTemporaryContext().
|
static |
Returns true if the window system supports OpenGL overlays; otherwise returns false.
Definition at line 185 of file qgl_mac.mm.
Referenced by qDeleteQGLContext(), and qglx_getProcAddress().
|
inline |
Returns true if overlay plane is enabled; otherwise returns false.
Overlay is disabled by default.
Definition at line 653 of file qgl.h.
Referenced by QGLContext::choosePixelFormat(), QGLOverlayWidget::paintGL(), and pfiToQGLFormat().
int QGLFormat::majorVersion | ( | ) | const |
Returns the OpenGL major version.
Definition at line 1223 of file qgl.cpp.
Referenced by QGL2PaintEngineEx::beginNativePainting(), and qgl_create_context().
int QGLFormat::minorVersion | ( | ) | const |
Returns the OpenGL minor version.
Definition at line 1238 of file qgl.cpp.
Referenced by QGL2PaintEngineEx::beginNativePainting(), and qgl_create_context().
|
static |
Referenced by QOpenGLPaintEngine::begin(), QGLEngineSelector::preferredPaintEngine(), and qt_gl_resolve_features().
int QGLFormat::plane | ( | ) | const |
Returns the plane of this format.
The default for normal formats is 0, which means the normal plane. The default for overlay formats is 1, which is the first overlay plane.
Definition at line 924 of file qgl.cpp.
Referenced by buildSpec(), nearest_gl_texture_size(), qgl_create_context(), and QGLContextPrivate::tryFormat().
QGLFormat::OpenGLContextProfile QGLFormat::profile | ( | ) | const |
Returns the OpenGL context profile.
Definition at line 1286 of file qgl.cpp.
Referenced by QGL2PaintEngineEx::beginNativePainting(), and qgl_create_context().
int QGLFormat::redBufferSize | ( | ) | const |
Returns the red buffer size.
Definition at line 1035 of file qgl.cpp.
Referenced by buildSpec(), QGLPaintDevice::metric(), nearest_gl_texture_size(), pfiToQGLFormat(), qt_eglproperties_set_glformat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
|
inline |
Returns true if RGBA color mode is set.
Returns false if color index mode is set. The default color mode is RGBA.
Definition at line 623 of file qgl.h.
Referenced by buildSpec(), QGLContext::chooseContext(), QGLContext::choosePixelFormat(), QGLContext::chooseVisual(), and pfiToQGLFormat().
|
inline |
Returns true if multisample buffer support is enabled; otherwise returns false.
The multisample buffer is disabled by default.
Definition at line 658 of file qgl.h.
Referenced by buildSpec(), QGLContext::chooseVisual(), nearest_gl_texture_size(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), qt_eglproperties_set_glformat(), qt_format_to_attrib_list(), QGLContextPrivate::tryFormat(), and QGLWindowSurface::updateGeometry().
int QGLFormat::samples | ( | ) | const |
Returns the number of samples per pixel when multisampling is enabled.
By default, the highest number of samples that is available is used.
Definition at line 824 of file qgl.cpp.
Referenced by buildSpec(), nearest_gl_texture_size(), pfiToQGLFormat(), qt_eglproperties_set_glformat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
void QGLFormat::setAccum | ( | bool | enable | ) |
If enable is true enables the accumulation buffer; otherwise disables the accumulation buffer.
The accumulation buffer is disabled by default.
The accumulation buffer is used to create blur effects and multiple exposures.
Definition at line 694 of file qgl.cpp.
Referenced by QGLContext::chooseVisual(), pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and qt_format_to_attrib_list().
void QGLFormat::setAccumBufferSize | ( | int | size | ) |
Set the preferred accumulation buffer size, where size is the bit depth for each RGBA component.
Definition at line 1143 of file qgl.cpp.
Referenced by pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and qt_glformat_from_eglconfig().
void QGLFormat::setAlpha | ( | bool | enable | ) |
If enable is true enables the alpha buffer; otherwise disables the alpha buffer.
The alpha buffer is disabled by default.
The alpha buffer is typically used for implementing transparency or translucency. The A in RGBA specifies the transparency of a pixel.
Definition at line 664 of file qgl.cpp.
Referenced by QGLContext::chooseVisual(), QGLWindowSurface::hijackWindow(), pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and QMeeGoGraphicsSystem::setTranslucent().
void QGLFormat::setAlphaBufferSize | ( | int | size | ) |
Set the preferred alpha buffer size to size.
This function implicitly enables the alpha channel.
Definition at line 1116 of file qgl.cpp.
Referenced by QGLOverlayWidget::paintGL(), pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and qt_glformat_from_eglconfig().
void QGLFormat::setBlueBufferSize | ( | int | size | ) |
Set the preferred blue buffer size to size.
Definition at line 1085 of file qgl.cpp.
Referenced by pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and qt_glformat_from_eglconfig().
|
static |
Sets a new default QGLFormat for the application to f.
For example, to set single buffering as the default instead of double buffering, your main() might contain code like this:
|
static |
Sets a new default QGLFormat for overlay contexts to f.
This format is used whenever a QGLWidget is created with a format that hasOverlay() enabled.
For example, to get a double buffered overlay context (if available), use code like this:
As usual, you can find out after widget creation whether the underlying OpenGL system was able to provide the requested specification:
Definition at line 1583 of file qgl.cpp.
void QGLFormat::setDepth | ( | bool | enable | ) |
If enable is true enables the depth buffer; otherwise disables the depth buffer.
The depth buffer is enabled by default.
The purpose of a depth buffer (or Z-buffering) is to remove hidden surfaces. Pixels are assigned Z values based on the distance to the viewer. A pixel with a high Z value is closer to the viewer than a pixel with a low Z value. This information is used to decide whether to draw a pixel or not.
Definition at line 599 of file qgl.cpp.
Referenced by QGLContext::chooseVisual(), pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and QGLFBOGLPaintDevice::setFBO().
void QGLFormat::setDepthBufferSize | ( | int | size | ) |
Set the minimum depth buffer size to size.
Definition at line 984 of file qgl.cpp.
Referenced by pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and qt_glformat_from_eglconfig().
void QGLFormat::setDirectRendering | ( | bool | enable | ) |
If enable is true enables direct rendering; otherwise disables direct rendering.
Direct rendering is enabled by default.
Enabling this option will make OpenGL bypass the underlying window system and render directly from hardware to the screen, if this is supported by the system.
Definition at line 787 of file qgl.cpp.
Referenced by pfdToQGLFormat(), pfiToQGLFormat(), and qt_glformat_from_eglconfig().
void QGLFormat::setDoubleBuffer | ( | bool | enable | ) |
If enable is true sets double buffering; otherwise sets single buffering.
Double buffering is enabled by default.
Double buffering is a technique where graphics are rendered on an off-screen buffer and not directly to the screen. When the drawing has been completed, the program calls a swapBuffers() function to exchange the screen contents with the buffer. The result is flicker-free drawing and often better performance.
Note that single buffered contexts are currently not supported with EGL.
Definition at line 566 of file qgl.cpp.
Referenced by QGLContext::chooseVisual(), pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and qt_glformat_from_eglconfig().
void QGLFormat::setGreenBufferSize | ( | int | size | ) |
Set the preferred green buffer size to size.
Definition at line 1050 of file qgl.cpp.
Referenced by pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and qt_glformat_from_eglconfig().
void QGLFormat::setOption | ( | QGL::FormatOptions | opt | ) |
void QGLFormat::setOverlay | ( | bool | enable | ) |
If enable is true enables an overlay plane; otherwise disables the overlay plane.
Enabling the overlay plane will cause QGLWidget to create an additional context in an overlay plane. See the QGLWidget documentation for further information.
Definition at line 912 of file qgl.cpp.
Referenced by pfdToQGLFormat(), and pfiToQGLFormat().
void QGLFormat::setPlane | ( | int | plane | ) |
Sets the requested plane to plane.
0 is the normal plane, 1 is the first overlay plane, 2 is the second overlay plane, etc.; -1, -2, etc. are underlay planes.
Note that in contrast to other format specifications, the plane specifications will be matched exactly. This means that if you specify a plane that the underlying OpenGL system cannot provide, an invalid QGLWidget will be created.
Definition at line 942 of file qgl.cpp.
Referenced by QGLGraphicsSystem::QGLGraphicsSystem(), and qt_glformat_from_eglconfig().
void QGLFormat::setProfile | ( | OpenGLContextProfile | profile | ) |
Set the OpenGL context profile to profile.
The profile is ignored if the requested OpenGL version is less than 3.2.
Definition at line 1270 of file qgl.cpp.
void QGLFormat::setRedBufferSize | ( | int | size | ) |
Set the preferred red buffer size to size.
Definition at line 1015 of file qgl.cpp.
Referenced by pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and qt_glformat_from_eglconfig().
void QGLFormat::setRgba | ( | bool | enable | ) |
If enable is true sets RGBA mode.
If enable is false sets color index mode.
The default color mode is RGBA.
RGBA is the preferred mode for most OpenGL applications. In RGBA color mode you specify colors as red + green + blue + alpha quadruplets.
In color index mode you specify an index into a color lookup table.
Definition at line 633 of file qgl.cpp.
Referenced by pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and qt_glformat_from_eglconfig().
void QGLFormat::setSampleBuffers | ( | bool | enable | ) |
If enable is true, a GL context with multisample buffer support is picked; otherwise ignored.
Definition at line 812 of file qgl.cpp.
Referenced by QGLContext::chooseVisual(), QGLWindowSurface::hijackWindow(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and QMeeGoGraphicsSystem::setTranslucent().
void QGLFormat::setSamples | ( | int | numSamples | ) |
Set the preferred number of samples per pixel when multisampling is enabled to numSamples.
By default, the highest number of samples available is used.
Definition at line 836 of file qgl.cpp.
Referenced by QGLWindowSurface::hijackWindow(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), qt_glformat_from_eglconfig(), and QMeeGoGraphicsSystem::setTranslucent().
void QGLFormat::setStencil | ( | bool | enable | ) |
If enable is true enables the stencil buffer; otherwise disables the stencil buffer.
The stencil buffer is enabled by default.
The stencil buffer masks certain parts of the drawing area so that masked parts are not drawn on.
Definition at line 724 of file qgl.cpp.
Referenced by QGLContext::chooseVisual(), pfdToQGLFormat(), pfiToQGLFormat(), and QGLGraphicsSystem::QGLGraphicsSystem().
void QGLFormat::setStencilBufferSize | ( | int | size | ) |
Set the preferred stencil buffer size to size.
Definition at line 1169 of file qgl.cpp.
Referenced by pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and qt_glformat_from_eglconfig().
void QGLFormat::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.
Definition at line 754 of file qgl.cpp.
Referenced by QGLContext::chooseVisual(), pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), and qt_glformat_from_eglconfig().
void QGLFormat::setSwapInterval | ( | int | interval | ) |
Set the preferred swap interval.
This can be used to sync the GL drawing into a system 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.
Under Windows and under X11, where the WGL_EXT_swap_control
and GLX_SGI_video_sync
extensions are used, the interval parameter can be used to set the minimum number of video frames that are displayed before a buffer swap will occur. In effect, setting the interval to 10, means there will be 10 vertical retraces between every buffer swap.
Under Windows the WGL_EXT_swap_control
extension has to be present, and under X11 the GLX_SGI_video_sync
extension has to be present.
Definition at line 868 of file qgl.cpp.
void QGLFormat::setVersion | ( | int | major, |
int | minor | ||
) |
Set the OpenGL version to the major and minor numbers.
If a context compatible with the requested OpenGL version cannot be created, a context compatible with version 1.x is created instead.
Definition at line 1202 of file qgl.cpp.
|
inline |
Returns true if the stencil buffer is enabled; otherwise returns false.
The stencil buffer is enabled by default.
Definition at line 638 of file qgl.h.
Referenced by buildSpec(), QGLContext::choosePixelFormat(), QGLContext::chooseVisual(), QGL2PaintEngineExPrivate::fill(), nearest_gl_texture_size(), pfdToQGLFormat(), pfiToQGLFormat(), QGLGraphicsSystem::QGLGraphicsSystem(), qt_eglproperties_set_glformat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
int QGLFormat::stencilBufferSize | ( | ) | const |
Returns the stencil buffer size.
Definition at line 1185 of file qgl.cpp.
Referenced by buildSpec(), nearest_gl_texture_size(), pfiToQGLFormat(), qt_eglproperties_set_glformat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
|
inline |
Returns true if stereo buffering is enabled; otherwise returns false.
Stereo buffering is disabled by default.
Definition at line 643 of file qgl.h.
Referenced by buildSpec(), QGLContext::choosePixelFormat(), QGLContext::chooseVisual(), nearest_gl_texture_size(), pfiToQGLFormat(), qt_format_to_attrib_list(), and QGLContextPrivate::tryFormat().
int QGLFormat::swapInterval | ( | ) | const |
bool QGLFormat::testOption | ( | QGL::FormatOptions | opt | ) | const |
Returns true if format option opt is set; otherwise returns false.
Definition at line 971 of file qgl.cpp.
Referenced by qgl_create_context().
|
friend |
Definition at line 1620 of file qgl.cpp.
|
private |
Definition at line 290 of file qgl.h.
Referenced by QGLContext::doneCurrent(), QGLContext::makeCurrent(), operator=(), qDeleteQGLContext(), QGLFormat(), QGLContext::reset(), and QGLContext::swapBuffers().