php-doc-en/reference/cairo/cairocontext/getantialias.xml
2012-01-11 06:50:17 +00:00

138 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cairocontext.getantialias" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CairoContext::getAntialias</refname>
<refname>cairo_get_antialias</refname>
<refpurpose>Retrives the current antialias mode</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>CairoContext::getAntialias</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
<type>int</type><methodname>cairo_get_antialias</methodname>
<methodparam><type>CairoContext</type><parameter>context</parameter></methodparam>
</methodsynopsis>
<para>
Returns the current <classname>CairoAntialias</classname> mode, as set by
<methodname>CairoContext::setAntialias</methodname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
A valid <classname>CairoContext</classname> object created with
<methodname>CairoContext::__construct</methodname> or <function>cairo_create</function>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The current <classname>CairoAntialias</classname> mode.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
$surface = new CairoImageSurface(CairoFormat::ARGB32, 50, 50);
$context = new CairoContext($surface);
$context->setAntialias(CairoAntialias::MODE_SUBPIXEL);
var_dump($context->getAntialias());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
int(3)
]]>
</screen>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
$sur = cairo_image_surface_create(CAIRO_FORMAT_ARGB32, 50, 50);
$con = cairo_create($sur);
cairo_set_antialias($con, CAIRO_ANTIALIAS_SUBPIXEL);
var_dump(cairo_get_antialias($con));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
int(3)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>CairoContext::setAntialias</methodname></member>
<member><classname>CairoAntialias</classname></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
-->