Version: 3.1.1
wxGraphicsRenderer Class Referenceabstract

#include <wx/graphics.h>

+ Inheritance diagram for wxGraphicsRenderer:

Detailed Description

A wxGraphicsRenderer is the instance corresponding to the rendering engine used.

There may be multiple instances on a system, if there are different rendering engines present, but there is always only one instance per engine. This instance is pointed back to by all objects created by it (wxGraphicsContext, wxGraphicsPath etc.) and can be retrieved through their wxGraphicsObject::GetRenderer() method. Therefore you can create an additional instance of a path etc. by calling wxGraphicsObject::GetRenderer() and then using the appropriate CreateXXX() function of that renderer.

wxGraphicsPath *path = // from somewhere

Library:  wxCore
Category:  Graphics Device Interface (GDI)

Public Member Functions

virtual wxGraphicsBitmap CreateBitmap (const wxBitmap &bitmap)=0
 Creates wxGraphicsBitmap from an existing wxBitmap. More...
 
virtual wxGraphicsBitmap CreateBitmapFromImage (const wxImage &image)=0
 Creates wxGraphicsBitmap from an existing wxImage. More...
 
virtual wxImage CreateImageFromBitmap (const wxGraphicsBitmap &bmp)=0
 Creates a wxImage from a wxGraphicsBitmap. More...
 
virtual wxGraphicsBitmap CreateBitmapFromNativeBitmap (void *bitmap)=0
 Creates wxGraphicsBitmap from a native bitmap handle. More...
 
virtual wxGraphicsContextCreateContext (wxWindow *window)=0
 Creates a wxGraphicsContext from a wxWindow. More...
 
virtual wxGraphicsContextCreateContext (const wxWindowDC &windowDC)=0
 Creates a wxGraphicsContext from a wxWindowDC. More...
 
virtual wxGraphicsContextCreateContext (const wxMemoryDC &memoryDC)=0
 Creates a wxGraphicsContext from a wxMemoryDC. More...
 
virtual wxGraphicsContextCreateContext (const wxPrinterDC &printerDC)=0
 Creates a wxGraphicsContext from a wxPrinterDC. More...
 
virtual wxGraphicsContextCreateContext (const wxEnhMetaFileDC &metaFileDC)=0
 Creates a wxGraphicsContext from a wxEnhMetaFileDC. More...
 
wxGraphicsContextCreateContextFromImage (wxImage &image)
 Creates a wxGraphicsContext associated with a wxImage. More...
 
virtual wxGraphicsBrush CreateBrush (const wxBrush &brush)=0
 Creates a native brush from a wxBrush. More...
 
virtual wxGraphicsContextCreateContextFromNativeContext (void *context)=0
 Creates a wxGraphicsContext from a native context. More...
 
virtual wxGraphicsContextCreateContextFromNativeWindow (void *window)=0
 Creates a wxGraphicsContext from a native window. More...
 
virtual wxGraphicsContextCreateMeasuringContext ()=0
 Creates a wxGraphicsContext that can be used for measuring texts only. More...
 
virtual wxGraphicsFont CreateFont (const wxFont &font, const wxColour &col=*wxBLACK)=0
 Creates a native graphics font from a wxFont and a text colour. More...
 
virtual wxGraphicsFont CreateFont (double sizeInPixels, const wxString &facename, int flags=wxFONTFLAG_DEFAULT, const wxColour &col=*wxBLACK)=0
 Creates a graphics font with the given characteristics. More...
 
virtual wxGraphicsBrush CreateLinearGradientBrush (wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2, const wxGraphicsGradientStops &stops)=0
 Creates a native brush with a linear gradient. More...
 
virtual wxGraphicsMatrix CreateMatrix (wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0, wxDouble tx=0.0, wxDouble ty=0.0)=0
 Creates a native affine transformation matrix from the passed in values. More...
 
virtual wxGraphicsPath CreatePath ()=0
 Creates a native graphics path which is initially empty. More...
 
virtual wxGraphicsPen CreatePen (const wxPen &pen)=0
 Creates a native pen from a wxPen. More...
 
virtual wxGraphicsBrush CreateRadialGradientBrush (wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius, const wxGraphicsGradientStops &stops)=0
 Creates a native brush with a radial gradient. More...
 
virtual wxGraphicsBitmap CreateSubBitmap (const wxGraphicsBitmap &bitmap, wxDouble x, wxDouble y, wxDouble w, wxDouble h)=0
 Extracts a sub-bitmap from an existing bitmap. More...
 
virtual wxString GetName () const =0
 Returns the name of the technology used by the renderer. More...
 
