VSTGUI  4.4
Graphical User Interface Framework not only for VST plugins
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
New stuff in VSTGUI 4

Introduction

Version 4 of VSTGUI is a new milestone release with a restructured code base with the focus of code conformity and easier future enhancements. The result is that code written for any earlier version of VSTGUI is not always compatible. It's recommended to start new projects with version 4 while old projects should stay with version 3.6.

New Stuff

Version 4.4

  • preview Linux version
  • support for Windows XP, Mac OS X 10.6 and non c++11 mode will be removed with version 4.5

Version 4.3

  • last version to support Windows XP, Mac OS X 10.6 and non c++11 mode
  • HiDPI support (aka Retina support) for Quartz2D and Direct2D backends
  • support for creating a graphics path from a string
  • new Control : VSTGUI::CSegmentButton
  • add support for adding a custom view to the split view separator
  • transformation matrix support in VSTGUI::CDrawContext
  • alternative c++11 callback functions for VSTGUI::CFileSelector::run(), VSTGUI::CVSTGUITimer, VSTGUI::CParamDisplay::setValueToStringFunction, VSTGUI::CTextEdit::setStringToValueFunction and VSTGUI::CCommandMenuItem::setActions

Note: All current deprecated methods will be removed in the next version. So make sure that your code compiles with VSTGUI_ENABLE_DEPRECATED_METHODS=0

Version 4.2

  • iOS Support with Multi Touch handling. See iOS support notes
  • support drawing an icon on a VSTGUI::CTextButton
  • VSTGUI::CGradientView
  • VSTGUI::CDataBrowser now supports multi row selections
  • support compiling in c++11 mode with clang and visual studio
  • VSTGUI_OVERRIDE_VMETHOD is now used throughout the vstgui sources to indicate methods which are expecting to override a virtual method of its base classes. (c++11 only)

Version 4.1

Version 4.0

Changes for existing VSTGUI code

VSTGUI 4.3 -> VSTGUI 4.4

  • removed method: CRect& CView::getViewSize (CRect& rect) const -> use const CRect& getViewSize () const

VSTGUI 4.2 -> VSTGUI 4.3

VSTGUI 4.1 -> VSTGUI 4.2

  • the class CDragContainer is replaced by IDataPackage. The class CDragContainerHelper is a helper class you can use to quickly get your code up and running again.
  • the class IDataBrowser is renamed to IDataBrowserDelegate and the drag and drop methods have changed
  • CView::getVisibleSize () was renamed to CView::getVisibleViewSize ()

VSTGUI 4.0 -> VSTGUI 4.1

  • the pBackground member of CView is now private. You must replace all read access with getDrawBackground () or getBackground () and all write access with setBackground ()

VSTGUI 3.6 -> VSTGUI 4.0

  • the variable types were changed to use C99 style types (int32_t, etc), you must do this for all your derivated VSTGUI classes too
  • the buttons parameter has changed from long to CButtonState
  • your custom views need to use the new mouse methods
  • COptionMenuScheme is not available anymore
  • VSTGUI::CFileSelector is gone, you have to use VSTGUI::CNewFileSelector
  • VST extensions previously enabled via ENABLE_VST_EXTENSION_IN_VSTGUI is gone without replacement
  • VSTGUI::CBitmap was completely changed and does not use a transparency color anymore, you need to use the alpha channel of a bitmap to get the same results
  • VSTGUI::COffscreenContext is handled completely different. But in most cases you can simply remove all offscreens where you needed them to reduce flicker.
  • On Windows graphics are entirely drawn with GDI+ or Direct2D (when available), GDI is not used anymore
  • The internal string encoding is now always UTF-8
  • The VSTGUI::CCoord type is now always a double
  • on Mac OS X, embedding a CFrame into a non composited carbon window is not supported anymore
  • on Mac OS X, when targeting Mac OS X 10.4 some of the graphics path methods are not implemented.
  • Method signature changes which don't lead to compile errors:
    • CView::setViewSize (CRect& rect, bool invalid = true)
    • CView::hitTest (const CPoint& where, CButtonState& buttons = -1)
    • CView::invalidRect (CRect& rect)
    • CViewContainer::drawBackgroundRect (CDrawContext* pContext, CRect& _updateRect)
    • CViewContainer::addView (CView* pView, CRect& mouseableArea, bool mouseEnabled = true)

HiDPI notes

  • HiDPI is supported on OSX, iOS and Windows (with Direct2D backend)
  • Due to platform differences one need to call frame->setZoom (scaleFactor) on Windows, while on OSX and iOS this is not needed.

Cocoa notes

  • To get cocoa support your minimum required Mac OS X version is 10.6.
  • In 32 bit Cocoa and Carbon are available. You can switch between them with CFrame::setCocoaMode(bool state). You must do this before creating the CFrame.
  • In 64 bit only Cocoa is available.
  • The pSystemWindow pointer in the CFrame constructor must be a NSView not a NSWindow.

iOS support notes

  • VSTGUI supports iOS 7 and later
  • Currently COptionMenu, CScrollView and COpenGLView are not supported
  • Support for a single MultiTouch View is not yet tested and the API may change in the future