A drawing context encapsulates the drawing context of the underlying OS. More...

Inheritance diagram for CDrawContext:

Classes
struct	Transform
	Add a transform to all draw routines. More...

Public Member Functions
virtual void	beginDraw ()

virtual void	endDraw ()

const CRect &	getSurfaceRect () const


virtual void	setBitmapInterpolationQuality (BitmapInterpolationQuality quality)
	set the current bitmap interpolation quality More...

const BitmapInterpolationQuality &	getBitmapInterpolationQuality () const
	get the current bitmap interpolation quality More...

Line Mode
virtual void	setLineStyle (const CLineStyle &style)
	set the current line style More...

const CLineStyle &	getLineStyle () const
	get the current line style More...

virtual void	setLineWidth (CCoord width)
	set the current line width More...

CCoord	getLineWidth () const
	get the current line width More...

Draw Mode
virtual void	setDrawMode (CDrawMode mode)
	set the current draw mode, see CDrawMode More...

CDrawMode	getDrawMode () const
	get the current draw mode, see CDrawMode More...

Clipping
virtual void	setClipRect (const CRect &clip)
	set the current clip More...

CRect &	getClipRect (CRect &clip) const
	get the current clip More...

virtual void	resetClipRect ()
	reset the clip to the default state More...

Color
virtual void	setFillColor (const CColor &color)
	set current fill color More...

CColor	getFillColor () const
	get current fill color More...

virtual void	setFrameColor (const CColor &color)
	set current stroke color More...

CColor	getFrameColor () const
	get current stroke color More...

Font
virtual void	setFontColor (const CColor &color)
	set current font color More...

CColor	getFontColor () const
	get current font color More...

virtual void	setFont (const CFontRef font, const CCoord &size=0, const int32_t &style=-1)
	set current font More...

const CFontRef	getFont () const
	get current font More...

Text
CCoord	getStringWidth (UTF8StringPtr pStr)
	get the width of an UTF-8 encoded string More...

void	drawString (UTF8StringPtr string, const CRect &_rect, const CHoriTxtAlign hAlign=kCenterText, bool antialias=true)
	draw an UTF-8 encoded string More...

void	drawString (UTF8StringPtr string, const CPoint &_point, bool antialias=true)
	draw an UTF-8 encoded string More...

CCoord	getStringWidth (IPlatformString *pStr)
	get the width of a platform string More...

void	drawString (IPlatformString *string, const CRect &_rect, const CHoriTxtAlign hAlign=kCenterText, bool antialias=true)
	draw a platform string More...

void	drawString (IPlatformString *string, const CPoint &_point, bool antialias=true)
	draw a platform string More...

Global Alpha State
virtual void	setGlobalAlpha (float newAlpha)
	sets the global alpha value[0..1] More...

float	getGlobalAlpha () const
	get current global alpha value More...

Global State Stack
virtual void	saveGlobalState ()

virtual void	restoreGlobalState ()

Transformation
const CGraphicsTransform &	getCurrentTransform () const

const CRect &	getAbsoluteClipRect () const

virtual double	getScaleFactor () const
	returns the backend scale factor. More...

CCoord	getHairlineSize () const
	returns the current line size which corresponds to one pixel on screen. More...

Public Member Functions inherited from ReferenceCounted< T >
	ReferenceCounted ()=default

virtual	~ReferenceCounted () noexcept=default

	ReferenceCounted (const ReferenceCounted &)

ReferenceCounted &	operator= (const ReferenceCounted &)

void	forget () override
	decrease refcount and delete object if refcount == 0 More...

void	remember () override
	increase refcount More...

virtual int32_t	getNbReference () const
	get refcount More...

virtual void	beforeDelete ()

Protected Member Functions
	CDrawContext ()=delete

	CDrawContext (const CRect &surfaceRect)

	~CDrawContext () noexcept override

virtual void	init ()

void	pushTransform (const CGraphicsTransform &transformation)

void	popTransform ()

const UTF8String &	getDrawString (UTF8StringPtr string)

void	clearDrawString ()

const CDrawContextState &	getCurrentState () const

CDrawContextState &	getCurrentState ()

Draw primitives
using	LinePair = std::pair< CPoint, CPoint >

using	LineList = std::vector< LinePair >

using	PointList = std::vector< CPoint >

void	drawLine (const CPoint &start, const CPoint &end)

virtual void	drawLine (const LinePair &line)=0
	draw a line More...

virtual void	drawLines (const LineList &lines)=0
	draw multiple lines at once More...

virtual void	drawPolygon (const PointList &polygonPointList, const CDrawStyle drawStyle=kDrawStroked)=0
	draw a polygon More...

