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 117 118 119 120 121 122 123 124 125 126 127
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.printer-create-brush" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>printer_create_brush</refname>
<refpurpose>Create a new brush</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>printer_create_brush</methodname>
<methodparam><type>int</type><parameter>style</parameter></methodparam>
<methodparam><type>string</type><parameter>color</parameter></methodparam>
</methodsynopsis>
<para>
The function creates a new brush and returns a handle to it. A brush is
used to fill shapes. For an example see
<function>printer_select_brush</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>style</parameter></term>
<listitem>
<para>
<parameter>style</parameter> must be one of the following constants:
<itemizedlist>
<listitem>
<simpara>
<constant>PRINTER_BRUSH_SOLID</constant>:
creates a brush with a solid color.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_BRUSH_DIAGONAL</constant>:
creates a brush with a 45-degree upward left-to-right hatch ( / ).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_BRUSH_CROSS</constant>:
creates a brush with a cross hatch ( + ).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_BRUSH_DIAGCROSS</constant>:
creates a brush with a 45 cross hatch ( x ).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_BRUSH_FDIAGONAL</constant>:
creates a brush with a 45-degree downward left-to-right hatch ( \ ).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_BRUSH_HORIZONTAL</constant>:
creates a brush with a horizontal hatch ( - ).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_BRUSH_VERTICAL</constant>:
creates a brush with a vertical hatch ( | ).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_BRUSH_CUSTOM</constant>:
creates a custom brush from an BMP file. The second parameter
is used to specify the BMP instead of the RGB color code.
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>color</parameter></term>
<listitem>
<para>
<parameter>color</parameter> must be a color in RGB hex format, i.e.
"<literal>000000</literal>" for black.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a brush handle or &false; on error.
</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
-->
|