source: trunk/doc/src/platforms/x11overlays.qdoc@ 564

Last change on this file since 564 was 561, checked in by Dmitry A. Kuminov, 15 years ago

trunk: Merged in qt 4.6.1 sources.

  • Property svn:eol-style set to native
File size: 4.6 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the documentation of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you have questions regarding the use of this file, please contact
37** Nokia at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42/*!
43 \page x11overlays.html
44 \title How to Use X11 Overlays with Qt
45
46 X11 overlays are a powerful mechanism for drawing
47 annotations etc., on top of an image without destroying it, thus saving
48 a great deal of image rendering time. For more information, see the highly
49 recommended book \e{OpenGL Programming for the X Window System} (Mark
50 Kilgard, Addison Wesley Developers Press 1996).
51
52 \warning The Qt OpenGL Extension includes direct support for the
53 use of OpenGL overlays. For many uses of overlays, this makes the
54 technique described below redundant. The following is a discussion
55 on how to use non-QGL widgets in overlay planes.
56
57 In the typical case, X11 overlays can easily be used together with the
58 current version of Qt and the Qt OpenGL Extension. The following
59 requirements apply:
60
61 \list 1
62 \i Your X server and graphics card/hardware must support overlays.
63 For many X servers, overlay support can be turned on with
64 a configuration option; consult your X server installation
65 documentation.
66
67 \i Your X server must (be configured to) use an overlay visual as the