Blame docs/reference/html/classCairo_1_1Pattern.html

Packit Service e3b512
Packit Service e3b512
<html xmlns="http://www.w3.org/1999/xhtml">
Packit Service e3b512
<head>
Packit Service e3b512
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Packit Service e3b512
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
Packit Service e3b512
<meta name="generator" content="Doxygen 1.8.9.1"/>
Packit Service e3b512
<title>cairomm: Cairo::Pattern Class Reference</title>
Packit Service e3b512
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Packit Service e3b512
<script type="text/javascript" src="jquery.js"></script>
Packit Service e3b512
<script type="text/javascript" src="dynsections.js"></script>
Packit Service e3b512
<link href="doxygen.css" rel="stylesheet" type="text/css" />
Packit Service e3b512
</head>
Packit Service e3b512
<body>
Packit Service e3b512
Packit Service e3b512
Packit Service e3b512
Packit Service e3b512
 
Packit Service e3b512
 
Packit Service e3b512
  
Packit Service e3b512
   
cairomm
Packit Service e3b512
    1.0
Packit Service e3b512
   
Packit Service e3b512
  
Packit Service e3b512
 
Packit Service e3b512
 
Packit Service e3b512
Packit Service e3b512
Packit Service e3b512
Packit Service e3b512
Packit Service e3b512
  
