Dynamic GL switch on Windows
authorLaszlo Agocs <laszlo.agocs@digia.com>
Mon, 27 Jan 2014 13:45:11 +0000 (14:45 +0100)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Fri, 14 Feb 2014 09:51:44 +0000 (10:51 +0100)
commit97c187da3c1381bc55dd16976bf9fb3c773d0047
treea101467c838879b025bdfb4b5f7b18a6ad8b3033
parentf25aca5c658b018e3b510990d82e7195d0c3b7c0
Dynamic GL switch on Windows

The patch introduces a new build configuration on Windows which
can be requested by passing -opengl dynamic to configure.

Platforms other than Windows (including WinRT) are not affected.
The existing Angle and desktop configurations are not affected.
These continue to function as before and Angle remains the default.

In the future, when all modules have added support for the dynamic
path, as described below, the default configuration could be changed
to be the dynamic one. This would allow providing a single set of
binaries in the official builds instead of the current two.

When requesting dynamic GL, Angle is built but QT_OPENGL_ES[_2] are
never defined. Instead, the code path that has traditionally been
desktop GL only becomes the dynamic path that has to do runtime
checks. Qt modules and applications are not linked to opengl32.dll or
libegl/glesv2.dll in this case. Instead, QtGui exports all necessary
egl/egl/gl functions which will, under the hood, forward all requests
to a dynamically loaded EGL/WGL/GL implementation.

Porting guide (better said, changes needed to prepare your code to
work with dynamic GL builds when the fallback to Angle is utilized):

1. In !QT_OPENGL_ES[_2] code branches use QOpenGLFunctions::isES() to
differentiate between desktop and ES where needed. Keep in mind that
it is the desktop GL header (plus qopenglext.h) that is included,
not the GLES one.

QtGui's proxy will handle some differences, for example calling
glClearDepth will route to glClearDepthf when needed. The built-in
eglGetProcAddress is able to retrieve pointers for standard GLES2
functions too so code resolving OpenGL 2 functions will function
in any case.

2. QT_CONFIG will contain "opengl" and "dynamicgl" in dynamic builds,
but never "angle" or "opengles2".

3. The preprocessor define QT_OPENGL_DYNAMIC is also available in
dynamic builds. The usage of this is strongly discouraged and should
not be needed anywhere except for QtGui and the platform plugin.

4. Code in need of the library handle can use
QOpenGLFunctions::platformGLHandle().

The decision on which library to load is currently based on a simple
test that creates a dummy window/context and tries to resolve an
OpenGL 2 function. If this fails, it goes for Angle. This seems to work
well on Win7 PCs for example that do not have proper graphics drivers
providing OpenGL installed but are D3D9 capable using the default drivers.

Setting QT_OPENGL to desktop or angle skips the test and forces
usage of the given GL. There are also two new application attributes
that could be used for the same purpose.

If Angle is requested but the libraries are not present, desktop is
tried. If desktop is requested, or if angle is requested but nothing
works, the EGL/WGL functions will still be callable but will return 0.
This conveniently means that eglInitialize() and such will report a failure.

Debug messages can be enabled by setting QT_OPENGLPROXY_DEBUG. This will
tell which implementation is chosen.

The textures example application is ported to OpenGL 2, the GL 1
code path is removed.

[ChangeLog][QtGui] Qt builds on Windows can now be configured for
dynamic loading of the OpenGL implementation. This can be requested
by passing -opengl dynamic to configure. In this mode no modules will
link to opengl32.dll or Angle's libegl/libglesv2. Instead, QtGui will
dynamically choose between desktop and Angle during the first GL/EGL/WGL
call. This allows deploying applications with a single set of Qt libraries
with the ability of transparently falling back to Angle in case the
opengl32.dll is not suitable, due to missing graphics drivers for example.

Task-number: QTBUG-36483
Change-Id: I716fdebbf60b355b7d9ef57d1e069eef366b4ab9
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
Reviewed-by: Jørgen Lind <jorgen.lind@digia.com>
61 files changed:
examples/opengl/textures/glwidget.cpp
examples/opengl/textures/glwidget.h
mkspecs/win32-g++/qmake.conf
mkspecs/win32-icc/qmake.conf
mkspecs/win32-msvc2005/qmake.conf
mkspecs/win32-msvc2008/qmake.conf
mkspecs/win32-msvc2010/qmake.conf
mkspecs/win32-msvc2012/qmake.conf
mkspecs/win32-msvc2013/qmake.conf
src/corelib/global/qnamespace.h
src/corelib/global/qnamespace.qdoc
src/gui/gui.pro
src/gui/kernel/qopenglcontext.cpp
src/gui/opengl/opengl.pri
src/gui/opengl/qopengl.h
src/gui/opengl/qopenglbuffer.cpp
src/gui/opengl/qopenglengineshadermanager.cpp
src/gui/opengl/qopenglengineshadersource_p.h
src/gui/opengl/qopenglframebufferobject.cpp
src/gui/opengl/qopenglframebufferobject.h
src/gui/opengl/qopenglframebufferobject_p.h
src/gui/opengl/qopenglfunctions.cpp
src/gui/opengl/qopenglfunctions.h
src/gui/opengl/qopenglpaintengine.cpp
src/gui/opengl/qopenglproxy_win.cpp [new file with mode: 0644]
src/gui/opengl/qopenglshaderprogram.cpp
src/gui/opengl/qopengltexture.cpp
src/gui/opengl/qopengltextureglyphcache.cpp
src/gui/opengl/qopengltexturehelper.cpp
src/gui/opengl/qopengltexturehelper_p.h
src/gui/opengl/qopengltimerquery.cpp
src/gui/opengl/qopenglvertexarrayobject.cpp
src/opengl/gl2paintengineex/qglengineshadermanager.cpp
src/opengl/gl2paintengineex/qglengineshadersource_p.h
src/opengl/gl2paintengineex/qpaintengineex_opengl2.cpp
src/opengl/gl2paintengineex/qtextureglyphcache_gl.cpp
src/opengl/qgl.cpp
src/opengl/qgl_qpa.cpp
src/opengl/qglbuffer.cpp
src/opengl/qglframebufferobject.cpp
src/opengl/qglframebufferobject.h
src/opengl/qglframebufferobject_p.h
src/opengl/qglfunctions.cpp
src/opengl/qglfunctions.h
src/opengl/qglpixelbuffer.cpp
src/opengl/qglshaderprogram.cpp
src/platformsupport/eglconvenience/eglconvenience.pri
src/platformsupport/eglconvenience/qeglconvenience.cpp
src/platformsupport/eglconvenience/qeglplatformcontext.cpp
src/plugins/platforms/windows/qwindowseglcontext.cpp
src/plugins/platforms/windows/qwindowsintegration.cpp
src/plugins/platforms/windows/qwindowsnativeinterface.cpp
src/plugins/platforms/windows/qwindowswindow.cpp
src/plugins/platforms/windows/qwindowswindow.h
src/plugins/platforms/windows/windows.pri
src/src.pro
tests/auto/opengl/qgl/tst_qgl.cpp
tests/auto/opengl/qglfunctions/tst_qglfunctions.cpp
tests/auto/opengl/qglthreads/tst_qglthreads.cpp
tests/auto/widgets/widgets/qmdiarea/tst_qmdiarea.cpp
tools/configure/configureapp.cpp