DISTRHO Plugin Framework
Public Member Functions | List of all members
CairoImage Class Reference

#include <Cairo.hpp>

Inheritance diagram for CairoImage:
ImageBase

Public Member Functions

 CairoImage ()
 
 CairoImage (const char *rawData, uint width, uint height, ImageFormat format)
 
 CairoImage (const char *rawData, const Size< uint > &size, ImageFormat format)
 
 CairoImage (const CairoImage &image)
 
 ~CairoImage () override
 
void loadFromMemory (const char *rawData, const Size< uint > &size, ImageFormat format=kImageFormatBGRA) noexcept override
 
void loadFromPNG (const char *pngData, uint dataSize) noexcept
 
void drawAt (const GraphicsContext &context, const Point< int > &pos) override
 
cairo_surface_t * getSurface () const noexcept
 
CairoImageoperator= (const CairoImage &image) noexcept
 
void loadFromMemory (const char *rdata, uint w, uint h, ImageFormat fmt=kImageFormatBGRA)
 
void draw (const GraphicsContext &context)
 
void drawAt (const GraphicsContext &context, int x, int y)
 
- Public Member Functions inherited from ImageBase
virtual ~ImageBase ()
 
bool isValid () const noexcept
 
bool isInvalid () const noexcept
 
uint getWidth () const noexcept
 
uint getHeight () const noexcept
 
const Size< uint > & getSize () const noexcept
 
const char * getRawData () const noexcept
 
ImageFormat getFormat () const noexcept
 
void loadFromMemory (const char *rawData, uint width, uint height, ImageFormat format=kImageFormatBGRA) noexcept
 
void draw (const GraphicsContext &context)
 
void drawAt (const GraphicsContext &context, int x, int y)
 
ImageBaseoperator= (const ImageBase &image) noexcept
 
bool operator== (const ImageBase &image) const noexcept
 
bool operator!= (const ImageBase &image) const noexcept
 

Additional Inherited Members

- Protected Member Functions inherited from ImageBase
 ImageBase ()
 
 ImageBase (const char *rawData, uint width, uint height, ImageFormat format)
 
 ImageBase (const char *rawData, const Size< uint > &size, ImageFormat format)
 
 ImageBase (const ImageBase &image)
 
- Protected Attributes inherited from ImageBase
const char * rawData
 
Size< uint > size
 
ImageFormat format
 

Detailed Description

Cairo Image class.

TODO ...

Constructor & Destructor Documentation

◆ CairoImage() [1/4]

CairoImage::CairoImage ( )

Constructor for a null Image.

◆ CairoImage() [2/4]

CairoImage::CairoImage ( const char *  rawData,
uint  width,
uint  height,
ImageFormat  format 
)

Constructor using raw image data.

Note
rawData must remain valid for the lifetime of this Image.

◆ CairoImage() [3/4]

CairoImage::CairoImage ( const char *  rawData,
const Size< uint > &  size,
ImageFormat  format 
)

Constructor using raw image data.

Note
rawData must remain valid for the lifetime of this Image.

◆ CairoImage() [4/4]

CairoImage::CairoImage ( const CairoImage image)

Constructor using another image data.

◆ ~CairoImage()

CairoImage::~CairoImage ( )
override

Destructor.

Member Function Documentation

◆ loadFromMemory()

void CairoImage::loadFromMemory ( const char *  rawData,
const Size< uint > &  size,
ImageFormat  format = kImageFormatBGRA 
)
overridevirtualnoexcept

Load raw image data from memory.

Note
rawData must remain valid for the lifetime of this Image.

Reimplemented from ImageBase.

◆ loadFromPNG()

void CairoImage::loadFromPNG ( const char *  pngData,
uint  dataSize 
)
noexcept

Load PNG image from memory. Image size is read from PNG contents.

Note
pngData must remain valid for the lifetime of this Image.

◆ drawAt()

void CairoImage::drawAt ( const GraphicsContext context,
const Point< int > &  pos 
)
overridevirtual

Draw this image at position pos using the graphics context context.

Implements ImageBase.

◆ getSurface()

cairo_surface_t* CairoImage::getSurface ( ) const
inlinenoexcept

Get the cairo surface currently associated with this image. FIXME might be removed

◆ operator=()

CairoImage& CairoImage::operator= ( const CairoImage image)
noexcept

TODO document this.


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