summaryrefslogtreecommitdiff
path: root/opcodes/imagesave.xml
blob: c62978e6b78cb96345c62e49fcc7208d820af485 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<refentry id="imagesave">
  <indexterm id="IndexImagesave"><primary>imagesave</primary></indexterm>
  <refentryinfo><title>Image Processing Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>imagesave</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>imagesave</refname>
    <refpurpose>
      Save a previously created image.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Save a previously created image. An empty image can be created with <link linkend="imagecreate"><citetitle>imagecreate</citetitle></link> and its pixel RGB values can be set with <link linkend="imagesetpixel"><citetitle>imagesetpixel</citetitle></link>. The image will be saved in PNG format.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>imagesave</command> iimagenum, filename</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>iimagenum</emphasis> -- the reference of the image to be save. It should be a value returned by <link linkend="imagecreate"><citetitle>imagecreate</citetitle></link>.
    </para>
    <para>
      <emphasis>filename</emphasis> -- The filename to use to save the image.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the imagesave opcode. It uses the file <ulink url="examples/imageopcodes.csd"><citetitle>imageopcodes.csd</citetitle></ulink>.
      <example>
        <title>Example of the imagesave opcode.</title>
        <xi:include href="examples-xml/imageopcodes.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="imageload"><citetitle>imageload</citetitle></link>,
      <link linkend="imagecreate"><citetitle>imagecreate</citetitle></link>,
      <link linkend="imagesize"><citetitle>imagesize</citetitle></link>,
      <link linkend="imagegetpixel"><citetitle>imagegetpixel</citetitle></link>,
      <link linkend="imagesetpixel"><citetitle>imagesetpixel</citetitle></link>,
      <link linkend="imagefree"><citetitle>imagefree</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: Cesare Marilungo</member>
      </simplelist>
    </para>
    <para>New in version 5.08</para>
  </refsect1>
</refentry>