php-doc-en/reference/image/functions/imagecreatetruecolor.xml
Pierre Joye 45fa04b9ed - remove wrong note
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@298669 c90b9560-bf6c-de11-be94-00142212c4b1
2010-04-27 18:40:08 +00:00

121 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagecreatetruecolor" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagecreatetruecolor</refname>
<refpurpose>Create a new true color image</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>imagecreatetruecolor</methodname>
<methodparam><type>int</type><parameter>width</parameter></methodparam>
<methodparam><type>int</type><parameter>height</parameter></methodparam>
</methodsynopsis>
<para>
<function>imagecreatetruecolor</function> returns an image identifier
representing a black image of the specified size.
</para>
<para>
Depending on your PHP and GD versions this function is defined or not. With
PHP 4.0.6 through 4.1.x this function always exists if the GD module is
loaded, but calling it without GD2 being installed PHP will issue a fatal
error and exit. With PHP 4.2.x this behaviour is different in issuing a
warning instead of an error. Other versions only define this function, if
the correct GD version is installed.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
Image width.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
Image height.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an image resource identifier on success, &false; on errors.
</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 = @imagecreatetruecolor(120, 20)
or die('Cannot Initialize new GD image stream');
$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/imagecreatetruecolor.png"/>
</imageobject>
</mediaobject>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.gd.2;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imagedestroy</function></member>
<member><function>imagecreate</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
-->