php-doc-en/reference/image/functions/imagecreate.xml
Adam Harvey 2c37319ca0 Expand on why imagecreate() isn't such a smart idea nowadays.
Fixes doc bug #65777 (Unconditional recommendation not to use imagecreate is
misleading).


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331628 c90b9560-bf6c-de11-be94-00142212c4b1
2013-10-01 17:11:26 +00:00

117 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagecreate" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagecreate</refname>
<refpurpose>Create a new palette based image</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>imagecreate</methodname>
<methodparam><type>int</type><parameter>width</parameter></methodparam>
<methodparam><type>int</type><parameter>height</parameter></methodparam>
</methodsynopsis>
<para>
<function>imagecreate</function> returns an image identifier
representing a blank image of specified size.
</para>
<para>
In general, we recommend the use of
<function>imagecreatetruecolor</function> instead of
<function>imagecreate</function> so that image processing occurs on the
highest quality image possible. If you want to output a palette image, then
<function>imagetruecolortopalette</function> should be called immediately
before saving the image with <function>imagepng</function> or
<function>imagegif</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
The image width.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
The image height.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&gd.return.identifier;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
Creating a new GD image stream and outputting an image.
</title>
<programlisting role="php">
<![CDATA[
<?php
header("Content-Type: image/png");
$im = @imagecreate(110, 20)
or die("Cannot Initialize new GD image stream");
$background_color = imagecolorallocate($im, 0, 0, 0);
$text_color = imagecolorallocate($im, 233, 14, 91);
imagestring($im, 1, 5, 5, "A Simple Text String", $text_color);
imagepng($im);
imagedestroy($im);
?>
]]>
</programlisting>
&example.outputs.similar;
<mediaobject>
<alt>Output of example : Creating a new GD image stream and outputting an image.</alt>
<imageobject>
<imagedata fileref="en/reference/image/figures/imagecreate.png"/>
</imageobject>
</mediaobject>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imagedestroy</function></member>
<member><function>imagecreatetruecolor</function></member>
</simplelist>
</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:"~/.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
-->