virtual void	drawRect (const CRect &rect, const CDrawStyle drawStyle=kDrawStroked)=0
	draw a rect More...

virtual void	drawArc (const CRect &rect, const float startAngle1, const float endAngle2, const CDrawStyle drawStyle=kDrawStroked)=0
	draw an arc, angles are in degree More...

virtual void	drawEllipse (const CRect &rect, const CDrawStyle drawStyle=kDrawStroked)=0
	draw an ellipse More...

virtual void	drawPoint (const CPoint &point, const CColor &color)=0
	draw a point More...

virtual void	drawBitmap (CBitmap *bitmap, const CRect &dest, const CPoint &offset=CPoint(0, 0), float alpha=1.f)=0
	don't call directly, please use CBitmap::draw instead More...

virtual void	drawBitmapNinePartTiled (CBitmap *bitmap, const CRect &dest, const CNinePartTiledDescription &desc, float alpha=1.f)

virtual void	fillRectWithBitmap (CBitmap *bitmap, const CRect &srcRect, const CRect &dstRect, float alpha)

virtual void	clearRect (const CRect &rect)=0
	clears the rect (makes r = 0, g = 0, b = 0, a = 0) More...

Graphics Paths
enum	PathDrawMode { kPathFilled, kPathFilledEvenOdd, kPathStroked }

virtual CGraphicsPath *	createGraphicsPath ()=0
	create a graphics path object, you need to forget it after usage More...

virtual CGraphicsPath *	createTextPath (const CFontRef font, UTF8StringPtr text)=0
	create a graphics path from a text More...

CGraphicsPath *	createRoundRectGraphicsPath (const CRect &size, CCoord radius)
	create a rect with round corners as graphics path, you need to forget it after usage More...

virtual void	drawGraphicsPath (CGraphicsPath path, PathDrawMode mode=kPathFilled, CGraphicsTransform transformation=nullptr)=0

virtual void	fillLinearGradient (CGraphicsPath path, const CGradient &gradient, const CPoint &startPoint, const CPoint &endPoint, bool evenOdd=false, CGraphicsTransform transformation=nullptr)=0

virtual void	fillRadialGradient (CGraphicsPath path, const CGradient &gradient, const CPoint &center, CCoord radius, const CPoint &originOffset=CPoint(0, 0), bool evenOdd=false, CGraphicsTransform transformation=nullptr)=0

Detailed Description

A drawing context encapsulates the drawing context of the underlying OS.

Member Typedef Documentation

◆ LineList

using LineList = std::vector<LinePair>

◆ LinePair

using LinePair = std::pair<CPoint, CPoint>

◆ PointList

using PointList = std::vector<CPoint>

Member Enumeration Documentation

◆ PathDrawMode

enum PathDrawMode

Enumerator
kPathFilled
kPathFilledEvenOdd
kPathStroked

Constructor & Destructor Documentation

◆ CDrawContext() [1/2]

CDrawContext ( )

protecteddelete

◆ CDrawContext() [2/2]

CDrawContext ( const CRect & surfaceRect )

explicitprotected

◆ ~CDrawContext()

~CDrawContext ( )

overrideprotectednoexcept

Member Function Documentation

◆ beginDraw()

virtual void beginDraw ( )

inlinevirtual

◆ clearDrawString()

void clearDrawString ( )

protected

◆ clearRect()

virtual void clearRect ( const CRect & rect )

pure virtual

clears the rect (makes r = 0, g = 0, b = 0, a = 0)

◆ createGraphicsPath()

virtual CGraphicsPath* createGraphicsPath ( )

pure virtual

create a graphics path object, you need to forget it after usage

◆ createRoundRectGraphicsPath()

CGraphicsPath * createRoundRectGraphicsPath	(	const CRect &	size,
		CCoord	radius
	)

create a rect with round corners as graphics path, you need to forget it after usage

◆ createTextPath()

virtual CGraphicsPath* createTextPath	(	const CFontRef	font,
		UTF8StringPtr	text
	)

pure virtual

create a graphics path from a text

◆ drawArc()

virtual void drawArc	(	const CRect &	rect,
		const float	startAngle1,
		const float	endAngle2,
		const CDrawStyle	drawStyle = `kDrawStroked`
	)

pure virtual

draw an arc, angles are in degree

◆ drawBitmap()

virtual void drawBitmap	(	CBitmap *	bitmap,
		const CRect &	dest,
		const CPoint &	offset = `CPoint(0, 0)`,
		float	alpha = `1.f`
	)

pure virtual

don't call directly, please use CBitmap::draw instead

◆ drawBitmapNinePartTiled()

