Blame docs/reference/html/classCairo_1_1GlitzSurface.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::GlitzSurface 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
      • GlitzSurface
      • Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
          
        Packit 908522
        Public Member Functions |
        Packit 908522
        Static Public Member Functions |
        Packit 908522
        List of all members  
        Packit 908522
          
        Packit 908522
        Cairo::GlitzSurface Class Reference
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522

        A GlitzSurface provides a way to render to the X Window System using Glitz.

        Packit 908522
         More...

        Packit 908522
        Packit 908522
        Inheritance diagram for Cairo::GlitzSurface:
        Packit 908522
        Packit 908522
        Inheritance graph
        Packit 908522
        <map name="Cairo_1_1GlitzSurface_inherit__map" id="Cairo_1_1GlitzSurface_inherit__map">
        Packit 908522
        <area shape="rect" id="node2" href="classCairo_1_1Surface.html" title="A cairo surface represents an image, either as the destination of a drawing operation or as source wh..." alt="" coords="19,5,131,32"/></map>
        Packit 908522
        <center>[legend]</center>
        Packit 908522
        Packit 908522

        Packit 908522
        Public Member Functions
        Packit 908522
         GlitzSurface (cairo_surface_t*cobject, bool has_reference=false)
        Packit 908522
         Create a C++ wrapper for the C instance.  More...
        Packit 908522
         
        Packit 908522
        virtual ~GlitzSurface ()
        Packit 908522
         
        Packit 908522
        - Public Member Functions inherited from Cairo::Surface
        Packit 908522
         Surface (cairo_surface_t*cobject, bool has_reference=false)
        Packit 908522
         Create a C++ wrapper for the C instance.  More...
        Packit 908522
         
        Packit 908522
         Surface (const Surface&)=delete
        Packit 908522
         
        Packit 908522
        Surfaceoperator= (const Surface&)=delete
        Packit 908522
         
        Packit 908522
        virtual ~Surface ()
        Packit 908522
         
        Packit 908522
        const unsigned char* get_mime_data (const std::string& mime_type, unsigned long& length)
        Packit 908522
         Return mime data previously attached to surface using the specified mime type.  More...
        Packit 908522
         
        Packit 908522
        void set_mime_data (const std::string& mime_type, unsigned char* data, unsigned long length, const SlotDestroy& slot_destroy)
        Packit 908522
         Attach an image in the format mime_type to surface.  More...
        Packit 908522
         
        Packit 908522
        void unset_mime_data (const std::string& mime_type)
        Packit 908522
         Remove the data from a surface.  More...
        Packit 908522
         
        Packit 908522
        void get_font_options (FontOptions& options) const 
        Packit 908522
         Retrieves the default font rendering options for the surface.  More...
        Packit 908522
         
        Packit 908522
        void finish ()
        Packit 908522
         This function finishes the surface and drops all references to external resources.  More...
        Packit 908522
         
        Packit 908522
        void flush ()
        Packit 908522
         Do any pending drawing for the surface and also restore any temporary modifications cairo has made to the surface's state.  More...
        Packit 908522
         
        Packit 908522
        void mark_dirty ()
        Packit 908522
         Tells cairo to consider the data buffer dirty.  More...
        Packit 908522
         
        Packit 908522
        void mark_dirty (int x, int y, int width, int height)
        Packit 908522
         Marks a rectangular area of the given surface dirty.  More...
        Packit 908522
         
        Packit 908522
        void set_device_offset (double x_offset, double y_offset)
        Packit 908522
         Sets an offset that is added to the device coordinates determined by the CTM when drawing to surface.  More...
        Packit 908522
         
        Packit 908522
        void get_device_offset (double& x_offset, double& y_offset) const 
        Packit 908522
         Returns a previous device offset set by set_device_offset().  More...
        Packit 908522
         
        Packit 908522
        void set_fallback_resolution (double x_pixels_per_inch, double y_pixels_per_inch)
        Packit 908522
         Set the horizontal and vertical resolution for image fallbacks.  More...
        Packit 908522
         
        Packit 908522
        void get_fallback_resolution (double& x_pixels_per_inch, double& y_pixels_per_inch) const 
        Packit 908522
         This function returns the previous fallback resolution set by set_fallback_resolution(), or default fallback resolution if never set.  More...
        Packit 908522
         
        Packit 908522
        SurfaceType get_type () const 
        Packit 908522
         
        Packit 908522
        Content get_content () const 
        Packit 908522
         This function returns the content type of surface which indicates whether the surface contains color and/or alpha information.  More...
        Packit 908522
         
        Packit 908522
        void copy_page ()
        Packit 908522
         Emits the current page for backends that support multiple pages, but doesn't clear it, so that the contents of the current page will be retained for the next page.  More...
        Packit 908522
         
        Packit 908522
        void show_page ()
        Packit 908522
         Emits and clears the current page for backends that support multiple pages.  More...
        Packit 908522
         
        Packit 908522
        bool has_show_text_glyphs () const 
        Packit 908522
         Returns whether the surface supports sophisticated Context::show_text_glyphs() operations.  More...
        Packit 908522
         
        Packit 908522
        void write_to_png (const std::string& filename)
        Packit 908522
         Writes the contents of surface to a new file filename as a PNG image.  More...
        Packit 908522
         
        Packit 908522
        void write_to_png_stream (const SlotWriteFunc& write_func)
        Packit 908522
         Writes the Surface to the write function.  More...
        Packit 908522
         
        Packit 908522
        void write_to_png (cairo_write_func_t write_func, void* closure)
        Packit 908522
         
        Packit 908522
        RefPtr< Deviceget_device ()
        Packit 908522
         This function returns the device for a surface.  More...
        Packit 908522
         
        Packit 908522
        cobjectcobj ()
        Packit 908522
         Provides acces to the underlying C cairo surface.  More...
        Packit 908522
         
        Packit 908522
        const cobjectcobj () const 
        Packit 908522
         Provides acces to the underlying C cairo surface.  More...
        Packit 908522
         
        Packit 908522
        Packit 908522

        Packit 908522
        Static Public Member Functions
        Packit 908522
        static RefPtr< GlitzSurfacecreate (glitz_surface_t* surface)
        Packit 908522
         Creates a new GlitzSurface.  More...
        Packit 908522
         
        Packit 908522
        - Static Public Member Functions inherited from Cairo::Surface
        Packit 908522
        static RefPtr< Surfacecreate (const RefPtr< Surface > other, Content content, int width, int height)
        Packit 908522
         Create a new surface that is as compatible as possible with an existing surface.  More...
        Packit 908522
         
        Packit 908522
        static RefPtr< Surfacecreate (const RefPtr< Surface >& target, double x, double y, double width, double height)
        Packit 908522
         Create a new surface that is a rectangle within the target surface.  More...
        Packit 908522
         
        Packit 908522
        Packit 908522

        Packit 908522
        Additional Inherited Members
        Packit 908522
        - Public Types inherited from Cairo::Surface
        Packit 908522
        typedef sigc::slot< ErrorStatus, const unsigned char*, unsigned int > SlotWriteFunc
        Packit 908522
         For example:  ErrorStatus my_write_func(unsigned char* data, unsigned int length);   More...
        Packit 908522
         
        Packit 908522
        typedef sigc::slot< ErrorStatus, unsigned char*, unsigned int > SlotReadFunc
        Packit 908522
         This is the type of function which is called when a backend needs to read data from an input stream.  More...
        Packit 908522
         
        Packit 908522
        typedef sigc::slot< void > SlotDestroy
        Packit 908522
         For instance, void on_destroy();.  More...
        Packit 908522
         
        Packit 908522
        typedef cairo_surface_t cobject
        Packit 908522
         The underlying C cairo surface type.  More...
        Packit 908522
         
        Packit 908522
        - Protected Attributes inherited from Cairo::Surface
        Packit 908522
        cobjectm_cobject
        Packit 908522
         The underlying C cairo surface type that is wrapped by this Surface.  More...
        Packit 908522
         
        Packit 908522
        Packit 908522

        Detailed Description

        Packit 908522

        A GlitzSurface provides a way to render to the X Window System using Glitz.

        Packit 908522

        This provides a way to use OpenGL-accelerated graphics from cairo. If you want to use hardware-accelerated graphics within the X Window system, you should use this Surface type.

        Packit 908522
        Note
        For this Surface to be available, cairo must have been compiled with Glitz support
        Packit 908522
        Warning
        This is an experimental surface. It is not yet marked as a fully supported surface by the cairo library
        Packit 908522

        Constructor & Destructor Documentation

        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
          
        Packit 908522
          
        Packit 908522
              
        Packit 908522
                
        Packit 908522
                  Cairo::GlitzSurface::GlitzSurface 
        Packit 908522
                  (
        Packit 908522
                  cairo_surface_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.

        Packit 908522
        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::GlitzSurface::~GlitzSurface 
        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

        Member Function Documentation

        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
          
        Packit 908522
          
        Packit 908522
              
        Packit 908522
                
        Packit 908522
                  static RefPtr<GlitzSurface> Cairo::GlitzSurface::create 
        Packit 908522
                  (
        Packit 908522
                  glitz_surface_t * 
        Packit 908522
                  surface)
        Packit 908522
                  
        Packit 908522
                
        Packit 908522
              
        Packit 908522
          
        Packit 908522
          
        Packit 908522
        static  
        Packit 908522
          
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522

        Creates a new GlitzSurface.

        Packit 908522
        Parameters
        Packit 908522
          
        Packit 908522
            surfacea glitz surface type 
        Packit 908522
          
        Packit 908522
          
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522
        Packit 908522

        The documentation for this class was generated from the following file:
          Packit 908522
        • cairomm/surface.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>