cairomm 1.14.5
Cairo::SurfacePattern Class Reference

#include <cairomm/pattern.h>

Inheritance diagram for Cairo::SurfacePattern:

Public Member Functions

 SurfacePattern (cairo_pattern_t *cobject, bool has_reference=false)
 Create a C++ wrapper for the C instance.
 
 ~SurfacePattern () override
 
void set_extend (Extend extend)
 
Extend get_extend () const
 
void set_filter (Filter filter)
 Sets the filter to be used for resizing when using this pattern.
 
Filter get_filter () const
 Gets the current filter for a pattern.
 
RefPtr< const Surfaceget_surface () const
 Gets the surface associated with this pattern.
 
RefPtr< Surfaceget_surface ()
 
- Public Member Functions inherited from Cairo::Pattern
 Pattern (cairo_pattern_t *cobject, bool has_reference=false)
 Create a C++ wrapper for the C instance.
 
 Pattern (const Pattern &)=delete
 
Patternoperator= (const Pattern &)=delete
 
virtual ~Pattern ()
 
void set_matrix (const Matrix & matrix)
 Sets the pattern's transformation matrix to @matrix.
 
void get_matrix (Matrix & matrix) const
 Returns the pattern's transformation matrix.
 
Matrix get_matrix () const
 Returns the pattern's transformation matrix.
 
void set_matrix (const cairo_matrix_t & matrix)
 
void get_matrix (cairo_matrix_t & matrix) const
 
PatternType get_type () const
 Returns the type of the pattern.
 
void set_extend (Extend extend)
 Sets the mode to be used for drawing outside the area of a pattern.
 
Extend get_extend () const
 Gets the current extend mode See Cairo::Extend for details on the semantics of each extend strategy.
 
cobjectcobj ()
 
const cobjectcobj () const
 
void reference () const
 
void unreference () const
 

Static Public Member Functions

static RefPtr< SurfacePatterncreate (const RefPtr< Surface > & surface)
 Create a new Cairo::Pattern for the given surface.
 

Protected Member Functions

 SurfacePattern (const RefPtr< Surface > & surface)
 
- Protected Member Functions inherited from Cairo::Pattern
 Pattern ()
 

Additional Inherited Members

- Public Types inherited from Cairo::Pattern
typedef cairo_pattern_t cobject
 
- Protected Attributes inherited from Cairo::Pattern
cobjectm_cobject
 

Constructor & Destructor Documentation

◆ SurfacePattern() [1/2]

Cairo::SurfacePattern::SurfacePattern ( const RefPtr< Surface > & surface)
explicitprotected

◆ SurfacePattern() [2/2]

Cairo::SurfacePattern::SurfacePattern ( cairo_pattern_t * cobject,
bool has_reference = false )
explicit

Create a C++ wrapper for the C instance.

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

Parameters
cobjectThe C instance.
has_referenceWhether we already have a reference. Otherwise, the constructor will take an extra reference.

◆ ~SurfacePattern()

Cairo::SurfacePattern::~SurfacePattern ( )
override

Member Function Documentation

◆ create()

static RefPtr< SurfacePattern > Cairo::SurfacePattern::create ( const RefPtr< Surface > & surface)
static

Create a new Cairo::Pattern for the given surface.

◆ get_extend()

Extend Cairo::SurfacePattern::get_extend ( ) const

◆ get_filter()

Filter Cairo::SurfacePattern::get_filter ( ) const

Gets the current filter for a pattern.

See Cairo::Filter for details on each filter.

◆ get_surface() [1/2]

RefPtr< Surface > Cairo::SurfacePattern::get_surface ( )

◆ get_surface() [2/2]

RefPtr< const Surface > Cairo::SurfacePattern::get_surface ( ) const

Gets the surface associated with this pattern.

Since
1.4

◆ set_extend()

void Cairo::SurfacePattern::set_extend ( Extend extend)

◆ set_filter()

void Cairo::SurfacePattern::set_filter ( Filter filter)

Sets the filter to be used for resizing when using this pattern.

See Cairo::Filter for details on each filter.

Note that you might want to control filtering even when you do not have an explicit Cairo::Pattern object, (for example when using Cairo::Context::set_source_surface()). In these cases, it is convenient to use Cairo::Context::get_source() to get access to the pattern that cairo creates implicitly.

Parameters
filterCairo::Filter describing the filter to use for resizing the pattern

The documentation for this class was generated from the following file: