← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/cairo/intrepid-updates

« back to all changes in this revision

Viewing changes to doc/public/xml/cairo-font-options.xml

  • Committer: Bazaar Package Importer
  • Author(s): Fabien Tassin
  • Date: 2008-09-25 16:22:33 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20080925162233-btx61ymk181i7mcc
Tags: 1.7.6-0ubuntu1
* New upstream version. Most noticable changes are:
  - some API changes with especially the removal of
    cairo_font_options_set_lcd_filter and cairo_font_options_get_lcd_filter
  - xlib: Faster bookkeeping
  - PS: Fix gradients with non-constant alpha
  - Fix deadlock in user-font code
* debian/patches/00list: Remove 03_from_git_fix_lcd_filter_default.dpatch,
  add debian/patches/03_fix_ftbfs_withing_xcb.dpatch
* debian/libcairo2.symbols, debian/libcairo-directfb2.symbols: update
  list of symbols

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/public/xml/cairo-font-options.xml
3
3
                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4
4
<!ENTITY version SYSTEM "version.xml">
5
5
]>
6
 
<refentry id="cairo-Font-Options">
 
6
<refentry id="cairo-font-options">
7
7
<refmeta>
8
 
<refentrytitle role="top_of_page" id="cairo-Font-Options.top_of_page">cairo_font_options_t</refentrytitle>
 
8
<refentrytitle role="top_of_page" id="cairo-font-options.top_of_page">cairo_font_options_t</refentrytitle>
9
9
<manvolnum>3</manvolnum>
10
10
<refmiscinfo>CAIRO Library</refmiscinfo>
11
11
</refmeta>
16
16
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
17
</refnamediv>
18
18
 
19
 
<refsynopsisdiv id="cairo-Font-Options.synopsis" role="synopsis">
 
19
<refsynopsisdiv id="cairo-font-options.synopsis" role="synopsis">
20
20
<title role="synopsis.title">Synopsis</title>
21
21
 
22
22
<synopsis>
39
39
                                                         <link linkend="cairo-subpixel-order-t">cairo_subpixel_order_t</link> subpixel_order);
40
40
<link linkend="cairo-subpixel-order-t">cairo_subpixel_order_t</link> <link linkend="cairo-font-options-get-subpixel-order">cairo_font_options_get_subpixel_order</link>
41
41
                                                        (const <link linkend="cairo-font-options-t">cairo_font_options_t</link> *options);
42
 
enum                <link linkend="cairo-lcd-filter-t">cairo_lcd_filter_t</link>;
43
 
<link linkend="void">void</link>                <link linkend="cairo-font-options-set-lcd-filter">cairo_font_options_set_lcd_filter</link>   (<link linkend="cairo-font-options-t">cairo_font_options_t</link> *options,
44
 
                                                         <link linkend="cairo-lcd-filter-t">cairo_lcd_filter_t</link> lcd_filter);
45
 
<link linkend="cairo-lcd-filter-t">cairo_lcd_filter_t</link>  <link linkend="cairo-font-options-get-lcd-filter">cairo_font_options_get_lcd_filter</link>   (const <link linkend="cairo-font-options-t">cairo_font_options_t</link> *options);
46
42
enum                <link linkend="cairo-hint-style-t">cairo_hint_style_t</link>;
47
43
<link linkend="void">void</link>                <link linkend="cairo-font-options-set-hint-style">cairo_font_options_set_hint_style</link>   (<link linkend="cairo-font-options-t">cairo_font_options_t</link> *options,
48
44
                                                         <link linkend="cairo-hint-style-t">cairo_hint_style_t</link> hint_style);
63
59
 
64
60
 
65
61
 
66
 
<refsect1 id="cairo-Font-Options.description" role="desc">
 
62
<refsect1 id="cairo-font-options.description" role="desc">
67
63
<title role="desc.title">Description</title>
68
64
<para>
69
65
The font options specify how fonts should be rendered.  Most of the time the
73
69
</para>
74
70
</refsect1>
75
71
 
76
 
<refsect1 id="cairo-Font-Options.details" role="details">
 
72
<refsect1 id="cairo-font-options.details" role="details">
77
73
<title role="details.title">Details</title>
78
74
<refsect2 id="cairo-font-options-t" role="typedef">
79
75
<title>cairo_font_options_t</title>
337
333
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the subpixel order for the font options object
338
334
</simpara></listitem></varlistentry>
339
335
</variablelist></refsect2>
340
 
<refsect2 id="cairo-lcd-filter-t" role="enum" condition="since:1.8">
341
 
<title>enum cairo_lcd_filter_t</title>
342
 
<indexterm zone="cairo-lcd-filter-t" role="1.8"><primary>cairo_lcd_filter_t</primary></indexterm><programlisting>typedef enum _cairo_lcd_filter {
343
 
    CAIRO_LCD_FILTER_DEFAULT,
344
 
    CAIRO_LCD_FILTER_NONE,
345
 
    CAIRO_LCD_FILTER_INTRA_PIXEL,
346
 
    CAIRO_LCD_FILTER_FIR3,
347
 
    CAIRO_LCD_FILTER_FIR5
348
 
} cairo_lcd_filter_t;
349
 
</programlisting>
350
 
<para>
351
 
The LCD filter specifies the low-pass filter applied to LCD-optimized
352
 
bitmaps generated with an antialiasing mode of <link linkend="CAIRO-ANTIALIAS-SUBPIXEL:CAPS"><literal>CAIRO_ANTIALIAS_SUBPIXEL</literal></link>.</para>
353
 