void drawBitmapNinePartTiled	(	CBitmap *	bitmap,
		const CRect &	dest,
		const CNinePartTiledDescription &	desc,
		float	alpha = `1.f`
	)

virtual

◆ drawEllipse()

virtual void drawEllipse	(	const CRect &	rect,
		const CDrawStyle	drawStyle = `kDrawStroked`
	)

pure virtual

draw an ellipse

◆ drawGraphicsPath()

virtual void drawGraphicsPath	(	CGraphicsPath *	path,
		PathDrawMode	mode = `kPathFilled`,
		CGraphicsTransform *	transformation = `nullptr`
	)

pure virtual

◆ drawLine() [1/2]

void drawLine	(	const CPoint &	start,
		const CPoint &	end
	)

inline

◆ drawLine() [2/2]

virtual void drawLine ( const LinePair & line )

pure virtual

draw a line

◆ drawLines()

virtual void drawLines ( const LineList & lines )

pure virtual

draw multiple lines at once

◆ drawPoint()

virtual void drawPoint	(	const CPoint &	point,
		const CColor &	color
	)

pure virtual

draw a point

◆ drawPolygon()

virtual void drawPolygon	(	const PointList &	polygonPointList,
		const CDrawStyle	drawStyle = `kDrawStroked`
	)

pure virtual

draw a polygon

◆ drawRect()

virtual void drawRect	(	const CRect &	rect,
		const CDrawStyle	drawStyle = `kDrawStroked`
	)

pure virtual

draw a rect

◆ drawString() [1/4]

void drawString	(	UTF8StringPtr	string,
		const CRect &	_rect,
		const CHoriTxtAlign	hAlign = `kCenterText`,
		bool	antialias = `true`
	)

draw an UTF-8 encoded string

◆ drawString() [2/4]

void drawString	(	UTF8StringPtr	string,
		const CPoint &	_point,
		bool	antialias = `true`
	)

draw an UTF-8 encoded string

◆ drawString() [3/4]

void drawString	(	IPlatformString *	string,
		const CRect &	_rect,
		const CHoriTxtAlign	hAlign = `kCenterText`,
		bool	antialias = `true`
	)

draw a platform string

◆ drawString() [4/4]

void drawString	(	IPlatformString *	string,
		const CPoint &	_point,
		bool	antialias = `true`
	)

draw a platform string

◆ endDraw()

virtual void endDraw ( )

inlinevirtual

◆ fillLinearGradient()

virtual void fillLinearGradient	(	CGraphicsPath *	path,
		const CGradient &	gradient,
		const CPoint &	startPoint,
		const CPoint &	endPoint,
		bool	evenOdd = `false`,
		CGraphicsTransform *	transformation = `nullptr`
	)

pure virtual

◆ fillRadialGradient()

virtual void fillRadialGradient	(	CGraphicsPath *	path,
		const CGradient &	gradient,
		const CPoint &	center,
		CCoord	radius,
		const CPoint &	originOffset = `CPoint(0, 0)`,
		bool	evenOdd = `false`,
		CGraphicsTransform *	transformation = `nullptr`
	)

pure virtual

◆ fillRectWithBitmap()

void fillRectWithBitmap	(	CBitmap *	bitmap,
		const CRect &	srcRect,
		const CRect &	dstRect,
		float	alpha
	)

virtual

◆ getAbsoluteClipRect()

const CRect& getAbsoluteClipRect ( ) const

inline

◆ getBitmapInterpolationQuality()

const BitmapInterpolationQuality& getBitmapInterpolationQuality ( ) const

inline

get the current bitmap interpolation quality

◆ getClipRect()

CRect & getClipRect ( CRect & clip ) const

get the current clip

◆ getCurrentState() [1/2]

const CDrawContextState& getCurrentState ( ) const

inlineprotected

◆ getCurrentState() [2/2]

CDrawContextState& getCurrentState ( )

inlineprotected

◆ getCurrentTransform()

const CGraphicsTransform & getCurrentTransform ( ) const

◆ getDrawMode()

CDrawMode getDrawMode ( ) const

inline

get the current draw mode, see CDrawMode

◆ getDrawString()

const UTF8String & getDrawString ( UTF8StringPtr string )

protected

◆ getFillColor()

CColor getFillColor ( ) const

inline

get current fill color

◆ getFont()

const CFontRef getFont ( ) const

inline

get current font

◆ getFontColor()

CColor getFontColor ( ) const

inline

get current font color

◆ getFrameColor()

CColor getFrameColor ( ) const

inline

get current stroke color

◆ getGlobalAlpha()

float getGlobalAlpha ( ) const

inline

get current global alpha value

◆ getHairlineSize()

CCoord getHairlineSize ( ) const

returns the current line size which corresponds to one pixel on screen.

