win32-fonts.xml

Pango is a library for layout and rendering of text, with an emphasis on internationalization. Pang

<refentry id="pango-Win32-Fonts-and-Rendering">
<refmeta>
<refentrytitle role="top_of_page" id="pango-Win32-Fonts-and-Rendering.top_of_page">Win32 Fonts and Rendering</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>PANGO Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>Win32 Fonts and Rendering</refname>
<refpurpose>Functions for shape engines to manipulate Win32 fonts</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="pango-Win32-Fonts-and-Rendering.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
#define             <link linkend="PANGO-RENDER-TYPE-WIN32:CAPS">PANGO_RENDER_TYPE_WIN32</link>
<link linkend="PangoContext">PangoContext</link>*       <link linkend="pango-win32-get-context">pango_win32_get_context</link>             (void);
<link linkend="void">void</link>                <link linkend="pango-win32-render">pango_win32_render</link>                  (<link linkend="HDC:CAPS">HDC</link> hdc,
                                                         <link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);
<link linkend="void">void</link>                <link linkend="pango-win32-render-transformed">pango_win32_render_transformed</link>      (<link linkend="HDC:CAPS">HDC</link> hdc,
                                                         const <link linkend="PangoMatrix">PangoMatrix</link> *matrix,
                                                         <link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y);
<link linkend="void">void</link>                <link linkend="pango-win32-render-layout-line">pango_win32_render_layout_line</link>      (<link linkend="HDC:CAPS">HDC</link> hdc,
                                                         <link linkend="PangoLayoutLine">PangoLayoutLine</link> *line,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y);
<link linkend="void">void</link>                <link linkend="pango-win32-render-layout">pango_win32_render_layout</link>           (<link linkend="HDC:CAPS">HDC</link> hdc,
                                                         <link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y);
<link linkend="PangoGlyph">PangoGlyph</link>          <link linkend="pango-win32-get-unknown-glyph">pango_win32_get_unknown_glyph</link>       (<link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="gunichar">gunichar</link> wc);
<link linkend="gint">gint</link>                <link linkend="pango-win32-font-get-glyph-index">pango_win32_font_get_glyph_index</link>    (<link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="gunichar">gunichar</link> wc);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-win32-font-select-font">pango_win32_font_select_font</link>        (<link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="HDC:CAPS">HDC</link> hdc);
<link linkend="void">void</link>                <link linkend="pango-win32-font-done-font">pango_win32_font_done_font</link>          (<link linkend="PangoFont">PangoFont</link> *font);
<link linkend="double">double</link>              <link linkend="pango-win32-font-get-metrics-factor">pango_win32_font_get_metrics_factor</link> (<link linkend="PangoFont">PangoFont</link> *font);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-win32-get-debug-flag">pango_win32_get_debug_flag</link>          (void);
<link linkend="HDC:CAPS">HDC</link>                 <link linkend="pango-win32-get-dc">pango_win32_get_dc</link>                  (void);
                    <link linkend="PangoWin32FontCache">PangoWin32FontCache</link>;
<link linkend="PangoWin32FontCache">PangoWin32FontCache</link>* <link linkend="pango-win32-font-cache-new">pango_win32_font_cache_new</link>         (void);
<link linkend="void">void</link>                <link linkend="pango-win32-font-cache-free">pango_win32_font_cache_free</link>         (<link linkend="PangoWin32FontCache">PangoWin32FontCache</link> *cache);
<link linkend="HFONT:CAPS">HFONT</link>               <link linkend="pango-win32-font-cache-load">pango_win32_font_cache_load</link>         (<link linkend="PangoWin32FontCache">PangoWin32FontCache</link> *cache,
                                                         const <link linkend="LOGFONTA:CAPS">LOGFONTA</link> *logfont);
<link linkend="HFONT:CAPS">HFONT</link>               <link linkend="pango-win32-font-cache-loadw">pango_win32_font_cache_loadw</link>        (<link linkend="PangoWin32FontCache">PangoWin32FontCache</link> *cache,
                                                         const <link linkend="LOGFONTW:CAPS">LOGFONTW</link> *logfont);
<link linkend="void">void</link>                <link linkend="pango-win32-font-cache-unload">pango_win32_font_cache_unload</link>       (<link linkend="PangoWin32FontCache">PangoWin32FontCache</link> *cache,
                                                         <link linkend="HFONT:CAPS">HFONT</link> hfont);
<link linkend="PangoFontMap">PangoFontMap</link>*       <link linkend="pango-win32-font-map-for-display">pango_win32_font_map_for_display</link>    (void);
<link linkend="void">void</link>                <link linkend="pango-win32-shutdown-display">pango_win32_shutdown_display</link>        (void);
<link linkend="PangoWin32FontCache">PangoWin32FontCache</link>* <link linkend="pango-win32-font-map-get-font-cache">pango_win32_font_map_get_font_cache</link>
                                                        (<link linkend="PangoFontMap">PangoFontMap</link> *font_map);
<link linkend="LOGFONTA:CAPS">LOGFONTA</link>*           <link linkend="pango-win32-font-logfont">pango_win32_font_logfont</link>            (<link linkend="PangoFont">PangoFont</link> *font);
<link linkend="LOGFONTW:CAPS">LOGFONTW</link>*           <link linkend="pango-win32-font-logfontw">pango_win32_font_logfontw</link>           (<link linkend="PangoFont">PangoFont</link> *font);
<link linkend="PangoFontDescription">PangoFontDescription</link>* <link linkend="pango-win32-font-description-from-logfont">pango_win32_font_description_from_logfont</link>
                                                        (const <link linkend="LOGFONTA:CAPS">LOGFONTA</link> *lfp);
