mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
142 lines
3.7 KiB
XML
142 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.imagecolorallocate" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>imagecolorallocate</refname>
|
|
<refpurpose>Allocate a color for an image</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>int</type><type>false</type></type><methodname>imagecolorallocate</methodname>
|
|
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>red</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>green</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>blue</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns a color identifier representing the color composed of the given
|
|
<acronym>RGB</acronym> components.
|
|
</para>
|
|
<para>
|
|
<function>imagecolorallocate</function> must be called
|
|
to create each color that is to be used in the image represented
|
|
by <parameter>image</parameter>.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
The first call to <function>imagecolorallocate</function> fills
|
|
the background color in palette-based images - images created using
|
|
<function>imagecreate</function>.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&gd.image.description;
|
|
<varlistentry>
|
|
<term><parameter>red</parameter></term>
|
|
<listitem>
|
|
<para>&gd.value.red;</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>green</parameter></term>
|
|
<listitem>
|
|
<para>&gd.value.green;</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>blue</parameter></term>
|
|
<listitem>
|
|
<para>&gd.value.blue;</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
These parameters are integers between 0 and 255 or hexadecimals between
|
|
0x00 and 0xFF.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A color identifier or &false; if the allocation failed.
|
|
</para>
|
|
&return.falseproblem;
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
&gd.changelog.image-param;
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>imagecolorallocate</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$im = imagecreate(100, 100);
|
|
|
|
// sets background to red
|
|
$background = imagecolorallocate($im, 255, 0, 0);
|
|
|
|
// sets some colors
|
|
$white = imagecolorallocate($im, 255, 255, 255);
|
|
$black = imagecolorallocate($im, 0, 0, 0);
|
|
|
|
// hexadecimal way
|
|
$white = imagecolorallocate($im, 0xFF, 0xFF, 0xFF);
|
|
$black = imagecolorallocate($im, 0x00, 0x00, 0x00);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>imagecolorallocatealpha</function></member>
|
|
<member><function>imagecolordeallocate</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
|
|
-->
|