virtual void GetVersion (int *major, int *minor=NULL, int *micro=NULL) const =0
 Returns the version major, minor and micro/build of the technology used by the renderer. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Static Public Member Functions

static wxGraphicsContextCreateContextFromNativeHDC (WXHDC dc)
 Creates a wxGraphicsContext from a native DC handle. More...
 
static wxGraphicsRendererGetDefaultRenderer ()
 Returns the default renderer on this platform. More...
 
static wxGraphicsRendererGetCairoRenderer ()
 Returns Cairo renderer. More...
 
static wxGraphicsRendererGetGDIPlusRenderer ()
 Returns GDI+ renderer (MSW only). More...
 
static wxGraphicsRendererGetDirect2DRenderer ()
 Returns Direct2D renderer (MSW only). More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Member Function Documentation

virtual wxGraphicsBitmap wxGraphicsRenderer::CreateBitmap ( const wxBitmap bitmap)
pure virtual

Creates wxGraphicsBitmap from an existing wxBitmap.

Returns an invalid wxNullGraphicsBitmap on failure.

virtual wxGraphicsBitmap wxGraphicsRenderer::CreateBitmapFromImage ( const wxImage image)
pure virtual

Creates wxGraphicsBitmap from an existing wxImage.

This method is more efficient than converting wxImage to wxBitmap first and then calling CreateBitmap() but otherwise has the same effect.

Returns an invalid wxNullGraphicsBitmap on failure.

Since
2.9.3
virtual wxGraphicsBitmap wxGraphicsRenderer::CreateBitmapFromNativeBitmap ( void *  bitmap)
pure virtual

Creates wxGraphicsBitmap from a native bitmap handle.

bitmap meaning is platform-dependent. Currently it's a GDI+ Bitmap pointer under MSW, CGImage pointer under OS X or a cairo_surface_t pointer when using Cairo under any platform.

Notice that this method takes ownership of bitmap, i.e. it will be destroyed when the returned wxGraphicsBitmap is.

virtual wxGraphicsBrush wxGraphicsRenderer::CreateBrush ( const wxBrush brush)
pure virtual

Creates a native brush from a wxBrush.

virtual wxGraphicsContext* wxGraphicsRenderer::CreateContext ( wxWindow window)
pure virtual

Creates a wxGraphicsContext from a wxWindow.

virtual wxGraphicsContext* wxGraphicsRenderer::CreateContext ( const wxWindowDC windowDC)
pure virtual

Creates a wxGraphicsContext from a wxWindowDC.

virtual wxGraphicsContext* wxGraphicsRenderer::CreateContext ( const wxMemoryDC memoryDC)
pure virtual

Creates a wxGraphicsContext from a wxMemoryDC.

virtual wxGraphicsContext* wxGraphicsRenderer::CreateContext ( const wxPrinterDC printerDC)
pure virtual

Creates a wxGraphicsContext from a wxPrinterDC.

Remarks
Not implemented for Direct2D renderer (on MSW).
virtual wxGraphicsContext* wxGraphicsRenderer::CreateContext ( const wxEnhMetaFileDC &  metaFileDC)
pure virtual

Creates a wxGraphicsContext from a wxEnhMetaFileDC.

This function, as wxEnhMetaFileDC class itself, is only available only under MSW (but not for Direct2D renderer).

wxGraphicsContext* wxGraphicsRenderer::CreateContextFromImage ( wxImage image)

Creates a wxGraphicsContext associated with a wxImage.

This function is used by wxContext::CreateFromImage() and is not normally called directly.

Since
2.9.3
virtual wxGraphicsContext* wxGraphicsRenderer::CreateContextFromNativeContext ( void *  context)
pure virtual

Creates a wxGraphicsContext from a native context.

This native context must be a CGContextRef for Core Graphics, a Graphics pointer for GDIPlus, an ID2D1RenderTarget pointer for Direct2D, a cairo_t pointer or HDC for Cairo on MSW, or a cairo_t pointer for Cairo on any other platform.

static wxGraphicsContext* wxGraphicsRenderer::CreateContextFromNativeHDC ( WXHDC  dc)
static

Creates a wxGraphicsContext from a native DC handle.

Windows only.

Since
3.1.1
virtual wxGraphicsContext* wxGraphicsRenderer::CreateContextFromNativeWindow ( void *  window)
pure virtual

Creates a wxGraphicsContext from a native window.

virtual wxGraphicsFont wxGraphicsRenderer::CreateFont ( const wxFont font,
const wxColour col = *wxBLACK 
)
pure virtual

Creates a native graphics font from a wxFont and a text colour.

virtual wxGraphicsFont wxGraphicsRenderer::CreateFont ( double  sizeInPixels,
const wxString facename,
int  flags = wxFONTFLAG_DEFAULT,
const wxColour col = *wxBLACK 
)
pure virtual

