VSTGUI  4.10
Graphical User Interface Framework not only for VST plugins
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CDrawContext Class Referenceabstract

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 CRectgetSurfaceRect () const
 
virtual void setBitmapInterpolationQuality (BitmapInterpolationQuality quality)
 set the current bitmap interpolation quality
 
const BitmapInterpolationQualitygetBitmapInterpolationQuality () const
 get the current bitmap interpolation quality
 
Line Mode
virtual void setLineStyle (const CLineStyle &style)
 set the current line style
 
const CLineStylegetLineStyle () const
 get the current line style
 
virtual void setLineWidth (CCoord width)
 set the current line width
 
CCoord getLineWidth () const
 get the current line width
 
Draw Mode
virtual void setDrawMode (CDrawMode mode)
 set the current draw mode, see CDrawMode
 
CDrawMode getDrawMode () const
 get the current draw mode, see CDrawMode
 
Clipping
virtual void setClipRect (const CRect &clip)
 set the current clip
 
CRectgetClipRect (CRect &clip) const
 get the current clip
 
virtual void resetClipRect ()
 reset the clip to the default state
 
Color
virtual void setFillColor (const CColor &color)
 set current fill color
 
CColor getFillColor () const
 get current fill color
 
virtual void setFrameColor (const CColor &color)
 set current stroke color
 
CColor getFrameColor () const
 get current stroke color
 
Font
virtual void setFontColor (const CColor &color)
 set current font color
 
CColor getFontColor () const
 get current font color
 
virtual void setFont (const CFontRef font, const CCoord &size=0, const int32_t &style=-1)
 set current font
 
const CFontRef getFont () const
 get current font
 
Text
CCoord getStringWidth (UTF8StringPtr pStr)
 get the width of an UTF-8 encoded string
 
void drawString (UTF8StringPtr string, const CRect &_rect, const CHoriTxtAlign hAlign=kCenterText, bool antialias=true)
 draw an UTF-8 encoded string
 
void drawString (UTF8StringPtr string, const CPoint &_point, bool antialias=true)
 draw an UTF-8 encoded string
 
CCoord getStringWidth (IPlatformString *pStr)
 get the width of a platform string
 
void drawString (IPlatformString *string, const CRect &_rect, const CHoriTxtAlign hAlign=kCenterText, bool antialias=true)
 draw a platform string
 
void drawString (IPlatformString *string, const CPoint &_point, bool antialias=true)
 draw a platform string
 
Global Alpha State
virtual void setGlobalAlpha (float newAlpha)
 sets the global alpha value[0..1]
 
float getGlobalAlpha () const
 get current global alpha value
 
Global State Stack
virtual void saveGlobalState ()
 
virtual void restoreGlobalState ()
 
Transformation
const CGraphicsTransformgetCurrentTransform () const
 
const CRectgetAbsoluteClipRect () const
 
virtual double getScaleFactor () const
 returns the backend scale factor.
 
CCoord getHairlineSize () const
 returns the current line size which corresponds to one pixel on screen.
 
- Public Member Functions inherited from ReferenceCounted< T >
 ReferenceCounted ()=default
 
virtual ~ReferenceCounted () noexcept=default
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
void forget () override
 decrease refcount and delete object if refcount == 0
 
void remember () override
 increase refcount
 
virtual int32_t getNbReference () const
 get refcount
 

Protected Member Functions

 CDrawContext ()=delete
 
 CDrawContext (const CRect &surfaceRect)
 
 ~CDrawContext () noexceptoverride
 
virtual void init ()
 
void pushTransform (const CGraphicsTransform &transformation)
 
void popTransform ()
 
const UTF8StringgetDrawString (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
 
virtual void drawLines (const LineList &lines)=0
 draw multiple lines at once
 
virtual void drawPolygon (const PointList &polygonPointList, const CDrawStyle drawStyle=kDrawStroked)=0
 draw a polygon
 
virtual void drawRect (const CRect &rect, const CDrawStyle drawStyle=kDrawStroked)=0
 draw a rect
 
virtual void drawArc (const CRect &rect, const float startAngle1, const float endAngle2, const CDrawStyle drawStyle=kDrawStroked)=0
 draw an arc, angles are in degree
 
virtual void drawEllipse (const CRect &rect, const CDrawStyle drawStyle=kDrawStroked)=0
 draw an ellipse
 
virtual void drawPoint (const CPoint &point, const CColor &color)=0
 draw a point
 
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
 
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)
 

Graphics Paths

enum  PathDrawMode { kPathFilled, kPathFilledEvenOdd, kPathStroked }
 
virtual CGraphicsPathcreateGraphicsPath ()=0
 create a graphics path object, you need to forget it after usage
 
virtual CGraphicsPathcreateTextPath (const CFontRef font, UTF8StringPtr text)=0
 create a graphics path from a text
 
