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 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<refentry xml:id="function.imagesettile" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagesettile</refname>
<refpurpose>Set the tile image for filling</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagesettile</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam><type>resource</type><parameter>tile</parameter></methodparam>
</methodsynopsis>
<para>
<function>imagesettile</function> sets the tile image to be
used by all region filling functions (such as <function>imagefill</function>
and <function>imagefilledpolygon</function>) when filling with the special
color <constant>IMG_COLOR_TILED</constant>.
</para>
<para>
A tile is an image used to fill an area with a repeated pattern. <emphasis>Any</emphasis>
GD image can be used as a tile, and by setting the transparent color index of the tile
image with <function>imagecolortransparent</function>, a tile allows certain parts
of the underlying area to shine through can be created.
</para>
<note>
<para>
You need not take special action when you are finished with a tile, but if you
destroy the tile image, you must not use the <constant>IMG_COLOR_TILED</constant>
color until you have set a new tile image!
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>tile</parameter></term>
<listitem>
<para>
The image resource to be used as a tile.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>imagesettile</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Load an external image
$zend = imagecreatefromgif('./zend.gif');
// Create a 200x200 image
$im = imagecreatetruecolor(200, 200);
// Set the tile
imagesettile($im, $zend);
// Make the image repeat
imagefilledrectangle($im, 0, 0, 199, 199, IMG_COLOR_TILED);
// Output image to the browser
header('Content-Type: image/png');
imagepng($im);
imagedestroy($im);
imagedestroy($zend);
?>
]]>
</programlisting>
&example.outputs.similar;
<mediaobject>
<imageobject>
<imagedata fileref="figures/image.imagesettile.png"/>
</imageobject>
</mediaobject>
</example>
</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
-->
|