php-doc-en/reference/cairo/cairoformat.xml
Tyson Andre e123b98532 Fix typos in documentation of cairo
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346896 c90b9560-bf6c-de11-be94-00142212c4b1
2019-02-24 20:42:36 +00:00

140 lines
4.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.cairoformat" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The CairoFormat class</title>
<titleabbrev>CairoFormat</titleabbrev>
<partintro>
<!-- {{{ CairoFormat intro -->
<section xml:id="cairoformat.intro">
&reftitle.intro;
<para>
CairoFormat enums are used to identify the memory format of the image data.
</para>
</section>
<!-- }}} -->
<section xml:id="cairoformat.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>CairoFormat</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>CairoFormat</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairoformat.constants.argb32">CairoFormat::ARGB32</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairoformat.constants.rgb24">CairoFormat::RGB24</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairoformat.constants.a8">CairoFormat::A8</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairoformat.constants.a1">CairoFormat::A1</varname>
<initializer>3</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.cairoformat')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ CairoFormat constants -->
<section xml:id="cairoformat.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="cairoformat.constants.argb32">
<term><constant>CairoFormat::ARGB32</constant></term>
<listitem>
<para>Each pixel is a 32-bit quantity, with alpha in the upper 8 bits, then red, then green, then blue.
The 32-bit quantities are stored native-endian.
Pre-multiplied alpha is used. (That is, 50% transparent red is 0x80800000, not 0x80ff0000.)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairoformat.constants.rgb24">
<term><constant>CairoFormat::RGB24</constant></term>
<listitem>
<para> Each pixel is a 32-bit quantity, with the upper 8 bits unused.
Red, Green, and Blue are stored in the remaining 24 bits in that order.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairoformat.constants.a8">
<term><constant>CairoFormat::A8</constant></term>
<listitem>
<para>Each pixel is a 8-bit quantity holding an alpha value.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairoformat.constants.a1">
<term><constant>CairoFormat::A1</constant></term>
<listitem>
<para>Each pixel is a 1-bit quantity holding an alpha value.
Pixels are packed together into 32-bit quantities.
The ordering of the bits matches the endianness of the platform.
On a big-endian machine, the first pixel is in the uppermost bit,
on a little-endian machine the first pixel is in the least-significant bit.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.cairo.entities.cairoformat;
</phpdoc:classref>
<!-- 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
-->