|
1 # grabscreen.cif |
|
2 # |
|
3 # Copyright (c) 2010 Accenture. All rights reserved. |
|
4 # This component and the accompanying materials are made available |
|
5 # under the terms of the "Eclipse Public License v1.0" |
|
6 # which accompanies this distribution, and is available |
|
7 # at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 # |
|
9 # Initial Contributors: |
|
10 # Accenture - Initial contribution |
|
11 # |
|
12 |
|
13 ==name grabscreen |
|
14 |
|
15 ==short-description |
|
16 |
|
17 Creates a bitmap file of the current contents of the screen. |
|
18 |
|
19 ==long-description |
|
20 |
|
21 Creates a bitmap file (by default in JPEG format) of the current contents of the screen. Only operates in graphical environments. |
|
22 |
|
23 ==argument filename file_name optional |
|
24 |
|
25 The name of the bitmap file write. If not specified, writes to STDOUT. Must be specified when using raw format. |
|
26 |
|
27 ==option enum f format |
|
28 |
|
29 The required output format; defaults to 'jpeg'. 'raw' is the format produced by CFbsBitmap::Save. |
|
30 |
|
31 ==enum-value jpeg |
|
32 |
|
33 ==enum-value gif |
|
34 |
|
35 ==enum-value bmp |
|
36 |
|
37 ==enum-value png |
|
38 |
|
39 ==enum-value raw |
|
40 |
|
41 ==option int r rect multiple |
|
42 |
|
43 The required rectangle to capture, specified as four integers corresponding to top left x, top left y, bottom right x and bottom right y. For example, C<--rect 10,15,50,65>. |
|
44 |
|
45 ==option int s screen |
|
46 |
|
47 The required screen to capture from. Defaults to zero. |
|
48 |
|
49 ==option int q quality |
|
50 |
|
51 The desired image quality. For 'jpeg', a value in the range 0-100. |
|
52 |
|
53 ==option bool g greyscale |
|
54 |
|
55 Encode the screen as greyscale rather than colour, for a smaller file size. Supported for 'jpeg' and 'png'. |
|
56 |
|
57 ==copyright |
|
58 |
|
59 Copyright (c) 2008-2010 Accenture. All rights reserved. |
|
60 |