<link linkend="PangoFontDescription">PangoFontDescription</link>* <link linkend="pango-win32-font-description-from-logfontw">pango_win32_font_description_from_logfontw</link>
                                                        (const <link linkend="LOGFONTW:CAPS">LOGFONTW</link> *lfp);
</synopsis>
</refsynopsisdiv>









<refsect1 id="pango-Win32-Fonts-and-Rendering.description" role="desc">
<title role="desc.title">Description</title>
<para>
The macros and functions in this section are used to access fonts natively on
Win32 systems and to render text in conjunction with Win32 APIs.
</para>
</refsect1>

<refsect1 id="pango-Win32-Fonts-and-Rendering.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="PANGO-RENDER-TYPE-WIN32:CAPS" role="macro">
<title>PANGO_RENDER_TYPE_WIN32</title>
<indexterm zone="PANGO-RENDER-TYPE-WIN32:CAPS"><primary>PANGO_RENDER_TYPE_WIN32</primary></indexterm><programlisting>#define PANGO_RENDER_TYPE_WIN32 "PangoRenderWin32"
</programlisting>
<para>
A string constant identifying the Win32 renderer. The associated quark (see
<link linkend="g-quark-from-string"><function>g_quark_from_string()</function></link>) is used to identify the renderer in <link linkend="pango-find-map"><function>pango_find_map()</function></link>.
</para></refsect2>
<refsect2 id="pango-win32-get-context" role="function">
<title>pango_win32_get_context ()</title>
<indexterm zone="pango-win32-get-context"><primary>pango_win32_get_context</primary></indexterm><programlisting><link linkend="PangoContext">PangoContext</link>*       pango_win32_get_context             (void);</programlisting>
<para>
Retrieves a <link linkend="PangoContext"><type>PangoContext</type></link> appropriate for rendering with Windows fonts.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new <link linkend="PangoContext"><type>PangoContext</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-win32-render" role="function">
<title>pango_win32_render ()</title>
<indexterm zone="pango-win32-render"><primary>pango_win32_render</primary></indexterm><programlisting><link linkend="void">void</link>                pango_win32_render                  (<link linkend="HDC:CAPS">HDC</link> hdc,
                                                         <link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);</programlisting>
<para>
Render a <link linkend="PangoGlyphString"><type>PangoGlyphString</type></link> onto a Windows DC</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>hdc</parameter>&nbsp;:</term>
<listitem><simpara>     the device context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font</parameter>&nbsp;:</term>
<listitem><simpara>    the font in which to draw the string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>glyphs</parameter>&nbsp;:</term>
<listitem><simpara>  the glyph string to draw
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara>       the x position of start of string (in pixels)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara>       the y position of baseline (in pixels)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-win32-render-transformed" role="function">
<title>pango_win32_render_transformed ()</title>
<indexterm zone="pango-win32-render-transformed"><primary>pango_win32_render_transformed</primary></indexterm><programlisting><link linkend="void">void</link>                pango_win32_render_transformed      (<link linkend="HDC:CAPS">HDC</link> hdc,
                                                         const <link linkend="PangoMatrix">PangoMatrix</link> *matrix,
                                                         <link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y);</programlisting>
<para>
Renders a <link linkend="PangoGlyphString"><type>PangoGlyphString</type></link> onto a windows DC, possibly
transforming the layed-out coordinates through a transformation
matrix. Note that the transformation matrix for <parameter>font</parameter> is not
changed, so to produce correct rendering results, the <parameter>font</parameter>
must have been loaded using a <link linkend="PangoContext"><type>PangoContext</type></link> with an identical
transformation matrix to that passed in to this function.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>hdc</parameter>&nbsp;:</term>
<listitem><simpara>     a windows device context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
<listitem><simpara>  a <link linkend="PangoMatrix"><type>PangoMatrix</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to use an identity transformation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font</parameter>&nbsp;:</term>
<listitem><simpara>    the font in which to draw the string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>glyphs</parameter>&nbsp;:</term>
<listitem><simpara>  the glyph string to draw
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara>       the x position of the start of the string (in Pango
          units in user space coordinates)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara>       the y position of the baseline (in Pango units
          in user space coordinates)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-win32-render-layout-line" role="function">
<title>pango_win32_render_layout_line ()</title>
<indexterm zone="pango-win32-render-layout-line"><primary>pango_win32_render_layout_line</primary></indexterm><programlisting><link linkend="void">void</link>                pango_win32_render_layout_line      (<link linkend="HDC:CAPS">HDC</link> hdc,
                                                         <link linkend="PangoLayoutLine">PangoLayoutLine</link> *line,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y);</programlisting>
<para>
Render a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> onto a device context. For underlining to
work property the text alignment of the DC should have TA_BASELINE
and TA_LEFT.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>hdc</parameter>&nbsp;:</term>
<listitem><simpara>       DC to use for uncolored drawing
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>line</parameter>&nbsp;:</term>
<listitem><simpara>      a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link>