Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 745c33bedb7adf2679753c548bf7c4e1d658f99c / . / www / api / display.html
blob: 1c345851eaab35890a0ed35877d91ef7ac01f3c7 [file] [log] [blame]
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
7 <style type="text/css" media="screen,projection"><!--
8 @import url("../../www/magick.css");
9 --></style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
11 <title>ImageMagick: MagickCore, C API for ImageMagick: Interactively Display and Edit an Image</title>
12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
15 <meta name="Generator" content="PHP"/>
16 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, interactively, display, edit, an, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
17 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
18 <meta name="Rating" content="GENERAL"/>
19 <meta name="Robots" content="INDEX, FOLLOW"/>
20 <meta name="Generator" content="ImageMagick Studio LLC"/>
21 <meta name="Author" content="ImageMagick Studio LLC"/>
22 <meta name="Revisit-after" content="2 DAYS"/>
23 <meta name="Resource-type" content="document"/>
24 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25 <meta name="Distribution" content="Global"/>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]26</head>
27
28<body id="www-imagemagick-org">
29<div class="titlebar">
30<a href="../../index.html">
31 <img src="../../images/script.png" alt="[ImageMagick]"
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
33<a href="http://www.networkredux.com">
34 <img src="../../images/networkredux.png" alt="[sponsor]"
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
36<a href="http://www.imagemagick.org/discourse-server/">
37 <img src="../../images/logo.jpg" alt=""
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
39<a href="../../index.html">
40 <img src="../../images/sprite.jpg" alt=""
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
42</div>
43
44<div class="eastbar">
45
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]49<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
52</div>
53<div class="sub">
54 <a href="../../www/command-line-processing.html">Processing</a>
55</div>
56<div class="sub">
57 <a href="../../www/command-line-options.html">Options</a>
58</div>
59<div class="sub">
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
61</div>
62<div class="menu">
63 <a href="../../www/api.html">Program Interfaces</a>
64</div>
65<div class="sub">
66 <a href="../../www/magick-wand.html">MagickWand</a>
67</div>
68<div class="sub">
69 <a href="../../www/magick-core.html">MagickCore</a>
70</div>
71<div class="sub">
72 <a href="../../www/perl-magick.html">PerlMagick</a>
73</div>
74<div class="sub">
75 <a href="../../Magick++/">Magick++</a>
76</div>
77<div class="menu">
78 <a href="../../www/architecture.html">Architecture</a>
79</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81<div class="menu">
82 <a href="../../www/install-source.html">Install from Source</a>
83</div>
84<div class="sub">
85 <a href="../../www/install-source.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a href="../../www/install-source.html#windows">Windows</a>
89 </div>
90<div class="menu">
91 <a href="../../www/binary-releases.html">Binary Releases</a>
92</div>
93<div class="sub">
94 <a href="../../www/binary-releases.html#unix">Unix</a>
95</div>
96<div class="sub">
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
98</div>
99<div class="sub">
100 <a href="../../www/binary-releases.html#windows">Windows</a>
101</div>
102<div class="menu">
103 <a href="../../www/resources.html">Resources</a>
104</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]105<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]109<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
115 <a href="../../www/sitemap.html">Site Map</a>
116</div>
117<div class="sub">
118 <a href="../../www/links.html">Links</a>
119</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]120<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
126 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
127</div>
128<div class="sponsor">
129 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
130</div>
131<div class="sponsor">
132 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
133</div>
134<div class="sponsor">
135 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
136</div>
137<div class="sponsor">
138 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
139</div>
140</div>
141</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]142
143
144</div>
145
146<div class="main">
147
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<p class="navigation-index">[<a href="#DisplayImages">DisplayImages</a> &bull; <a href="#RemoteDisplayCommand">RemoteDisplayCommand</a> &bull; <a href="#XDisplayBackgroundImage">XDisplayBackgroundImage</a>]</p>
149
150<h2><a href="http://www.imagemagick.org/api/MagickCore/display
151_8c.html" target="source" name="DisplayImages">DisplayImages</a></h2>
152<div class="doc-section">
153
154<p>DisplayImages() displays an image sequence to any X window screen. It returns a value other than 0 if successful. Check the exception member of image to determine the reason for any failure.</p></ol>
155
156<p>The format of the DisplayImages method is:</p>
157
158<pre class="code">
159 MagickBooleanType DisplayImages(const ImageInfo *image_info,
160 Image *images)
161</pre>
162
163<p>A description of each parameter follows:</p></ol>
164
165<h5>image_info</h5>
166<ol><p>the image info.</p></ol>
167
168<h5>image</h5>
169<ol><p>the image.</p></ol>
170
171 </div>
172<h2><a href="http://www.imagemagick.org/api/MagickCore/display
173_8c.html" target="source" name="RemoteDisplayCommand">RemoteDisplayCommand</a></h2>
174<div class="doc-section">
175
176<p>RemoteDisplayCommand() encourages a remote display program to display the specified image filename.</p></ol>
177
178<p>The format of the RemoteDisplayCommand method is:</p>
179
180<pre class="code">
181 MagickBooleanType RemoteDisplayCommand(const ImageInfo *image_info,
182 const char *window,const char *filename,ExceptionInfo *exception)
183</pre>
184
185<p>A description of each parameter follows:</p></ol>
186
187<h5>image_info</h5>
188<ol><p>the image info.</p></ol>
189
190<h5>window</h5>
191<ol><p>Specifies the name or id of an X window.</p></ol>
192
193<h5>filename</h5>
194<ol><p>the name of the image filename to display.</p></ol>
195
196<h5>exception</h5>
197<ol><p>return any errors or warnings in this structure.</p></ol>
198
199 </div>
200<h2><a href="http://www.imagemagick.org/api/MagickCore/display
201_8c.html" target="source" name="XDisplayBackgroundImage">XDisplayBackgroundImage</a></h2>
202<div class="doc-section">
203
204<p>XDisplayBackgroundImage() displays an image in the background of a window.</p></ol>
205
206<p>The format of the XDisplayBackgroundImage method is:</p>
207
208<pre class="code">
209 MagickBooleanType XDisplayBackgroundImage(Display *display,
210 XResourceInfo *resource_info,Image *image)
211</pre>
212
213<p>A description of each parameter follows:</p></ol>
214
215<h5>display</h5>
216<ol><p>Specifies a connection to an X server; returned from XOpenDisplay.</p></ol>
217
218<h5>resource_info</h5>
219<ol><p>Specifies a pointer to a X11 XResourceInfo structure.</p></ol>
220
221<h5>image</h5>
222<ol><p>the image.</p></ol>
223
224 </div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]225
226</div>
227
228<div id="linkbar">
229 <!-- <span id="linkbar-west">&nbsp;</span> -->
230 <span id="linkbar-center">
231 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
232 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
233 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
234 </span>
235 <span id="linkbar-east">&nbsp;</span>
236 </div>
237 <div class="footer">
238 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
239 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
240 </div>
241 <div style="clear: both; margin: 0; width: 100%; "></div>
242</body>
243</html>