wxGraphicsRenderer (wx v2.5.4)

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/1 method. Therefore you can create an additional instance of a path etc. by calling wxGraphicsObject:getRenderer/1 and then using the appropriate CreateXXX() function of that renderer.

wxWidgets docs: wxGraphicsRenderer

Summary

Types

wxGraphicsRenderer()

Functions

createBrush(This, Brush)

Creates a native brush from a wxBrush.

createContext(This, WindowDC)

Creates a wxGraphicsContext from a wxWindowDC.

createFont(This, Font)

createFont/3

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

createFont/4

Creates a graphics font with the given characteristics.

createLinearGradientBrush(This, X1, Y1, X2, Y2, Stops)

Creates a native brush with a linear gradient.

createMatrix(This)

createMatrix/2

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

createPath(This)

Creates a native graphics path which is initially empty.

createRadialGradientBrush(This, StartX, StartY, EndX, EndY, Radius, Stops)

Creates a native brush with a radial gradient.

getDefaultRenderer()

Returns the default renderer on this platform.

Types

wxGraphicsRenderer()

-type wxGraphicsRenderer() :: wx:wx_object().

Functions

createBrush(This, Brush) -> Result

Types

This = wxGraphicsRenderer()

Brush = wxBrush:wxBrush()

Result = wxGraphicsBrush:wxGraphicsBrush()

Creates a native brush from a wxBrush.

createContext(This, WindowDC) -> Result

Types

This = wxGraphicsRenderer()

WindowDC = wxWindowDC:wxWindowDC() | wxWindow:wxWindow() | wxMemoryDC:wxMemoryDC()

Result = wxGraphicsContext:wxGraphicsContext()

Creates a wxGraphicsContext from a wxWindowDC.

createFont(This, Font) ≡ createFont(This, Font, [])

createFont/3

-spec createFont(This, Font) -> wxGraphicsFont:wxGraphicsFont()
                    when This :: wxGraphicsRenderer(), Font :: wxFont:wxFont().

-spec createFont(This, SizeInPixels, Facename) -> wxGraphicsFont:wxGraphicsFont()
                    when
                        This :: wxGraphicsRenderer(),
                        SizeInPixels :: number(),
                        Facename :: unicode:chardata();
                (This, Font, [Option]) -> wxGraphicsFont:wxGraphicsFont()
                    when
                        This :: wxGraphicsRenderer(),
                        Font :: wxFont:wxFont(),
                        Option :: {col, wx:wx_colour()}.

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

createFont/4

-spec createFont(This, SizeInPixels, Facename, [Option]) -> wxGraphicsFont:wxGraphicsFont()
                    when
                        This :: wxGraphicsRenderer(),
                        SizeInPixels :: number(),
                        Facename :: unicode:chardata(),
                        Option :: {flags, integer()} | {col, wx:wx_colour()}.

Creates a graphics font with the given characteristics.

If possible, the createFont/4 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.

Since: 2.9.3

createLinearGradientBrush(This, X1, Y1, X2, Y2, Stops) -> Result

Types

This = wxGraphicsRenderer()

X1 = Y1 = X2 = Y2 = number()

Stops = wxGraphicsGradientStops:wxGraphicsGradientStops()

Result = wxGraphicsBrush:wxGraphicsBrush()

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.

The ability to apply a transformation matrix to the gradient was added in 3.1.3

createMatrix(This) ≡ createMatrix(This, [])

createMatrix/2

-spec createMatrix(This) -> wxGraphicsMatrix:wxGraphicsMatrix() when This :: wxGraphicsRenderer().

-spec createMatrix(This, [Option]) -> wxGraphicsMatrix:wxGraphicsMatrix()
                      when
                          This :: wxGraphicsRenderer(),
                          Option ::
                              {a, number()} |
                              {b, number()} |
                              {c, number()} |
                              {d, number()} |
                              {tx, number()} |
                              {ty, number()}.

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

The defaults result in an identity matrix.

createPath(This :: wxGraphicsRenderer()) -> Result

Types

Result = wxGraphicsPath:wxGraphicsPath()

Creates a native graphics path which is initially empty.

createRadialGradientBrush(This, StartX, StartY, EndX, EndY, Radius, Stops) -> Result

Types

This = wxGraphicsRenderer()

StartX = StartY = EndX = EndY = Radius = number()

Stops = wxGraphicsGradientStops:wxGraphicsGradientStops()

Result = wxGraphicsBrush:wxGraphicsBrush()

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.

The ability to apply a transformation matrix to the gradient was added in 3.1.3

getDefaultRenderer() -> Result

Types

Result = wxGraphicsRenderer()

Returns the default renderer on this platform.

On macOS 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.