Packit Service e3b512
    
    Packit Service e3b512
          
  • Main Page
  • Packit Service e3b512
          
  • Related Pages
  • Packit Service e3b512
          
  • Namespaces
  • Packit Service e3b512
          
  • Classes
  • Packit Service e3b512
          
  • Examples
  • Packit Service e3b512
        
    Packit Service e3b512
      
    Packit Service e3b512
      
    Packit Service e3b512
        
      Packit Service e3b512
            
    • Class List
    • Packit Service e3b512
            
    • Class Hierarchy
    • Packit Service e3b512
            
    • Class Members
    • Packit Service e3b512
          
      Packit Service e3b512
        
      Packit Service e3b512
      Packit Service e3b512
        
        Packit Service e3b512
      • Cairo
      • Pattern
      • Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
          
        Packit Service e3b512
        Public Types |
        Packit Service e3b512
        Public Member Functions |
        Packit Service e3b512
        Protected Member Functions |
        Packit Service e3b512
        Protected Attributes |
        Packit Service e3b512
        List of all members  
        Packit Service e3b512
          
        Packit Service e3b512
        Cairo::Pattern Class Reference
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        Cairo::Pattern is the paint with which cairo draws.

        Packit Service e3b512
         More...

        Packit Service e3b512
        Packit Service e3b512
        Inheritance diagram for Cairo::Pattern:
        Packit Service e3b512
        Packit Service e3b512
        Inheritance graph
        Packit Service e3b512
        <map name="Cairo_1_1Pattern_inherit__map" id="Cairo_1_1Pattern_inherit__map">
        Packit Service e3b512
        <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>
        Packit Service e3b512
        <center>[legend]</center>
        Packit Service e3b512
        Packit Service e3b512

        Packit Service e3b512
        Public Types
        Packit Service e3b512
        typedef cairo_pattern_t cobject
        Packit Service e3b512
         
        Packit Service e3b512
        Packit Service e3b512

        Packit Service e3b512
        Public Member Functions
        Packit Service e3b512
         Pattern (cairo_pattern_t*cobject, bool has_reference=false)
        Packit Service e3b512
         Create a C++ wrapper for the C instance.  More...
        Packit Service e3b512
         
        Packit Service e3b512
         Pattern (const Pattern&)=delete
        Packit Service e3b512
         
        Packit Service e3b512
        Patternoperator= (const Pattern&)=delete
        Packit Service e3b512
         
        Packit Service e3b512
        virtual ~Pattern ()
        Packit Service e3b512
         
        Packit Service e3b512
        void set_matrix (const Matrix& matrix)
        Packit Service e3b512
         Sets the pattern's transformation matrix to .  More...
        Packit Service e3b512
         
        Packit Service e3b512
        void get_matrix (Matrix& matrix) const 
        Packit Service e3b512
         Returns the pattern's transformation matrix.  More...
        Packit Service e3b512
         
        Packit Service e3b512
        Matrix get_matrix () const 
        Packit Service e3b512
         Returns the pattern's transformation matrix.  More...
        Packit Service e3b512
         
        Packit Service e3b512
        void set_matrix (const cairo_matrix_t& matrix)
        Packit Service e3b512
         
        Packit Service e3b512
        void get_matrix (cairo_matrix_t& matrix) const 
        Packit Service e3b512
         
        Packit Service e3b512
        PatternType get_type () const 
        Packit Service e3b512
         Returns the type of the pattern.  More...
        Packit Service e3b512
         
        Packit Service e3b512
        void set_extend (Extend extend)
        Packit Service e3b512
         Sets the mode to be used for drawing outside the area of a pattern.  More...
        Packit Service e3b512
         
        Packit Service e3b512
        Extend get_extend () const 
        Packit Service e3b512
         Gets the current extend mode See Cairo::Extend for details on the semantics of each extend strategy.  More...
        Packit Service e3b512
         
        Packit Service e3b512
        cobjectcobj ()
        Packit Service e3b512
         
        Packit Service e3b512
        const cobjectcobj () const 
        Packit Service e3b512
         
        Packit Service e3b512
        void reference () const 
        Packit Service e3b512
         
        Packit Service e3b512
        void unreference () const 
        Packit Service e3b512
         
        Packit Service e3b512
        Packit Service e3b512

        Packit Service e3b512
        Protected Member Functions
        Packit Service e3b512
         Pattern ()
        Packit Service e3b512
         
        Packit Service e3b512
        Packit Service e3b512

        Packit Service e3b512
        Protected Attributes
        Packit Service e3b512
        cobjectm_cobject
        Packit Service e3b512
         
        Packit Service e3b512
        Packit Service e3b512

        Detailed Description

        Packit Service e3b512

        Cairo::Pattern is the paint with which cairo draws.

        Packit Service e3b512

        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.

        Packit Service e3b512

        This is a reference-counted object that should be used via Cairo::RefPtr.

        Packit Service e3b512

        Member Typedef Documentation

        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  typedef cairo_pattern_t Cairo::Pattern::cobject
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        Constructor & Destructor Documentation

        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  Cairo::Pattern::Pattern 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  cairo_pattern_t * 
        Packit Service e3b512
                  cobject, 
        Packit Service e3b512
                
        Packit Service e3b512
                
        Packit Service e3b512
                  
        Packit Service e3b512
                  
        Packit Service e3b512
                  bool 
        Packit Service e3b512
                  has_reference = false 
        Packit Service e3b512
                
        Packit Service e3b512
                
        Packit Service e3b512
                  
        Packit Service e3b512
                  )
        Packit Service e3b512
                  
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
        explicit  
        Packit Service e3b512
          
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        Create a C++ wrapper for the C instance.

        Packit Service e3b512

        This C++ instance should then be given to a RefPtr.

        Parameters
        Packit Service e3b512
          
        Packit Service e3b512
            cobjectThe C instance. 
        Packit Service e3b512
            has_referenceWhether we already have a reference. Otherwise, the constructor will take an extra reference. 
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  Cairo::Pattern::Pattern 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  const Pattern
        Packit Service e3b512
                  )
        Packit Service e3b512
                  
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
        delete  
        Packit Service e3b512
          
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  virtual Cairo::Pattern::~Pattern 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  )
        Packit Service e3b512
                  
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
        virtual  
        Packit Service e3b512
          
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  Cairo::Pattern::Pattern 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  )
        Packit Service e3b512
                  
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
        protected  
        Packit Service e3b512
          
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        Member Function Documentation

        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  cobject* Cairo::Pattern::cobj 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  )
        Packit Service e3b512
                  
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
        inline  
        Packit Service e3b512
          
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  const cobject* Cairo::Pattern::cobj 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  )
        Packit Service e3b512
                   const
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
        inline  
        Packit Service e3b512
          
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  Extend Cairo::Pattern::get_extend 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  )
        Packit Service e3b512
                   const
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        Gets the current extend mode See Cairo::Extend for details on the semantics of each extend strategy.

        Packit Service e3b512
        Since
        1.12
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  void Cairo::Pattern::get_matrix 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  Matrix
        Packit Service e3b512
                  matrix)
        Packit Service e3b512
                   const
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        Returns the pattern's transformation matrix.

        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  Matrix Cairo::Pattern::get_matrix 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  )
        Packit Service e3b512
                   const
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        Returns the pattern's transformation matrix.

        Packit Service e3b512
        Since
        1.8
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  void Cairo::Pattern::get_matrix 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  cairo_matrix_t
        Packit Service e3b512
                  matrix)
        Packit Service e3b512
                   const
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  PatternType Cairo::Pattern::get_type 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  )
        Packit Service e3b512
                   const
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        Returns the type of the pattern.

        Packit Service e3b512
        Since
        1.2
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  Pattern& Cairo::Pattern::operator= 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  const Pattern
        Packit Service e3b512
                  )
        Packit Service e3b512
                  
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
        delete  
        Packit Service e3b512
          
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  void Cairo::Pattern::reference 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  )
        Packit Service e3b512
                   const
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  void Cairo::Pattern::set_extend 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  Extend 
        Packit Service e3b512
                  extend)
        Packit Service e3b512
                  
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        Sets the mode to be used for drawing outside the area of a pattern.

        Packit Service e3b512

        See Cairo::Extend for details on the semantics of each extend strategy.

        Packit Service e3b512

        The default extend mode is Cairo::EXTEND_NONE for surface patterns and Cairo::EXTEND_PAD for gradient patterns.

        Packit Service e3b512
        Parameters
        Packit Service e3b512
          
        Packit Service e3b512
            Cairo::Extenddescribing how the area outsize of the pattern will be drawn
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
        Packit Service e3b512
        Since
        1.12
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  void Cairo::Pattern::set_matrix 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  const Matrix
        Packit Service e3b512
                  matrix)
        Packit Service e3b512
                  
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        Sets the pattern's transformation matrix to .

        Packit Service e3b512

        This matrix is a transformation from user space to pattern space.

        Packit Service e3b512

        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.

        Packit Service e3b512

        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.

        Packit Service e3b512

        For example, if you want to make a pattern appear twice as large as it does by default the correct code to use is:

        Packit Service e3b512
        pattern->set_matrix(scaling_matrix(0.5, 0.5));
        Packit Service e3b512

        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.

        Packit Service e3b512

        Also, please note the discussion of the user-space locking semantics of set_source().

        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  void Cairo::Pattern::set_matrix 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  const cairo_matrix_t
        Packit Service e3b512
                  matrix)
        Packit Service e3b512
                  
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  void Cairo::Pattern::unreference 
        Packit Service e3b512
                  (
        Packit Service e3b512
                  )
        Packit Service e3b512
                   const
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        Member Data Documentation

        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
              
        Packit Service e3b512
                
        Packit Service e3b512
                  cobject* Cairo::Pattern::m_cobject
        Packit Service e3b512
                
        Packit Service e3b512
              
        Packit Service e3b512
          
        Packit Service e3b512
          
        Packit Service e3b512
        protected  
        Packit Service e3b512
          
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512
        Packit Service e3b512

        The documentation for this class was generated from the following file:
          Packit Service e3b512
        • cairomm/pattern.h
        • Packit Service e3b512
          Packit Service e3b512
          Packit Service e3b512
          Packit Service e3b512

          <address class="footer"><small>
          Packit Service e3b512
          Generated on Mon Sep 21 2015 21:56:36 for cairomm by  
          Packit Service e3b512
          doxygen
          Packit Service e3b512
           1.8.9.1
          Packit Service e3b512
          </small></address>
          Packit Service e3b512
          </body>
          Packit Service e3b512
          </html>