do not cache this value, instead ask for it every time you need it.

◆ getLineStyle()

const CLineStyle& getLineStyle ( ) const

inline

get the current line style

◆ getLineWidth()

CCoord getLineWidth ( ) const

inline

get the current line width

◆ getScaleFactor()

virtual double getScaleFactor ( ) const

inlinevirtual

returns the backend scale factor.

◆ getStringWidth() [1/2]

CCoord getStringWidth ( UTF8StringPtr pStr )

get the width of an UTF-8 encoded string

◆ getStringWidth() [2/2]

CCoord getStringWidth ( IPlatformString * pStr )

get the width of a platform string

◆ getSurfaceRect()

const CRect& getSurfaceRect ( ) const

inline

◆ init()

void init ( )

protectedvirtual

◆ popTransform()

void popTransform ( )

protected

◆ pushTransform()

void pushTransform ( const CGraphicsTransform & transformation )

protected

◆ resetClipRect()

void resetClipRect ( )

virtual

reset the clip to the default state

◆ restoreGlobalState()

void restoreGlobalState ( )

virtual

◆ saveGlobalState()

void saveGlobalState ( )

virtual

◆ setBitmapInterpolationQuality()

void setBitmapInterpolationQuality ( BitmapInterpolationQuality quality )

virtual

set the current bitmap interpolation quality

◆ setClipRect()

void setClipRect ( const CRect & clip )

virtual

set the current clip

◆ setDrawMode()

void setDrawMode ( CDrawMode mode )

virtual

set the current draw mode, see CDrawMode

◆ setFillColor()

void setFillColor ( const CColor & color )

virtual

set current fill color

◆ setFont()

void setFont	(	const CFontRef	font,
		const CCoord &	size = `0`,
		const int32_t &	style = `-1`
	)

virtual

set current font

◆ setFontColor()

void setFontColor ( const CColor & color )

virtual

set current font color

◆ setFrameColor()

void setFrameColor ( const CColor & color )

virtual

set current stroke color

◆ setGlobalAlpha()

void setGlobalAlpha ( float newAlpha )

virtual

sets the global alpha value[0..1]

◆ setLineStyle()

void setLineStyle ( const CLineStyle & style )

virtual

set the current line style

◆ setLineWidth()

void setLineWidth ( CCoord width )

virtual

set the current line width

The documentation for this class was generated from the following files:

cdrawcontext.h
cdrawcontext.cpp

Classes

Public Member Functions

Protected Member Functions

Draw primitives

Graphics Paths

Detailed Description

Member Typedef Documentation

◆ LineList

◆ LinePair

◆ PointList

Member Enumeration Documentation

◆ PathDrawMode

Constructor & Destructor Documentation

◆ CDrawContext() [1/2]

◆ CDrawContext() [2/2]

◆ ~CDrawContext()

Member Function Documentation

◆ beginDraw()

◆ clearDrawString()

◆ clearRect()

◆ createGraphicsPath()

◆ createRoundRectGraphicsPath()

◆ createTextPath()

◆ drawArc()

◆ drawBitmap()

◆ drawBitmapNinePartTiled()

◆ drawEllipse()

◆ drawGraphicsPath()

◆ drawLine() [1/2]

◆ drawLine() [2/2]

◆ drawLines()

◆ drawPoint()

◆ drawPolygon()

◆ drawRect()

◆ drawString() [1/4]

◆ drawString() [2/4]

◆ drawString() [3/4]

◆ drawString() [4/4]

◆ endDraw()

◆ fillLinearGradient()

◆ fillRadialGradient()

◆ fillRectWithBitmap()

◆ getAbsoluteClipRect()

◆ getBitmapInterpolationQuality()

◆ getClipRect()

◆ getCurrentState() [1/2]

◆ getCurrentState() [2/2]

◆ getCurrentTransform()

◆ getDrawMode()

◆ getDrawString()

◆ getFillColor()

◆ getFont()

◆ getFontColor()

◆ getFrameColor()

◆ getGlobalAlpha()

◆ getHairlineSize()

◆ getLineStyle()

◆ getLineWidth()

◆ getScaleFactor()

◆ getStringWidth() [1/2]

◆ getStringWidth() [2/2]

◆ getSurfaceRect()

◆ init()

◆ popTransform()

◆ pushTransform()

◆ resetClipRect()

◆ restoreGlobalState()

◆ saveGlobalState()

◆ setBitmapInterpolationQuality()

◆ setClipRect()

◆ setDrawMode()

◆ setFillColor()

◆ setFont()

◆ setFontColor()

◆ setFrameColor()

◆ setGlobalAlpha()

◆ setLineStyle()

◆ setLineWidth()