reference/image/functions/imagegrabscreen.xml
593ea510e853ff034e03f78a4be0daa41661c9d4
...
...
@@ -9,30 +9,54 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>imagegrabscreen</methodname>
13
-
<void />
12
+
<type class="union"><type>GdImage</type><type>false</type></type><methodname>imagegrabscreen</methodname>
13
+
<void/>
14
14
</methodsynopsis>
15
15
<para>
16
16
Grabs a screenshot of the whole screen.
17
17
</para>
18
+
<note>
19
+
<para>
20
+
This function is only available on Windows.
21
+
</para>
22
+
</note>
18
23
</refsect1>
19
24

20
-
<!--
21
25
<refsect1 role="parameters">
22
26
&reftitle.parameters;
23
-
<para>
24
-
This function takes no parameters.
25
-
</para>
27
+
&no.function.parameters;
26
28
</refsect1>
27
-
-->
28
29

29
30
<refsect1 role="returnvalues">
30
31
&reftitle.returnvalues;
31
32
<para>
32
-
Returns an image resource identifier on success, &false; on failure.
33
+
Returns an image object on success, &false; on failure.
33
34
</para>
34
35
</refsect1>
35
36

37
+
<refsect1 role="changelog">
38
+
&reftitle.changelog;
39
+
<informaltable>
40
+
<tgroup cols="2">
41
+
<thead>
42
+
<row>
43
+
<entry>&Version;</entry>
44
+
<entry>&Description;</entry>
45
+
</row>
46
+
</thead>
47
+
<tbody>
48
+
<row>
49
+
<entry>8.0.0</entry>
50
+
<entry>
51
+
On success, this function returns a <classname>GDImage</classname> instance now;
52
+
previously, a <type>resource</type> was returned.
53
+
</entry>
54
+
</row>
55
+
</tbody>
56
+
</tgroup>
57
+
</informaltable>
58
+
</refsect1>
59
+

36
60
<!--
37
61
<refsect1 role="errors">
38
62
&reftitle.errors;
...
...
@@ -64,25 +88,13 @@ imagedestroy($im);
64
88
</para>
65
89
</refsect1>
66
90

67
-
<refsect1 role="notes">
68
-
&reftitle.notes;
69
-
<note>
70
-
<para>
71
-
This function is only available on Windows.
72
-
</para>
73
-
</note>
74
-
</refsect1>
75
-

76
91
<refsect1 role="seealso">
77
92
&reftitle.seealso;
78
-
<para>
79
-
<simplelist>
80
-
<member><function>imagegrabwindow</function></member>
81
-
</simplelist>
82
-
</para>
93
+
<simplelist>
94
+
<member><function>imagegrabwindow</function></member>
95
+
</simplelist>
83
96
</refsect1>
84
97
</refentry>
85
-

86
98
<!-- Keep this comment at the end of the file
87
99
Local variables:
88
100
mode: sgml
...
...
@@ -103,4 +115,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
103
115
vim: et tw=78 syn=sgml
104
116
vi: ts=1 sw=1
105
117
-->
106
-

107
118