Document new imageopenpolygon() function

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@340500 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2016-10-17 09:20:34 +00:00
parent e3f2f6ed4f
commit 2f6123253c
5 changed files with 173 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 979 B

View file

@ -107,6 +107,15 @@ imagedestroy($image);
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imagepolygon</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -0,0 +1,161 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imageopenpolygon" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imageopenpolygon</refname>
<refpurpose>Draws an open polygon</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imageopenpolygon</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam><type>array</type><parameter>points</parameter></methodparam>
<methodparam><type>int</type><parameter>num_points</parameter></methodparam>
<methodparam><type>int</type><parameter>color</parameter></methodparam>
</methodsynopsis>
<para>
<function>imageopenpolygon</function> draws an open polygon on the given
<parameter>image</parameter>. Contrary to <function>imagepolygon</function>,
no line is drawn between the last and the first point.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>points</parameter></term>
<listitem>
<para>
An array containing the polygon's vertices, e.g.:
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry>points[0]</entry>
<entry>= x0</entry>
</row>
<row>
<entry>points[1]</entry>
<entry>= y0</entry>
</row>
<row>
<entry>points[2]</entry>
<entry>= x1</entry>
</row>
<row>
<entry>points[3]</entry>
<entry>= y1</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>num_points</parameter></term>
<listitem>
<para>
Total number of points (vertices).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>color</parameter></term>
<listitem>
<para>
A color identifier created with
<function>imagecolorallocate</function>.
</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>imageopenpolygon</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Create a blank image
$image = imagecreatetruecolor(400, 300);
// Allocate a color for the polygon
$col_poly = imagecolorallocate($image, 255, 255, 255);
// Draw the polygon
imageopenpolygon($image, array(
0, 0,
100, 200,
300, 200
),
3,
$col_poly);
// Output the picture to the browser
header('Content-type: image/png');
imagepng($image);
imagedestroy($image);
?>
]]>
</programlisting>
&example.outputs.similar;
<mediaobject>
<alt>Output of example : imageopenpolygon()</alt>
<imageobject>
<imagedata fileref="en/reference/image/figures/imageopenpolygon.png"/>
</imageobject>
</mediaobject>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imagepolygon</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
-->

View file

@ -125,6 +125,8 @@ imagedestroy($image);
&reftitle.seealso;
<para>
<simplelist>
<member><function>imagefilledpolygon</function></member>
<member><function>imageopenpolygon</function></member>
<member><function>imagecreate</function></member>
<member><function>imagecreatetruecolor</function></member>
</simplelist>

View file

@ -83,6 +83,7 @@
<function name="imagelayereffect" from="PHP 4 &gt;= 4.3.0, PHP 5, PHP 7"/>
<function name="imageline" from="PHP 4, PHP 5, PHP 7"/>
<function name="imageloadfont" from="PHP 4, PHP 5, PHP 7"/>
<function name="imageopenpolygon" from="PHP 7 &gt;= 7.2.0"/>
<function name="imagepalettecopy" from="PHP 4 &gt;= 4.0.1, PHP 5, PHP 7"/>
<function name="imagepalettetotruecolor" from="PHP 5 &gt;= 5.5.0, PHP 7"/>
<function name="imagepng" from="PHP 4, PHP 5, PHP 7"/>