Update copyright headers
[qt:qt.git] / doc / src / platforms / wince-opengl.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the documentation of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Free Documentation License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Free
19 ** Documentation License version 1.3 as published by the Free Software
20 ** Foundation and appearing in the file included in the packaging of
21 ** this file.  Please review the following information to ensure
22 ** the GNU Free Documentation License version 1.3 requirements
23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
24 ** $QT_END_LICENSE$
25 **
26 ****************************************************************************/
27
28 /*!
29     \page windowsce-opengl.html
30     \title Qt for Windows CE and OpenGL ES
31     \ingroup qtce
32     \brief Information about support for OpenGL ES with Qt for Windows CE.
33
34     \input platforms/emb-opengl.qdocinc
35
36 \section1 Using OpenGL with Qt for Windows CE
37 Qt for Windows CE uses EGL 1.1 to embed OpenGL ES windows within the
38 Windows CE window manager.
39
40 \section2 Configure
41
42 To configure Qt for Windows Mobile 5.0 and OpenGL ES Common support
43 you can run \c{configure} like this:
44
45     \snippet doc/src/snippets/code/doc_src_wince-opengl.qdoc 0
46
47 OpenGL ES includes profiles for floating-point and fixed-point arithmetic.
48 The floating point profile is called OpenGL ES CM (Common) and the
49 fixed-point profile is called OpenGL ES CL (Common Lite).
50 The fixed-point profile is no longer supported since Qt 4.7.
51
52 You can run \c{configure} with the \c{-opengl-es-cm} option for the Common
53 profile.  Ensure that the \c{lib} and \c{includes} paths include the OpenGL ES
54 headers and libararies from your SDK. The OpenGL ES lib should be called
55 either \c{libGLES_CM.lib} for the Common profile.
56
57 To start programming with Qt and OpenGL ES on Windows CE, you can start
58 with the \l{Hello GL ES Example}. This example shows how to use QGLWidget
59 and QGLPainter with OpenGL ES. It also provides some hints on how to port
60 OpenGL code to OpenGL ES.
61
62 \section2 Using OpenGL to Accelerate Normal 2D Painting
63
64 Qt provides QOpenGLPaintEngine, a subclass of QPaintEngine that translates
65 QPainter operations into OpenGL calls. This is especially convenient for
66 drawing text or QImage objects in an OpenGL ES context. For further
67 details, refer to the \l{Hello GL ES Example}.
68
69 */