Blame docs/reference/html/classCairo_1_1Gradient.html

Packit 908522
Packit 908522
<html xmlns="http://www.w3.org/1999/xhtml">
Packit 908522
<head>
Packit 908522
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Packit 908522
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
Packit 908522
<meta name="generator" content="Doxygen 1.8.9.1"/>
Packit 908522
<title>cairomm: Cairo::Gradient Class Reference</title>
Packit 908522
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Packit 908522
<script type="text/javascript" src="jquery.js"></script>
Packit 908522
<script type="text/javascript" src="dynsections.js"></script>
Packit 908522
<link href="doxygen.css" rel="stylesheet" type="text/css" />
Packit 908522
</head>
Packit 908522
<body>
Packit 908522
Packit 908522
Packit 908522
Packit 908522
 
Packit 908522
 
Packit 908522
  
Packit 908522
   
cairomm
Packit 908522
    1.0
Packit 908522
   
Packit 908522
  
Packit 908522
 
Packit 908522
 
Packit 908522
Packit 908522
Packit 908522
Packit 908522
Packit 908522
  
Packit 908522
    
    Packit 908522
          
  • Main Page
  • Packit 908522
          
  • Related Pages
  • Packit 908522
          
  • Namespaces
  • Packit 908522
          
  • Classes
  • Packit 908522
          
  • Examples
  • Packit 908522
        
    Packit 908522
      
    Packit 908522
      
    Packit 908522
        
      Packit 908522
            
    • Class List
    • Packit 908522
            
    • Class Hierarchy
    • Packit 908522
            
    • Class Members
    • Packit 908522
          
      Packit 908522
        
      Packit 908522
      Packit 908522
        
        Packit 908522
      • Cairo
      • Gradient
      • Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
          
        Packit 908522
        Public Member Functions |
        Packit 908522
        Protected Member Functions |
        Packit 908522
        List of all members  
        Packit 908522
          
        Packit 908522
        Cairo::Gradient Class Reference
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Inheritance diagram for Cairo::Gradient:
        Packit 908522
        Packit 908522
        Inheritance graph
        Packit 908522
        <map name="Cairo_1_1Gradient_inherit__map" id="Cairo_1_1Gradient_inherit__map">
        Packit 908522
        <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"/><area shape="rect" id="node2" href="classCairo_1_1Pattern.html" title="Cairo::Pattern is the paint with which cairo draws. " alt="" coords="120,5,229,32"/></map>
        Packit 908522
        <center>[legend]</center>
        Packit 908522
        Packit 908522

        Packit 908522
        Public Member Functions
        Packit 908522
         Gradient (cairo_pattern_t*cobject, bool has_reference=false)
        Packit 908522
         Create a C++ wrapper for the C instance.  More...
        Packit 908522
         
        Packit 908522
        virtual ~Gradient ()
        Packit 908522
         
        Packit 908522
        void add_color_stop_rgb (double offset, double red, double green, double blue)
        Packit 908522
         Adds an opaque color stop to a gradient pattern.  More...
        Packit 908522
         
        Packit 908522
        void add_color_stop_rgba (double offset, double red, double green, double blue, double alpha)
        Packit 908522
         Adds a translucent color stop to a gradient pattern.  More...
        Packit 908522
         
        Packit 908522
        std::vector< ColorStopget_color_stops () const 
        Packit 908522
         Gets the color stops and offsets for this Gradient.  More...
        Packit 908522
         
        Packit 908522
        - Public Member Functions inherited from Cairo::Pattern
        Packit 908522
         Pattern (cairo_pattern_t*cobject, bool has_reference=false)
        Packit 908522
         Create a C++ wrapper for the C instance.  More...
        Packit 908522
         
        Packit 908522
         Pattern (const Pattern&)=delete
        Packit 908522
         
        Packit 908522
        Patternoperator= (const Pattern&)=delete
        Packit 908522
         
        Packit 908522
        virtual ~Pattern ()
        Packit 908522
         
        Packit 908522
        void set_matrix (const Matrix& matrix)
        Packit 908522
         Sets the pattern's transformation matrix to .  More...
        Packit 908522
         
        Packit 908522
        void get_matrix (Matrix& matrix) const 
        Packit 908522
         Returns the pattern's transformation matrix.  More...
        Packit 908522
         
        Packit 908522
        Matrix get_matrix () const 
        Packit 908522
         Returns the pattern's transformation matrix.  More...
        Packit 908522
         
        Packit 908522
        void set_matrix (const cairo_matrix_t& matrix)
        Packit 908522
         
        Packit 908522
        void get_matrix (cairo_matrix_t& matrix) const 
        Packit 908522
         
        Packit 908522
        PatternType get_type () const 
        Packit 908522
         Returns the type of the pattern.  More...
        Packit 908522
         
        Packit 908522
        void set_extend (Extend extend)
        Packit 908522
         Sets the mode to be used for drawing outside the area of a pattern.  More...
        Packit 908522
         
        Packit 908522
        Extend get_extend () const 
        Packit 908522
         Gets the current extend mode See Cairo::Extend for details on the semantics of each extend strategy.  More...
        Packit 908522
         
        Packit 908522
        cobjectcobj ()
        Packit 908522
         
        Packit 908522
        const cobjectcobj () const 
        Packit 908522
         
        Packit 908522
        void reference () const 
        Packit 908522
         
        Packit 908522
        void unreference () const 
        Packit 908522
         
        Packit 908522
        Packit 908522

        Packit 908522
        Protected Member Functions
        Packit 908522
         Gradient ()
        Packit 908522
         
        Packit 908522
        - Protected Member Functions inherited from Cairo::Pattern
        Packit 908522
         Pattern ()
        Packit 908522
         
        Packit 908522
        Packit 908522

        Packit 908522
        Additional Inherited Members
        Packit 908522
        - Public Types inherited from Cairo::Pattern
        Packit 908522
        typedef cairo_pattern_t cobject
        Packit 908522
         
        Packit 908522
        - Protected Attributes inherited from Cairo::Pattern
        Packit 908522
        cobjectm_cobject
        Packit 908522
         
        Packit 908522
        Packit 908522

        Constructor & Destructor Documentation

        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
          
        Packit 908522
          
        Packit 908522
              
        Packit 908522
                
        Packit 908522
                  Cairo::Gradient::Gradient 
        Packit 908522
                  (
        Packit 908522
                  cairo_pattern_t * 
        Packit 908522
                  cobject, 
        Packit 908522
                
        Packit 908522
                
        Packit 908522
                  
        Packit 908522
                  
        Packit 908522
                  bool 
        Packit 908522
                  has_reference = false 
        Packit 908522
                
        Packit 908522
                
        Packit 908522
                  
        Packit 908522
                  )
        Packit 908522
                  
        Packit 908522
                
        Packit 908522
              
        Packit 908522
          
        Packit 908522
          
        Packit 908522
        explicit  
        Packit 908522
          
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522

        Create a C++ wrapper for the C instance.

        Packit 908522

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

        Parameters
        Packit 908522
          
        Packit 908522
            cobjectThe C instance. 
        Packit 908522
            has_referenceWhether we already have a reference. Otherwise, the constructor will take an extra reference. 
        Packit 908522
          
        Packit 908522
          
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
          
        Packit 908522
          
        Packit 908522
              
        Packit 908522
                
        Packit 908522
                  virtual Cairo::Gradient::~Gradient 
        Packit 908522
                  (
        Packit 908522
                  )
        Packit 908522
                  
        Packit 908522
                
        Packit 908522
              
        Packit 908522
          
        Packit 908522
          
        Packit 908522
        virtual  
        Packit 908522
          
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
          
        Packit 908522
          
        Packit 908522
              
        Packit 908522
                
        Packit 908522
                  Cairo::Gradient::Gradient 
        Packit 908522
                  (
        Packit 908522
                  )
        Packit 908522
                  
        Packit 908522
                
        Packit 908522
              
        Packit 908522
          
        Packit 908522
          
        Packit 908522
        protected  
        Packit 908522
          
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522

        Member Function Documentation

        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
              
        Packit 908522
                
        Packit 908522
                  void Cairo::Gradient::add_color_stop_rgb 
        Packit 908522
                  (
        Packit 908522
                  double 
        Packit 908522
                  offset, 
        Packit 908522
                
        Packit 908522
                
        Packit 908522
                  
        Packit 908522
                  
        Packit 908522
                  double 
        Packit 908522
                  red, 
        Packit 908522
                
        Packit 908522
                
        Packit 908522
                  
        Packit 908522
                  
        Packit 908522
                  double 
        Packit 908522
                  green, 
        Packit 908522
                
        Packit 908522
                
        Packit 908522
                  
        Packit 908522
                  
        Packit 908522
                  double 
        Packit 908522
                  blue 
        Packit 908522
                
        Packit 908522
                
        Packit 908522
                  
        Packit 908522
                  )
        Packit 908522
                  
        Packit 908522
                
        Packit 908522
              
        Packit 908522
        Packit 908522
        Packit 908522

        Adds an opaque color stop to a gradient pattern.

        Packit 908522

        The offset specifies the location along the gradient's control vector. For example, a linear gradient's control vector is from (x0,y0) to (x1,y1) while a radial gradient's control vector is from any point on the start circle to the corresponding point on the end circle.

        Packit 908522

        The color is specified in the same way as in Context::set_source_rgb().

        Packit 908522

        If two (or more) stops are specified with identical offset values, they will be sorted according to the order in which the stops are added, (stops added earlier will compare less than stops added later). This can be useful for reliably making sharp color transitions instead of the typical blend.

        Packit 908522
        Parameters
        Packit 908522
          
        Packit 908522
            offsetan offset in the range [0.0 .. 1.0] 
        Packit 908522
            redred component of color 
        Packit 908522
            greengreen component of color 
        Packit 908522
            blueblue component of color 
        Packit 908522
          
        Packit 908522
          
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
              
        Packit 908522
                
        Packit 908522
                  void Cairo::Gradient::add_color_stop_rgba 
        Packit 908522
                  (
        Packit 908522
                  double 
        Packit 908522
                  offset, 
        Packit 908522
                
        Packit 908522
                
        Packit 908522
                  
        Packit 908522
                  
        Packit 908522
                  double 
        Packit 908522
                  red, 
        Packit 908522
                
        Packit 908522
                
        Packit 908522
                  
        Packit 908522
                  
        Packit 908522
                  double 
        Packit 908522
                  green, 
        Packit 908522
                
        Packit 908522
                
        Packit 908522
                  
        Packit 908522
                  
        Packit 908522
                  double 
        Packit 908522
                  blue, 
        Packit 908522
                
        Packit 908522
                
        Packit 908522
                  
        Packit 908522
                  
        Packit 908522
                  double 
        Packit 908522
                  alpha 
        Packit 908522
                
        Packit 908522
                
        Packit 908522
                  
        Packit 908522
                  )
        Packit 908522
                  
        Packit 908522
                
        Packit 908522
              
        Packit 908522
        Packit 908522
        Packit 908522

        Adds a translucent color stop to a gradient pattern.

        Packit 908522

        The offset specifies the location along the gradient's control vector. For example, a linear gradient's control vector is from (x0,y0) to (x1,y1) while a radial gradient's control vector is from any point on the start circle to the corresponding point on the end circle.

        Packit 908522

        The color is specified in the same way as in Context::set_source_rgba().

        Packit 908522

        If two (or more) stops are specified with identical offset values, they will be sorted according to the order in which the stops are added, (stops added earlier will compare less than stops added later). This can be useful for reliably making sharp color transitions instead of the typical blend.

        Packit 908522
        Parameters
        Packit 908522
          
        Packit 908522
            offsetan offset in the range [0.0 .. 1.0] 
        Packit 908522
            redred component of color 
        Packit 908522
            greengreen component of color 
        Packit 908522
            blueblue component of color 
        Packit 908522
            alphaalpha component of color 
        Packit 908522
          
        Packit 908522
          
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
              
        Packit 908522
                
        Packit 908522
                  std::vector<ColorStop> Cairo::Gradient::get_color_stops 
        Packit 908522
                  (
        Packit 908522
                  )
        Packit 908522
                   const
        Packit 908522
                
        Packit 908522
              
        Packit 908522
        Packit 908522
        Packit 908522

        Gets the color stops and offsets for this Gradient.

        Packit 908522
        Since
        1.4
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522

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

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