wx.GraphicsRenderer¶

A wx.GraphicsRenderer 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 ( wx.GraphicsContext, wx.GraphicsPath, etc.) and can be retrieved through their wx.GraphicsObject.GetRenderer method. Therefore, you can create an additional instance of a path (or other objects) by calling wx.GraphicsObject.GetRenderer and then using the appropriate CreateXXX() function of that renderer.

path = wx.GraphicsPath() # from somewhere
brush = path.GetRenderer().CreateBrush(wx.BLACK_BRUSH)

Class Hierarchy¶

Inheritance diagram for class GraphicsRenderer:

Methods Summary¶

`CreateBitmap`	Creates wx.GraphicsBitmap from an existing wx.Bitmap.
`CreateBitmapFromImage`	Creates wx.GraphicsBitmap from an existing wx.Image.
`CreateBitmapFromNativeBitmap`	Creates wx.GraphicsBitmap from a native bitmap handle.
`CreateBrush`	Creates a native brush from a wx.Brush.
`CreateContext`	Creates a wx.GraphicsContext from a wx.Window.
`CreateContextFromImage`	Creates a wx.GraphicsContext associated with a wx.Image.
`CreateContextFromNativeContext`	Creates a wx.GraphicsContext from a native context.
`CreateContextFromNativeWindow`	Creates a wx.GraphicsContext from a native window.
`CreateContextFromUnknownDC`	Creates a wx.GraphicsContext from a DC of unknown specific type.
`CreateFont`	Creates a native graphics font from a wx.Font and a text colour.
`CreateFontAtDPI`	Creates a native graphics font from a wx.Font and a text colour.
`CreateImageFromBitmap`	Creates a wx.Image from a wx.GraphicsBitmap.
`CreateLinearGradientBrush`	Creates a native brush with a linear gradient.
`CreateMatrix`	Creates a native affine transformation matrix from the passed in values.
`CreateMeasuringContext`	Creates a wx.GraphicsContext that can be used for measuring texts only.
`CreatePath`	Creates a native graphics path which is initially empty.
`CreatePen`	Creates a native pen from its description.
`CreateRadialGradientBrush`	Creates a native brush with a radial gradient.
`CreateSubBitmap`	Extracts a sub-bitmap from an existing bitmap.
`GetCairoRenderer`	Returns the Cairo renderer.
`GetDefaultRenderer`	Returns the default renderer on this platform.
`GetDirect2DRenderer`	Returns Direct2D renderer (MSW and Python3 only).
`GetGDIPlusRenderer`	Returns GDI+ renderer (MSW only).
`GetName`	Returns the name of the technology used by the renderer.
`GetType`	Returns the name of the GraphicsRenderer class.
`GetVersion`	Returns the version major, minor and micro/build of the technology used by the renderer.

Properties Summary¶

`Name`	See `GetName`
`Type`	See `GetType`

Class API¶

class wx.GraphicsRenderer(Object)¶

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

Methods¶

CreateBitmap(self, bitmap)¶

Creates wx.GraphicsBitmap from an existing wx.Bitmap.

Parameters:: bitmap (wx.Bitmap)
Return type:: wx.GraphicsBitmap
Returns:: An invalid NullGraphicsBitmap on failure.

CreateBitmapFromImage(self, image)¶

Creates wx.GraphicsBitmap from an existing wx.Image.

This method is more efficient than converting a wx.Image to a wx.Bitmap first and then calling CreateBitmap , but otherwise has the same effect.

Parameters:: image (wx.Image)
Return type:: wx.GraphicsBitmap
Returns:: An invalid NullGraphicsBitmap on failure.

Added in version 2.9.3.

CreateBitmapFromNativeBitmap(self, bitmap)¶

Creates wx.GraphicsBitmap from a native bitmap handle.

bitmap meaning is platform-dependent. Currently, it’s a GDI+ Bitmap pointer under MSW, a CGImage pointer under macOS 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 wx.GraphicsBitmap is.

Parameters:: bitmap
Return type:: wx.GraphicsBitmap

CreateBrush(self, brush)¶

Creates a native brush from a wx.Brush.

Parameters:: brush (wx.Brush)
Return type:: wx.GraphicsBrush

CreateContext(self, *args, **kw)¶

Overloaded Implementations:

CreateContext (self, window)

Creates a wx.GraphicsContext from a wx.Window.

Parameters:: window (wx.Window)
Return type:: wx.GraphicsContext

CreateContext (self, windowDC)

Creates a wx.GraphicsContext from a wx.WindowDC.

Parameters:: windowDC (wx.WindowDC)
Return type:: wx.GraphicsContext

CreateContext (self, memoryDC)

Creates a wx.GraphicsContext from a wx.MemoryDC.

Parameters:: memoryDC (wx.MemoryDC)
Return type:: wx.GraphicsContext

CreateContext (self, printerDC)

Creates a wx.GraphicsContext from a wx.PrinterDC.

Parameters:: printerDC (wx.PrinterDC)
Return type:: wx.GraphicsContext

Note

Not implemented for the Direct2D renderer (on MSW).

CreateContextFromImage(self, image)¶

Creates a wx.GraphicsContext associated with a wx.Image.

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

Parameters:: image (wx.Image)
Return type:: wx.GraphicsContext

Added in version 2.9.3.

CreateContextFromNativeContext(self, context)¶

Creates a wx.GraphicsContext from a native context.

This native context must be a CGContextRef for Core Graphics, a Graphics pointer for GDI+, 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.

Parameters:: context
Return type:: wx.GraphicsContext

CreateContextFromNativeWindow(self, window)¶

Creates a wx.GraphicsContext from a native window.

Parameters:: window
Return type:: wx.GraphicsContext

CreateContextFromUnknownDC(self, dc)¶

Creates a wx.GraphicsContext from a DC of unknown specific type.

Creates a wx.GraphicsContext if dc is a supported type (i.e. has a corresponding CreateContext method, e.g. wx.WindowDC or wx.MemoryDC).

This method is only useful as a helper in generic code that operates with wx.DC and doesn’t known its exact type. Use the appropriate CreateContext overload instead if you know what the DC is (e.g., wx.WindowDC).

Parameters:: dc (wx.DC)
Return type:: wx.GraphicsContext
Returns:: nullptr if the DC is unsupported.

Added in version 4.1/wxWidgets-3.1.3.

Properties¶

Name¶: See GetName

Type¶: See GetType

Navigation