<para>
354
 
 
355
 
</para><variablelist role="enum">
356
 
<varlistentry id="CAIRO-LCD-FILTER-DEFAULT:CAPS" role="constant">
357
 
<term><literal>CAIRO_LCD_FILTER_DEFAULT</literal></term>
358
 
<listitem><simpara> Use the default LCD filter for
359
 
  font backend and target device
360
 
</simpara></listitem>
361
 
</varlistentry>
362
 
<varlistentry id="CAIRO-LCD-FILTER-NONE:CAPS" role="constant">
363
 
<term><literal>CAIRO_LCD_FILTER_NONE</literal></term>
364
 
<listitem><simpara> Do not perform LCD filtering
365
 
</simpara></listitem>
366
 
</varlistentry>
367
 
<varlistentry id="CAIRO-LCD-FILTER-INTRA-PIXEL:CAPS" role="constant">
368
 
<term><literal>CAIRO_LCD_FILTER_INTRA_PIXEL</literal></term>
369
 
<listitem><simpara> Intra-pixel filter
370
 
</simpara></listitem>
371
 
</varlistentry>
372
 
<varlistentry id="CAIRO-LCD-FILTER-FIR3:CAPS" role="constant">
373
 
<term><literal>CAIRO_LCD_FILTER_FIR3</literal></term>
374
 
<listitem><simpara> FIR filter with a 3x3 kernel
375
 
</simpara></listitem>
376
 
</varlistentry>
377
 
<varlistentry id="CAIRO-LCD-FILTER-FIR5:CAPS" role="constant">
378
 
<term><literal>CAIRO_LCD_FILTER_FIR5</literal></term>
379
 
<listitem><simpara> FIR filter with a 5x5 kernel
380
 
</simpara></listitem>
381
 
</varlistentry>
382
 
</variablelist><para role="since">Since  1.8
383
 
</para></refsect2>
384
 
<refsect2 id="cairo-font-options-set-lcd-filter" role="function" condition="since:1.8">
385
 
<title>cairo_font_options_set_lcd_filter ()</title>
386
 
<indexterm zone="cairo-font-options-set-lcd-filter" role="1.8"><primary>cairo_font_options_set_lcd_filter</primary></indexterm><programlisting><link linkend="void">void</link>                cairo_font_options_set_lcd_filter   (<link linkend="cairo-font-options-t">cairo_font_options_t</link> *options,
387
 
                                                         <link linkend="cairo-lcd-filter-t">cairo_lcd_filter_t</link> lcd_filter);</programlisting>
388
 
<para>
389
 
Sets the LCD filter for the font options object. The LCD filter
390
 
specifies how pixels are filtered when rendered with an antialiasing
391
 
mode of <link linkend="CAIRO-ANTIALIAS-SUBPIXEL:CAPS"><literal>CAIRO_ANTIALIAS_SUBPIXEL</literal></link>. See the documentation for
392
 
<link linkend="cairo-lcd-filter-t"><type>cairo_lcd_filter_t</type></link> for full details.</para>
393
 
<para>
394
 
 
395
 
</para><variablelist role="params">
396
 
<varlistentry><term><parameter>options</parameter>&nbsp;:</term>
397
 
<listitem><simpara> a <link linkend="cairo-font-options-t"><type>cairo_font_options_t</type></link>
398
 
</simpara></listitem></varlistentry>
399
 
<varlistentry><term><parameter>lcd_filter</parameter>&nbsp;:</term>
400
 
<listitem><simpara> the new LCD filter
401
 
</simpara></listitem></varlistentry>
402
 
</variablelist><para role="since">Since  1.8
403
 
</para></refsect2>
404
 
<refsect2 id="cairo-font-options-get-lcd-filter" role="function" condition="since:1.8">
405
 
<title>cairo_font_options_get_lcd_filter ()</title>
406
 
<indexterm zone="cairo-font-options-get-lcd-filter" role="1.8"><primary>cairo_font_options_get_lcd_filter</primary></indexterm><programlisting><link linkend="cairo-lcd-filter-t">cairo_lcd_filter_t</link>  cairo_font_options_get_lcd_filter   (const <link linkend="cairo-font-options-t">cairo_font_options_t</link> *options);</programlisting>
407
 
<para>
408
 
Gets the LCD filter for the font options object.
409
 
See the documentation for <link linkend="cairo-lcd-filter-t"><type>cairo_lcd_filter_t</type></link> for full details.</para>
410
 
<para>
411
 
 
412
 
</para><variablelist role="params">
413
 
<varlistentry><term><parameter>options</parameter>&nbsp;:</term>
414
 
<listitem><simpara> a <link linkend="cairo-font-options-t"><type>cairo_font_options_t</type></link>
415
 
</simpara></listitem></varlistentry>
416
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the LCD filter for the font options object
417
 
 
418
 
</simpara></listitem></varlistentry>
419
 
</variablelist><para role="since">Since  1.8
420
 
</para></refsect2>
421
336
<refsect2 id="cairo-hint-style-t" role="enum">
422
337
<title>enum cairo_hint_style_t</title>
423
338
<indexterm zone="cairo-hint-style-t"><primary>cairo_hint_style_t</primary></indexterm><programlisting>typedef enum _cairo_hint_style {
580
495
 
581
496
 
582
497
 
583
 
<refsect1 id="cairo-Font-Options.see-also">
 
498
<refsect1 id="cairo-font-options.see-also">
584
499
<title>See Also</title>
585
500
<para>
586
501
<itemizedlist>