← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to tools/qvfb/README

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-08-24 04:09:09 UTC
  • Revision ID: james.westby@ubuntu.com-20050824040909-xmxe9jfr4a0w5671
Tags: upstream-4.0.0
Import upstream version 4.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/qvfb/README
 
1
Qt/Embedded Virtual Framebuffer
 
2
===============================
 
3
 
 
4
Please note that the qvfb program needs to be compiled with the X11 version
 
5
of Qt.
 
6
 
 
7
The virtual frame buffer allows a Qt/Embedded program to be developed on your
 
8
desktop machine, without switching between consoles and X11.  The virtual
 
9
framebuffer consists of a shared memory region (the virtual frame buffer)
 
10
and a utility to display the framebuffer in a window.  The display is updated
 
11
periodically, so you will see discrete snapshots of the framebuffer rather
 
12
than each individual drawing operation.  For this reason drawing problems
 
13
such as flickering may not be apparent until the program is run using a real
 
14
framebuffer.
 
15
 
 
16
To use the virtual framebuffer:
 
17
 
 
18
1. Ensure QT_NO_QWS_VFB is not set in qconfig.h (when you configure Qt,
 
19
   add the -qvfb option).
 
20
2. Start qvfb (qvfb should be compiled as a normal Qt/X11 application,
 
21
   NOT as a Qt/Embedded application!).
 
22
3. Start a Qt/Embedded server (i.e. construct QApplication with
 
23
   QApplication::GuiServer flag, or run a client with the -qws option).
 
24
 
 
25
qvfb supports the following command line options:
 
26
 
 
27
[-width width]   the width of the virtual framebuffer (default: 240).
 
28
[-height height] the height of the virtual framebuffer (default: 320).
 
29
[-depth depth]   the depth of the virtual framebuffer (1,4,8 or 32, default: 8).
 
30
[-nocursor]      do not display the X11 cursor in the framebuffer window.
 
31
[-qwsdisplay]    the Qt/Embedded display ID, e.g. -qwsdisplay :1 (default :0).
 
32
[-skin skinfile] tells qvfb to load a skin file, e.g. -skin pda.skin
 
33
 
 
34
Please refer to the file "pda.skin" for an example of what a skin file looks like.
 
35
The format for skin files is:
 
36
    Image filename of skin with buttons in their up positions
 
37
    Image filename of skin with buttons in their down positions
 
38
    X offset of top left corner of the virtual screen on the skin image
 
39
    Y offset of top left corner of the virtual screen on the skin image
 
40
    Width of the virtual screen on the skin image
 
41
    Height of the virtual screen on the skin image
 
42
    Transparancy level of the Virtual Frame Buffer
 
43
    Number of defined button regions
 
44
Then for each button region the format is:
 
45
    Button identifier
 
46
    Qt scan codes to generate for the button
 
47
    Top left X coordinate of the button region
 
48
    Top left Y coordinate of the button region
 
49
    Bottom right X coordinate of the button region
 
50
    Bottom right Y coordinate of the button region
 
51
 
 
52
The virtual framebuffer is a development tool only.  No security issues have
 
53
been considered in the virtual framebuffer design.  It should not be used
 
54
in a production environment and QT_NO_QWS_VFB should always be in force
 
55
in production libraries.