Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>cairomm: Cairo::Pattern Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">cairomm
   &#160;<span id="projectnumber">1.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceCairo.html">Cairo</a></li><li class="navelem"><a class="el" href="classCairo_1_1Pattern.html">Pattern</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classCairo_1_1Pattern-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Cairo::Pattern Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classCairo_1_1Pattern.html" title="Cairo::Pattern is the paint with which cairo draws. ">Cairo::Pattern</a> is the paint with which cairo draws.  
 <a href="classCairo_1_1Pattern.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Cairo::Pattern:</div>
<div class="dyncontent">
<div class="center"><img src="classCairo_1_1Pattern__inherit__graph.png" border="0" usemap="#Cairo_1_1Pattern_inherit__map" alt="Inheritance graph"/></div>
<map name="Cairo_1_1Pattern_inherit__map" id="Cairo_1_1Pattern_inherit__map">
<area shape="rect" id="node2" href="classCairo_1_1Gradient.html" title="Cairo::Gradient" alt="" coords="115,80,234,107"/><area shape="rect" id="node5" href="classCairo_1_1SolidPattern.html" title="Cairo::SolidPattern" alt="" coords="258,80,398,107"/><area shape="rect" id="node6" href="classCairo_1_1SurfacePattern.html" title="Cairo::SurfacePattern" alt="" coords="422,80,581,107"/><area shape="rect" id="node3" href="classCairo_1_1LinearGradient.html" title="Cairo::LinearGradient" alt="" coords="5,155,163,181"/><area shape="rect" id="node4" href="classCairo_1_1RadialGradient.html" title="Cairo::RadialGradient" alt="" coords="187,155,343,181"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a430a261a68ae70ca1bd818c781178abc"><td class="memItemLeft" align="right" valign="top">typedef cairo_pattern_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a430a261a68ae70ca1bd818c781178abc">cobject</a></td></tr>
<tr class="separator:a430a261a68ae70ca1bd818c781178abc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2da16a5296c06b65867a1a99e47a4d82"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a2da16a5296c06b65867a1a99e47a4d82">Pattern</a> (cairo_pattern_t*<a class="el" href="classCairo_1_1Pattern.html#a430a261a68ae70ca1bd818c781178abc">cobject</a>, bool has_reference=false)</td></tr>
<tr class="memdesc:a2da16a5296c06b65867a1a99e47a4d82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a C++ wrapper for the C instance.  <a href="#a2da16a5296c06b65867a1a99e47a4d82">More...</a><br /></td></tr>
<tr class="separator:a2da16a5296c06b65867a1a99e47a4d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a726534a7f081b6c90553cd4d37ef5096"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a726534a7f081b6c90553cd4d37ef5096">Pattern</a> (const <a class="el" href="classCairo_1_1Pattern.html">Pattern</a>&amp;)=delete</td></tr>
<tr class="separator:a726534a7f081b6c90553cd4d37ef5096"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1492dc976fd8ad56f0ab5f9d7bf28d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCairo_1_1Pattern.html">Pattern</a>&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#ac1492dc976fd8ad56f0ab5f9d7bf28d8">operator=</a> (const <a class="el" href="classCairo_1_1Pattern.html">Pattern</a>&amp;)=delete</td></tr>
<tr class="separator:ac1492dc976fd8ad56f0ab5f9d7bf28d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62ac06285957869744411527bfb25298"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a62ac06285957869744411527bfb25298">~Pattern</a> ()</td></tr>
<tr class="separator:a62ac06285957869744411527bfb25298"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09dbb1295ba0a4f8a92b571aa6e425af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a09dbb1295ba0a4f8a92b571aa6e425af">set_matrix</a> (const <a class="el" href="classCairo_1_1Matrix.html">Matrix</a>&amp; matrix)</td></tr>
<tr class="memdesc:a09dbb1295ba0a4f8a92b571aa6e425af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the pattern's transformation matrix to .  <a href="#a09dbb1295ba0a4f8a92b571aa6e425af">More...</a><br /></td></tr>
<tr class="separator:a09dbb1295ba0a4f8a92b571aa6e425af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc04baecc72eb1feda0c96592a22276a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#abc04baecc72eb1feda0c96592a22276a">get_matrix</a> (<a class="el" href="classCairo_1_1Matrix.html">Matrix</a>&amp; matrix) const </td></tr>
<tr class="memdesc:abc04baecc72eb1feda0c96592a22276a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the pattern's transformation matrix.  <a href="#abc04baecc72eb1feda0c96592a22276a">More...</a><br /></td></tr>
<tr class="separator:abc04baecc72eb1feda0c96592a22276a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04dd241769520a787dbebd5907b55f87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCairo_1_1Matrix.html">Matrix</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a04dd241769520a787dbebd5907b55f87">get_matrix</a> () const </td></tr>
<tr class="memdesc:a04dd241769520a787dbebd5907b55f87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the pattern's transformation matrix.  <a href="#a04dd241769520a787dbebd5907b55f87">More...</a><br /></td></tr>
<tr class="separator:a04dd241769520a787dbebd5907b55f87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa50a29b9d4c669766355c917ab30b858"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#aa50a29b9d4c669766355c917ab30b858">set_matrix</a> (const <a class="el" href="classcairo__matrix__t.html">cairo_matrix_t</a>&amp; matrix)</td></tr>
<tr class="separator:aa50a29b9d4c669766355c917ab30b858"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a5a5ecfee3f2878c5a96ed6f1e9f11c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a1a5a5ecfee3f2878c5a96ed6f1e9f11c">get_matrix</a> (<a class="el" href="classcairo__matrix__t.html">cairo_matrix_t</a>&amp; matrix) const </td></tr>
<tr class="separator:a1a5a5ecfee3f2878c5a96ed6f1e9f11c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e82fd8de9147e0b6bdb70e5186d1d80"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCairo.html#afeff18f1043713479dd6ceb4aa4d4f02">PatternType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a9e82fd8de9147e0b6bdb70e5186d1d80">get_type</a> () const </td></tr>
<tr class="memdesc:a9e82fd8de9147e0b6bdb70e5186d1d80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of the pattern.  <a href="#a9e82fd8de9147e0b6bdb70e5186d1d80">More...</a><br /></td></tr>
<tr class="separator:a9e82fd8de9147e0b6bdb70e5186d1d80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa115faded8acf11fa0460a9dae9efc81"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#aa115faded8acf11fa0460a9dae9efc81">set_extend</a> (<a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5">Extend</a> extend)</td></tr>
<tr class="memdesc:aa115faded8acf11fa0460a9dae9efc81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the mode to be used for drawing outside the area of a pattern.  <a href="#aa115faded8acf11fa0460a9dae9efc81">More...</a><br /></td></tr>
<tr class="separator:aa115faded8acf11fa0460a9dae9efc81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec562503dcb0ef580fa42ed6657634bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5">Extend</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#aec562503dcb0ef580fa42ed6657634bb">get_extend</a> () const </td></tr>
<tr class="memdesc:aec562503dcb0ef580fa42ed6657634bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current extend mode See <a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5" title="Cairo::Extend is used to describe how pattern color/alpha will be determined for areas &quot;outside&quot; the ...">Cairo::Extend</a> for details on the semantics of each extend strategy.  <a href="#aec562503dcb0ef580fa42ed6657634bb">More...</a><br /></td></tr>
<tr class="separator:aec562503dcb0ef580fa42ed6657634bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27bde17e9c41b6c826999f0f1a50aa8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCairo_1_1Pattern.html#a430a261a68ae70ca1bd818c781178abc">cobject</a>*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a27bde17e9c41b6c826999f0f1a50aa8c">cobj</a> ()</td></tr>
<tr class="separator:a27bde17e9c41b6c826999f0f1a50aa8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a685e45ce1f593980d0037e7f780d2601"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCairo_1_1Pattern.html#a430a261a68ae70ca1bd818c781178abc">cobject</a>*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a685e45ce1f593980d0037e7f780d2601">cobj</a> () const </td></tr>
<tr class="separator:a685e45ce1f593980d0037e7f780d2601"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4755e9b4ad8fb4bb760abe81438f553a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a4755e9b4ad8fb4bb760abe81438f553a">reference</a> () const </td></tr>
<tr class="separator:a4755e9b4ad8fb4bb760abe81438f553a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cd12b946da697a673bc02b73eca0a04"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a4cd12b946da697a673bc02b73eca0a04">unreference</a> () const </td></tr>
<tr class="separator:a4cd12b946da697a673bc02b73eca0a04"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a41846b1a43050f7ea9aed51bba572247"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a41846b1a43050f7ea9aed51bba572247">Pattern</a> ()</td></tr>
<tr class="separator:a41846b1a43050f7ea9aed51bba572247"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a24fdc166f53a833ba1e1104a5690efbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCairo_1_1Pattern.html#a430a261a68ae70ca1bd818c781178abc">cobject</a>*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Pattern.html#a24fdc166f53a833ba1e1104a5690efbc">m_cobject</a></td></tr>
<tr class="separator:a24fdc166f53a833ba1e1104a5690efbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCairo_1_1Pattern.html" title="Cairo::Pattern is the paint with which cairo draws. ">Cairo::Pattern</a> is the paint with which cairo draws. </p>
<p>The primary use of patterns is as the source for all cairo drawing operations, although they can also be used as masks, that is, as the brush too.</p>
<p>This is a reference-counted object that should be used via <a class="el" href="classCairo_1_1RefPtr.html" title="RefPtr<> is a reference-counting shared smartpointer. ">Cairo::RefPtr</a>. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a430a261a68ae70ca1bd818c781178abc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef cairo_pattern_t <a class="el" href="classCairo_1_1Pattern.html#a430a261a68ae70ca1bd818c781178abc">Cairo::Pattern::cobject</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2da16a5296c06b65867a1a99e47a4d82"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Cairo::Pattern::Pattern </td>
          <td>(</td>
          <td class="paramtype">cairo_pattern_t *&#160;</td>
          <td class="paramname"><em>cobject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>has_reference</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create a C++ wrapper for the C instance. </p>
<p>This C++ instance should then be given to a <a class="el" href="classCairo_1_1RefPtr.html" title="RefPtr<> is a reference-counting shared smartpointer. ">RefPtr</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cobject</td><td>The C instance. </td></tr>
    <tr><td class="paramname">has_reference</td><td>Whether we already have a reference. Otherwise, the constructor will take an extra reference. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a726534a7f081b6c90553cd4d37ef5096"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Cairo::Pattern::Pattern </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCairo_1_1Pattern.html">Pattern</a>&amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a62ac06285957869744411527bfb25298"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual Cairo::Pattern::~Pattern </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a41846b1a43050f7ea9aed51bba572247"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Cairo::Pattern::Pattern </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a27bde17e9c41b6c826999f0f1a50aa8c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCairo_1_1Pattern.html#a430a261a68ae70ca1bd818c781178abc">cobject</a>* Cairo::Pattern::cobj </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a685e45ce1f593980d0037e7f780d2601"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classCairo_1_1Pattern.html#a430a261a68ae70ca1bd818c781178abc">cobject</a>* Cairo::Pattern::cobj </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aec562503dcb0ef580fa42ed6657634bb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5">Extend</a> Cairo::Pattern::get_extend </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the current extend mode See <a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5" title="Cairo::Extend is used to describe how pattern color/alpha will be determined for areas &quot;outside&quot; the ...">Cairo::Extend</a> for details on the semantics of each extend strategy. </p>
<dl class="section since"><dt>Since</dt><dd>1.12 </dd></dl>

</div>
</div>
<a class="anchor" id="abc04baecc72eb1feda0c96592a22276a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cairo::Pattern::get_matrix </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCairo_1_1Matrix.html">Matrix</a>&amp;&#160;</td>
          <td class="paramname"><em>matrix</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the pattern's transformation matrix. </p>

</div>
</div>
<a class="anchor" id="a04dd241769520a787dbebd5907b55f87"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCairo_1_1Matrix.html">Matrix</a> Cairo::Pattern::get_matrix </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the pattern's transformation matrix. </p>
<dl class="section since"><dt>Since</dt><dd>1.8 </dd></dl>

</div>
</div>
<a class="anchor" id="a1a5a5ecfee3f2878c5a96ed6f1e9f11c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cairo::Pattern::get_matrix </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcairo__matrix__t.html">cairo_matrix_t</a>&amp;&#160;</td>
          <td class="paramname"><em>matrix</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a9e82fd8de9147e0b6bdb70e5186d1d80"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceCairo.html#afeff18f1043713479dd6ceb4aa4d4f02">PatternType</a> Cairo::Pattern::get_type </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the type of the pattern. </p>
<dl class="section since"><dt>Since</dt><dd>1.2 </dd></dl>

</div>
</div>
<a class="anchor" id="ac1492dc976fd8ad56f0ab5f9d7bf28d8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCairo_1_1Pattern.html">Pattern</a>&amp; Cairo::Pattern::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCairo_1_1Pattern.html">Pattern</a>&amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a4755e9b4ad8fb4bb760abe81438f553a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cairo::Pattern::reference </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aa115faded8acf11fa0460a9dae9efc81"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cairo::Pattern::set_extend </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5">Extend</a>&#160;</td>
          <td class="paramname"><em>extend</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the mode to be used for drawing outside the area of a pattern. </p>
<p>See <a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5" title="Cairo::Extend is used to describe how pattern color/alpha will be determined for areas &quot;outside&quot; the ...">Cairo::Extend</a> for details on the semantics of each extend strategy.</p>
<p>The default extend mode is <a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5abc537645a0ee134db9f85b840ff31ecc" title="Pixels outside of the source pattern are fully transparent. ">Cairo::EXTEND_NONE</a> for surface patterns and <a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5a962ebab53840cfa2c8e2a6534c93a70d" title="Pixels outside of the pattern copy the closest pixel from the source (Since 1.2; but only implemented...">Cairo::EXTEND_PAD</a> for gradient patterns.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname"><a class="el" href="namespaceCairo.html#ae98882fd000921907007555a36a432a5" title="Cairo::Extend is used to describe how pattern color/alpha will be determined for areas &quot;outside&quot; the ...">Cairo::Extend</a></td><td>describing how the area outsize of the pattern will be drawn</td></tr>
  </table>
  </dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>1.12 </dd></dl>

</div>
</div>
<a class="anchor" id="a09dbb1295ba0a4f8a92b571aa6e425af"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cairo::Pattern::set_matrix </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCairo_1_1Matrix.html">Matrix</a>&amp;&#160;</td>
          <td class="paramname"><em>matrix</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the pattern's transformation matrix to . </p>
<p>This matrix is a transformation from user space to pattern space.</p>
<p>When a pattern is first created it always has the identity matrix for its transformation matrix, which means that pattern space is initially identical to user space.</p>
<p>Important: Please note that the direction of this transformation matrix is from user space to pattern space. This means that if you imagine the flow from a pattern to user space (and on to device space), then coordinates in that flow will be transformed by the inverse of the pattern matrix.</p>
<p>For example, if you want to make a pattern appear twice as large as it does by default the correct code to use is:</p>
<div class="fragment"><div class="line">pattern-&gt;set_matrix(scaling_matrix(0.5, 0.5));</div>
</div><!-- fragment --><p>Meanwhile, using values of 2.0 rather than 0.5 in the code above would cause the pattern to appear at half of its default size.</p>
<p>Also, please note the discussion of the user-space locking semantics of set_source(). </p>

</div>
</div>
<a class="anchor" id="aa50a29b9d4c669766355c917ab30b858"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cairo::Pattern::set_matrix </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcairo__matrix__t.html">cairo_matrix_t</a>&amp;&#160;</td>
          <td class="paramname"><em>matrix</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a4cd12b946da697a673bc02b73eca0a04"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cairo::Pattern::unreference </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a24fdc166f53a833ba1e1104a5690efbc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCairo_1_1Pattern.html#a430a261a68ae70ca1bd818c781178abc">cobject</a>* Cairo::Pattern::m_cobject</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>cairomm/pattern.h</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 21 2015 21:56:36 for cairomm by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>