File: imagejpeg.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (73 lines) | stat: -rw-r--r-- 2,514 bytes parent folder | download
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
71
72
73
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/image.xml, last change in rev 1.30 -->
  <refentry id="function.imagejpeg">
   <refnamediv>
    <refname>imagejpeg</refname>
    <refpurpose>Output image to browser or file</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>imagejpeg</methodname>
      <methodparam><type>resource</type><parameter>image</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>quality</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>imagejpeg</function> creates the
     <acronym>JPEG</acronym> file in filename from the image
     <parameter>image</parameter>. The <parameter>image</parameter> argument
     is the return from the <function>imagecreate</function> function.
    </para>
    <para>
     The filename argument is optional, and if left off, the raw image
     stream will be output directly.  To skip the filename argument in
     order to provide a quality argument just use an empty string
     ('').  By sending an image/jpeg content-type using
     <function>header</function>, you can create a PHP script that
     outputs JPEG images directly.
    </para>
    
    &note.config.jpeg;
    
    <para>
     <parameter>quality</parameter> is optional, and ranges from
     0 (worst quality, smaller file) to 100 (best quality, biggest file).
     The default is the default IJG quality value (about 75).
    </para>
    <para>
     If you want to output Progressive JPEGs, you need to set interlacing
     on with <function>imageinterlace</function>.
    </para>
    <para>
     See also
     <function>imagepng</function>,
     <function>imagegif</function>,
     <function>imagewbmp</function>,
     <function>imageinterlace</function> and
     <function>imagetypes</function>.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->