pango-renderer.xml

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

<listitem><simpara> X coordinate of right end of top of trapezoid
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y2</parameter>&nbsp;:</term>
<listitem><simpara> Y coordinate of bottom of trapezoid
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x12</parameter>&nbsp;:</term>
<listitem><simpara> X coordinate of left end of bottom of trapezoid
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x22</parameter>&nbsp;:</term>
<listitem><simpara> X coordinate of right end of bottom of trapezoid
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-draw-glyph" role="function" condition="since:1.8">
<title>pango_renderer_draw_glyph ()</title>
<indexterm zone="pango-renderer-draw-glyph" role="1.8"><primary>pango_renderer_draw_glyph</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_draw_glyph           (<link linkend="PangoRenderer">PangoRenderer</link> *renderer,
                                                         <link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="PangoGlyph">PangoGlyph</link> glyph,
                                                         <link linkend="double">double</link> x,
                                                         <link linkend="double">double</link> y);</programlisting>
<para>
Draws a single glyph with coordinates in device space.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>glyph</parameter>&nbsp;:</term>
<listitem><simpara> the glyph index of a single glyph
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> X coordinate of left edge of baseline of glyph
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> Y coordinate of left edge of baseline of glyph
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-activate" role="function" condition="since:1.8">
<title>pango_renderer_activate ()</title>
<indexterm zone="pango-renderer-activate" role="1.8"><primary>pango_renderer_activate</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_activate             (<link linkend="PangoRenderer">PangoRenderer</link> *renderer);</programlisting>
<para>
Does initial setup before rendering operations on <parameter>renderer</parameter>.
<link linkend="pango-renderer-deactivate"><function>pango_renderer_deactivate()</function></link> should be called when done drawing.
Calls such as <link linkend="pango-renderer-draw-layout"><function>pango_renderer_draw_layout()</function></link> automatically
activate the layout before drawing on it. Calls to
<link linkend="pango-renderer-activate"><function>pango_renderer_activate()</function></link> and <link linkend="pango-renderer-deactivate"><function>pango_renderer_deactivate()</function></link> can
be nested and the renderer will only be initialized and
deinitialized once.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-deactivate" role="function" condition="since:1.8">
<title>pango_renderer_deactivate ()</title>
<indexterm zone="pango-renderer-deactivate" role="1.8"><primary>pango_renderer_deactivate</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_deactivate           (<link linkend="PangoRenderer">PangoRenderer</link> *renderer);</programlisting>
<para>
Cleans up after rendering operations on <parameter>renderer</parameter>. See
docs for <link linkend="pango-renderer-activate"><function>pango_renderer_activate()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-part-changed" role="function" condition="since:1.8">
<title>pango_renderer_part_changed ()</title>
<indexterm zone="pango-renderer-part-changed" role="1.8"><primary>pango_renderer_part_changed</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_part_changed         (<link linkend="PangoRenderer">PangoRenderer</link> *renderer,
                                                         <link linkend="PangoRenderPart">PangoRenderPart</link> part);</programlisting>
<para>
Informs Pango that the way that the rendering is done
for <parameter>part</parameter> has changed in a way that would prevent multiple
pieces being joined together into one drawing call. For
instance, if a subclass of <link linkend="PangoRenderer"><type>PangoRenderer</type></link> was to add a stipple
option for drawing underlines, it needs to call
</para>
<para>
<informalexample><programlisting>
pango_renderer_part_changed (render, PANGO_RENDER_PART_UNDERLINE);
</programlisting></informalexample>
</para>
<para>
When the stipple changes or underlines with different stipples
might be joined together. Pango automatically calls this for
changes to colors. (See <link linkend="pango-renderer-set-color"><function>pango_renderer_set_color()</function></link>)</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>part</parameter>&nbsp;:</term>
<listitem><simpara> the part for which rendering has changed.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-set-color" role="function" condition="since:1.8">
<title>pango_renderer_set_color ()</title>
<indexterm zone="pango-renderer-set-color" role="1.8"><primary>pango_renderer_set_color</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_set_color            (<link linkend="PangoRenderer">PangoRenderer</link> *renderer,
                                                         <link linkend="PangoRenderPart">PangoRenderPart</link> part,
                                                         const <link linkend="PangoColor">PangoColor</link> *color);</programlisting>