CGraphicsPathcreateRoundRectGraphicsPath (const CRect &size, CCoord radius)
 create a rect with round corners as graphics path, you need to forget it after usage
 
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

using LineList = std::vector<LinePair>
using LinePair = std::pair<CPoint, CPoint>
using PointList = std::vector<CPoint>

Member Enumeration Documentation

Enumerator
kPathFilled 
kPathFilledEvenOdd 
kPathStroked 

Constructor & Destructor Documentation

CDrawContext ( )
protecteddelete
CDrawContext ( const CRect surfaceRect)
explicitprotected
~CDrawContext ( )
overrideprotectednoexcept

Member Function Documentation

virtual void beginDraw ( )
inlinevirtual
void clearDrawString ( )
protected
virtual void clearRect ( const CRect rect)
pure virtual

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

virtual CGraphicsPath* createGraphicsPath ( )
pure virtual

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

CGraphicsPath * createRoundRectGraphicsPath ( const CRect size,
CCoord  radius 
)

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

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

create a graphics path from a text

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

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

void drawBitmapNinePartTiled ( CBitmap bitmap,
const CRect dest,
const CNinePartTiledDescription desc,
float  alpha = 1.f 
)
virtual
virtual void drawEllipse ( const CRect rect,
const CDrawStyle  drawStyle = kDrawStroked 
)
pure virtual

draw an ellipse

virtual void drawGraphicsPath ( CGraphicsPath path,
PathDrawMode  mode = kPathFilled,
CGraphicsTransform transformation = nullptr 
)
pure virtual
void drawLine ( const CPoint start,
const CPoint end 
)
inline
virtual void drawLine ( const LinePair line)
pure virtual

draw a line

virtual void drawLines ( const LineList lines)
pure virtual

draw multiple lines at once

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

draw a point

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

draw a polygon

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

draw a rect

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

draw an UTF-8 encoded string

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

draw an UTF-8 encoded string

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

draw a platform string

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

draw a platform string

virtual void endDraw ( )
inlinevirtual
virtual void fillLinearGradient ( CGraphicsPath path,
const CGradient gradient,
const CPoint startPoint,
const CPoint endPoint,
bool  evenOdd = false,
CGraphicsTransform transformation = nullptr 
)
pure virtual
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
void fillRectWithBitmap ( CBitmap bitmap,
const CRect srcRect,
const CRect dstRect,
float  alpha 
)
virtual
const CRect& getAbsoluteClipRect ( ) const
inline
const BitmapInterpolationQuality& getBitmapInterpolationQuality ( ) const
inline

get the current bitmap interpolation quality

CRect & getClipRect ( CRect clip) const

get the current clip

const CDrawContextState& getCurrentState ( ) const
inlineprotected
CDrawContextState& getCurrentState ( )
inlineprotected
const CGraphicsTransform & getCurrentTransform ( ) const
CDrawMode getDrawMode ( ) const
inline

get the current draw mode, see CDrawMode

const UTF8String & getDrawString ( UTF8StringPtr  string)
protected
CColor getFillColor ( ) const
inline

get current fill color

const CFontRef getFont ( ) const
inline

get current font

CColor getFontColor ( ) const
inline

get current font color

CColor getFrameColor ( ) const
inline

get current stroke color

float getGlobalAlpha ( ) const
inline

get current global alpha value

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.

const CLineStyle& getLineStyle ( ) const
inline

get the current line style

CCoord getLineWidth ( ) const
inline

get the current line width

virtual double getScaleFactor ( ) const
inlinevirtual

returns the backend scale factor.

CCoord getStringWidth ( UTF8StringPtr  pStr)

get the width of an UTF-8 encoded string

CCoord getStringWidth ( IPlatformString *  pStr)

get the width of a platform string

const CRect& getSurfaceRect ( ) const
inline
void init ( )
protectedvirtual
void popTransform ( )
protected
void pushTransform ( const CGraphicsTransform transformation)
protected
void resetClipRect ( )
virtual

reset the clip to the default state

void restoreGlobalState ( )
virtual
void saveGlobalState ( )
virtual
void setBitmapInterpolationQuality ( BitmapInterpolationQuality  quality)
virtual

set the current bitmap interpolation quality

void setClipRect ( const CRect clip)
virtual

set the current clip

void setDrawMode ( CDrawMode  mode)
virtual

set the current draw mode, see CDrawMode

void setFillColor ( const CColor color)
virtual

set current fill color

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

set current font

void setFontColor ( const CColor color)
virtual

set current font color

void setFrameColor ( const CColor color)
virtual

set current stroke color

void setGlobalAlpha ( float  newAlpha)
virtual

sets the global alpha value[0..1]

void setLineStyle ( const CLineStyle style)
virtual

set the current line style

void setLineWidth ( CCoord  width)
virtual

set the current line width


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