<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<refentry xml:id="function.imagegd" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>imagegd</refname>

<refpurpose>Output GD image to browser or file</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>imagegd</methodname>

<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>file</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

Outputs a GD image to the given <parameter>file</parameter>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

&gd.image.description;

<varlistentry>

<term><parameter>file</parameter></term>

<listitem>

<para>&gd.image.path;</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&return.success;

</para>

&gd.return.trueonerror;

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<para>

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.0.3</entry>

<entry>

<parameter>file</parameter> is now nullable.

</entry>

</row>

&gd.changelog.image-param;

<row>

<entry>7.2.0</entry>

<entry>

<function>imagegd</function> now allows to output truecolor images.

Formerly, these have been implicitly converted to palette.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Outputting a GD image</title>

<programlisting role="php">

<![CDATA[

<?php

// Create a blank image and add some text

$im = imagecreatetruecolor(120, 20);

$text_color = imagecolorallocate($im, 233, 14, 91);

imagestring($im, 1, 5, 5, "A Simple Text String", $text_color);

// Output the image

imagegd($im);

// Free up memory

imagedestroy($im);

?>

]]>

</programlisting>

</example>

</para>

<para>

<example>

<title>Saving a GD image</title>

<programlisting role="php">

<![CDATA[

<?php

// Create a blank image and add some text

$im = imagecreatetruecolor(120, 20);

$text_color = imagecolorallocate($im, 233, 14, 91);

imagestring($im, 1, 5, 5, "A Simple Text String", $text_color);

// Save the gd image

// The file format for GD images is .gd, see http://www.libgd.org/GdFileFormats

imagegd($im, 'simple.gd');

// Free up memory

imagedestroy($im);

?>

]]>

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

The GD format is commonly used to allow fast loading of parts of images.

Note that the GD format is only usable in GD-compatible applications.

</para>

</note>

&gd.deprecated.gd-formats;

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member><function>imagegd2</function></member>

</simplelist>

</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:"~/.phpdoc/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

-->