View Source wxGraphicsRenderer (wx v2.4.2)

Functions for wxGraphicsRenderer class

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

Functions

Creates a native brush from a wxBrush.

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

Creates a graphics font with the given characteristics.

Creates a native brush with a linear gradient.

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

Creates a native graphics path which is initially empty.

Returns the default renderer on this platform.

Types

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

Functions

Link to this function

createBrush(This, Brush)

View Source
-spec createBrush(This, Brush) -> wxGraphicsBrush:wxGraphicsBrush()
               when This :: wxGraphicsRenderer(), Brush :: wxBrush:wxBrush().

Creates a native brush from a wxBrush.

Link to this function

createContext(This, WindowDC)

View Source
-spec createContext(This, WindowDC) -> wxGraphicsContext:wxGraphicsContext()
                 when
                     This :: wxGraphicsRenderer(),
                     WindowDC ::
                         wxWindowDC:wxWindowDC() | wxWindow:wxWindow() | wxMemoryDC:wxMemoryDC().

Creates a wxGraphicsContext from a wxWindowDC.

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

-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

Link to this function

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

View Source
-spec createLinearGradientBrush(This, X1, Y1, X2, Y2, Stops) -> wxGraphicsBrush:wxGraphicsBrush()
                             when
                                 This :: wxGraphicsRenderer(),
                                 X1 :: number(),
                                 Y1 :: number(),
                                 X2 :: number(),
                                 Y2 :: number(),
                                 Stops :: wxGraphicsGradientStops:wxGraphicsGradientStops().

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

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

-spec createPath(This) -> wxGraphicsPath:wxGraphicsPath() when This :: wxGraphicsRenderer().

Creates a native graphics path which is initially empty.

Link to this function

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

View Source
-spec createRadialGradientBrush(This, StartX, StartY, EndX, EndY, Radius, Stops) ->
                             wxGraphicsBrush:wxGraphicsBrush()
                             when
                                 This :: wxGraphicsRenderer(),
                                 StartX :: number(),
                                 StartY :: number(),
                                 EndX :: number(),
                                 EndY :: number(),
                                 Radius :: number(),
                                 Stops :: wxGraphicsGradientStops:wxGraphicsGradientStops().

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

-spec getDefaultRenderer() -> 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.