crunchy-rocks/draw2d
2
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Fix typos and add more comments/documentation

Browse source 
Commit fixes couple typos and adds more documentation to
GraphicContext interface in `gc.go`.

Fixes #101
This commit is contained in:
Zdenek Styblik 2016-04-27 15:25:21 +02:00
parent 0545b30698
commit 3bb234e85b
1 changed files with 23 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
gc.go
View file

@ -10,6 +10,7 @@ import (
// GraphicContext describes the interface for the various backends (images, pdf, opengl, ...) // GraphicContext describes the interface for the various backends (images, pdf, opengl, ...)
type GraphicContext interface { type GraphicContext interface {
// PathBuilder describes the interface for path drawing
PathBuilder PathBuilder
// BeginPath creates a new path // BeginPath creates a new path
BeginPath() BeginPath()
@ -27,7 +28,7 @@ type GraphicContext interface {
Scale(sx, sy float64) Scale(sx, sy float64)
// SetStrokeColor sets the current stroke color // SetStrokeColor sets the current stroke color
SetStrokeColor(c color.Color) SetStrokeColor(c color.Color)
// SetStrokeColor sets the current fill color // SetFillColor sets the current fill color
SetFillColor(c color.Color) SetFillColor(c color.Color)
// SetFillRule sets the current fill rule // SetFillRule sets the current fill rule
SetFillRule(f FillRule) SetFillRule(f FillRule)
@ -37,27 +38,46 @@ type GraphicContext interface {
SetLineCap(cap LineCap) SetLineCap(cap LineCap)
// SetLineJoin sets the current line join // SetLineJoin sets the current line join
SetLineJoin(join LineJoin) SetLineJoin(join LineJoin)
// SetLineJoin sets the current dash // SetLineDash sets the current dash
SetLineDash(dash []float64, dashOffset float64) SetLineDash(dash []float64, dashOffset float64)
// SetFontSize // SetFontSize sets the current font size
SetFontSize(fontSize float64) SetFontSize(fontSize float64)
// GetFontSize gets the current font size
GetFontSize() float64 GetFontSize() float64
// SetFontData sets the current FontData
SetFontData(fontData FontData) SetFontData(fontData FontData)
// GetFontData gets the current FontData
GetFontData() FontData GetFontData() FontData
// DrawImage draws the raster image in the current canvas
DrawImage(image image.Image) DrawImage(image image.Image)
// Save the context and push it to the context stack
Save() Save()
// Restore remove the current context and restore the last one
Restore() Restore()
// Clear fills the current canvas with a default transparent color
Clear() Clear()
// ClearRect fills the specified rectangle with a default transparent color
ClearRect(x1, y1, x2, y2 int) ClearRect(x1, y1, x2, y2 int)
// SetDPI sets the current DPI
SetDPI(dpi int) SetDPI(dpi int)
// GetDPI gets the current DPI
GetDPI() int GetDPI() int
// GetStringBounds gets pixel bounds(dimensions) of given string
GetStringBounds(s string) (left, top, right, bottom float64) GetStringBounds(s string) (left, top, right, bottom float64)
// CreateStringPath creates a path from the string s at x, y
CreateStringPath(text string, x, y float64) (cursor float64) CreateStringPath(text string, x, y float64) (cursor float64)
// FillString draws the text at point (0, 0)
FillString(text string) (cursor float64) FillString(text string) (cursor float64)
// FillStringAt draws the text at the specified point (x, y)
FillStringAt(text string, x, y float64) (cursor float64) FillStringAt(text string, x, y float64) (cursor float64)
// StrokeString draws the contour of the text at point (0, 0)
StrokeString(text string) (cursor float64) StrokeString(text string) (cursor float64)
// StrokeStringAt draws the contour of the text at point (x, y)
StrokeStringAt(text string, x, y float64) (cursor float64) StrokeStringAt(text string, x, y float64) (cursor float64)
// Stroke strokes the paths with the color specified by SetStrokeColor
Stroke(paths ...*Path) Stroke(paths ...*Path)
// Fill fills the paths with the color specified by SetFillColor
Fill(paths ...*Path) Fill(paths ...*Path)
// FillStroke first fills the paths and than strokes them
FillStroke(paths ...*Path) FillStroke(paths ...*Path)
} }