mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
a435a5f430
Cf. <https://bugs.php.net/bug.php?id=77311>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346379 c90b9560-bf6c-de11-be94-00142212c4b1
117 lines
3.2 KiB
XML
117 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<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>
|
|
<caution>
|
|
<para>
|
|
You need not take special action when you are finished with a tile, but if you
|
|
destroy the tile image (or let PHP destroy it), you must not use the <constant>IMG_COLOR_TILED</constant>
|
|
color until you have set a new tile image!
|
|
</para>
|
|
</caution>
|
|
</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>
|
|
<alt>Output of example : imagesettile()</alt>
|
|
<imageobject>
|
|
<imagedata fileref="en/reference/image/figures/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:"~/.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
|
|
-->
|