Creates a graphics font with the given characteristics.

If possible, the CreateFont() overload taking wxFont should be used instead. The main advantage of this overload is that it can be used without X server connection under Unix when using Cairo.

Parameters
sizeInPixelsHeight of the font in user space units, i.e. normally pixels. Notice that this is different from the overload taking wxFont as wxFont size is specified in points.
facenameThe name of the font. The same font name might not be available under all platforms so the font name can also be empty to use the default platform font.
flagsCombination of wxFontFlag enum elements. Currently only wxFONTFLAG_ITALIC and wxFONTFLAG_BOLD are supported. By default the normal font version is used.
colThe font colour, black by default.
Since
2.9.3
virtual wxImage wxGraphicsRenderer::CreateImageFromBitmap ( const wxGraphicsBitmap bmp)
pure virtual

Creates a wxImage from a wxGraphicsBitmap.

This method is used by the more convenient wxGraphicsBitmap::ConvertToImage.

virtual wxGraphicsBrush wxGraphicsRenderer::CreateLinearGradientBrush ( wxDouble  x1,
wxDouble  y1,
wxDouble  x2,
wxDouble  y2,
const wxGraphicsGradientStops stops 
)
pure virtual

Creates a native brush with a linear gradient.

Stops support is new since wxWidgets 2.9.1, previously only the start and end colours could be specified.

virtual wxGraphicsMatrix wxGraphicsRenderer::CreateMatrix ( wxDouble  a = 1.0,
wxDouble  b = 0.0,
wxDouble  c = 0.0,
wxDouble  d = 1.0,
wxDouble  tx = 0.0,
wxDouble  ty = 0.0 
)
pure virtual

Creates a native affine transformation matrix from the passed in values.

The defaults result in an identity matrix.

virtual wxGraphicsContext* wxGraphicsRenderer::CreateMeasuringContext ( )
pure virtual

Creates a wxGraphicsContext that can be used for measuring texts only.

No drawing commands are allowed.

virtual wxGraphicsPath wxGraphicsRenderer::CreatePath ( )
pure virtual

Creates a native graphics path which is initially empty.

virtual wxGraphicsPen wxGraphicsRenderer::CreatePen ( const wxPen pen)
pure virtual

Creates a native pen from a wxPen.

virtual wxGraphicsBrush wxGraphicsRenderer::CreateRadialGradientBrush ( wxDouble  xo,
wxDouble  yo,
wxDouble  xc,
wxDouble  yc,
wxDouble  radius,
const wxGraphicsGradientStops stops 
)
pure virtual

Creates a native brush with a radial gradient.

Stops support is new since wxWidgets 2.9.1, previously only the start and end colours could be specified.

virtual wxGraphicsBitmap wxGraphicsRenderer::CreateSubBitmap ( const wxGraphicsBitmap bitmap,
wxDouble  x,
wxDouble  y,
wxDouble  w,
wxDouble  h 
)
pure virtual

Extracts a sub-bitmap from an existing bitmap.

static wxGraphicsRenderer* wxGraphicsRenderer::GetCairoRenderer ( )
static

Returns Cairo renderer.

static wxGraphicsRenderer* wxGraphicsRenderer::GetDefaultRenderer ( )
static

Returns the default renderer on this platform.

On OS X this is the Core Graphics (a.k.a. Quartz 2D) renderer, on MSW the GDIPlus renderer, and on GTK we currently default to the Cairo renderer.

static wxGraphicsRenderer* wxGraphicsRenderer::GetDirect2DRenderer ( )
static

Returns Direct2D renderer (MSW only).

static wxGraphicsRenderer* wxGraphicsRenderer::GetGDIPlusRenderer ( )
static

Returns GDI+ renderer (MSW only).

virtual wxString wxGraphicsRenderer::GetName ( ) const
pure virtual

Returns the name of the technology used by the renderer.

Currently this function returns "gdiplus" for Windows GDI+ implementation, "direct2d" for Windows Direct2D implementation, "cairo" for Cairo implementation and "cg" for OS X CoreGraphics implementation.

Remarks
The string returned by this method is not user-readable and is expected to be used internally by the program only.
Since
3.1.0
virtual void wxGraphicsRenderer::GetVersion ( int *  major,
int *  minor = NULL,
int *  micro = NULL 
) const
pure virtual

Returns the version major, minor and micro/build of the technology used by the renderer.

Currently this function returns the OS major and minor versions in the parameters with the matching names and sets micro to 0 for the GDI+ and CoreGraphics engines which are considered to be parts of their respective OS.

For Cairo, this is the major,minor,micro version of the Cairo library which is returned.