<para>
Sets the color for part of the rendering.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>part</parameter>&nbsp;:</term>
<listitem><simpara> the part to change the color of
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter>&nbsp;:</term>
<listitem><simpara> the new color or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to unset the current color
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-get-color" role="function" condition="since:1.8">
<title>pango_renderer_get_color ()</title>
<indexterm zone="pango-renderer-get-color" role="1.8"><primary>pango_renderer_get_color</primary></indexterm><programlisting><link linkend="PangoColor">PangoColor</link>*         pango_renderer_get_color            (<link linkend="PangoRenderer">PangoRenderer</link> *renderer,
                                                         <link linkend="PangoRenderPart">PangoRenderPart</link> part);</programlisting>
<para>
Gets the current rendering color for the specified part.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>part</parameter>&nbsp;:</term>
<listitem><simpara> the part to get the color for
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the color for the specified part, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 if it hasn't been set and should be inherited from the
 environment.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-set-matrix" role="function" condition="since:1.8">
<title>pango_renderer_set_matrix ()</title>
<indexterm zone="pango-renderer-set-matrix" role="1.8"><primary>pango_renderer_set_matrix</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_set_matrix           (<link linkend="PangoRenderer">PangoRenderer</link> *renderer,
                                                         const <link linkend="PangoMatrix">PangoMatrix</link> *matrix);</programlisting>
<para>
Sets the transformation matrix that will be applied when rendering.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</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 unset any existing matrix.
 (No matrix set is the same as setting the identity matrix.)
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-get-matrix" role="function" condition="since:1.8">
<title>pango_renderer_get_matrix ()</title>
<indexterm zone="pango-renderer-get-matrix" role="1.8"><primary>pango_renderer_get_matrix</primary></indexterm><programlisting>const <link linkend="PangoMatrix">PangoMatrix</link>*  pango_renderer_get_matrix           (<link linkend="PangoRenderer">PangoRenderer</link> *renderer);</programlisting>
<para>
Gets the transformation matrix that will be applied when
rendering. See <link linkend="pango-renderer-set-matrix"><function>pango_renderer_set_matrix()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the matrix, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no matrix has been set
 (which is the same as the identity matrix). The returned
 matrix is owned by Pango and must not be modified or
 freed.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-get-layout" role="function" condition="since:1.20">
<title>pango_renderer_get_layout ()</title>
<indexterm zone="pango-renderer-get-layout" role="1.20"><primary>pango_renderer_get_layout</primary></indexterm><programlisting><link linkend="PangoLayout">PangoLayout</link>*        pango_renderer_get_layout           (<link linkend="PangoRenderer">PangoRenderer</link> *renderer);</programlisting>
<para>
Gets the layout currently being rendered using <parameter>renderer</parameter>.
Calling this function only makes sense from inside a subclass's
methods, like in its draw_shape<!---->() for example.
</para>
<para>
The returned layout should not be modified while still being
rendered.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the layout, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no layout is being
 rendered using <parameter>renderer</parameter> at this time.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.20
</para></refsect2>
<refsect2 id="pango-renderer-get-layout-line" role="function" condition="since:1.20">
<title>pango_renderer_get_layout_line ()</title>
<indexterm zone="pango-renderer-get-layout-line" role="1.20"><primary>pango_renderer_get_layout_line</primary></indexterm><programlisting><link linkend="PangoLayoutLine">PangoLayoutLine</link>*    pango_renderer_get_layout_line      (<link linkend="PangoRenderer">PangoRenderer</link> *renderer);</programlisting>
<para>
Gets the layout line currently being rendered using <parameter>renderer</parameter>.
Calling this function only makes sense from inside a subclass's
methods, like in its draw_shape<!---->() for example.
</para>
<para>
The returned layout line should not be modified while still being
rendered.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the layout line, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no layout line is being
 rendered using <parameter>renderer</parameter> at this time.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.20
</para></refsect2>

</refsect1>




</refentry>