Erlang -- wxGraphicsRenderer

# wxGraphicsRenderer

###
Module

wxGraphicsRenderer

###
Module Summary

Functions for wxGraphicsRenderer class

###
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/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

###
Data Types

####
wxGraphicsRenderer() = wx:wx_object()

###
Exports

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

####
createContext(This, WindowDC) ->
wxGraphicsContext:wxGraphicsContext()

### Types

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

Creates a wxGraphicsContext from a wxWindowDC.

####
createBrush(This, Brush) -> wxGraphicsBrush:wxGraphicsBrush()

### Types

This = wxGraphicsRenderer()
Brush = wxBrush:wxBrush()

Creates a native brush from a wxBrush.

####
createLinearGradientBrush(This, X1, Y1, X2, Y2, Stops) ->
wxGraphicsBrush:wxGraphicsBrush()

### Types

This = wxGraphicsRenderer()
X1 = Y1 = X2 = 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

####
createRadialGradientBrush(This, StartX, StartY, EndX, EndY,
Radius, Stops) ->
wxGraphicsBrush:wxGraphicsBrush()

### Types

This = wxGraphicsRenderer()
StartX = StartY = EndX = EndY = 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

####
createFont(This, Font) -> wxGraphicsFont:wxGraphicsFont()

### Types

This = wxGraphicsRenderer()
Font = wxFont:wxFont()

####
createFont(This, SizeInPixels, Facename) ->
wxGraphicsFont:wxGraphicsFont()

####
createFont(This, Font, Facename :: [Option]) ->
wxGraphicsFont:wxGraphicsFont()

### Types

This = wxGraphicsRenderer()
Font = wxFont:wxFont()
Option = {col, wx:wx_colour()}

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

####
createFont(This, SizeInPixels, Facename, Options :: [Option]) ->
wxGraphicsFont:wxGraphicsFont()

### Types

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

####
createMatrix(This) -> wxGraphicsMatrix:wxGraphicsMatrix()

### Types

This = wxGraphicsRenderer()

####
createMatrix(This, Options :: [Option]) ->
wxGraphicsMatrix:wxGraphicsMatrix()

### Types

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) -> wxGraphicsPath:wxGraphicsPath()

### Types

This = wxGraphicsRenderer()

Creates a native graphics path which is initially empty.