85 lines
2.0 KiB
C
85 lines
2.0 KiB
C
// This file is part of VSTGUI. It is subject to the license terms
|
|
// in the LICENSE file found in the top-level directory of this
|
|
// distribution and at http://github.com/steinbergmedia/vstgui/LICENSE
|
|
|
|
/**
|
|
|
|
@mainpage
|
|
|
|
Welcome to VSTGUI
|
|
|
|
- @ref intro @n
|
|
- @ref page_news_and_changes @n
|
|
- @ref page_uidescription_editor @n
|
|
- @ref page_license @n
|
|
|
|
@section intro Introduction
|
|
|
|
\par VSTGUI
|
|
VSTGUI is a User Interface Toolkit mainly for Audio Plug-Ins (VST, AudioUnit, etc).
|
|
\par History
|
|
First developed inhouse of Steinberg Media Technologies (around 1998) for their first VST Plug-Ins.
|
|
Later added as binary libraries to the official VST SDK.
|
|
Since May 2003 VSTGUI is open source, was hosted at sourceforge and now at [GitHub](https://github.com/steinbergmedia/vstgui).
|
|
|
|
Currently VSTGUI compiles on
|
|
\par Microsoft Windows (with Visual Studio 2015/2017/2019 and Windows 7 Platform SDK)
|
|
- 7 (32 and 64 bit)
|
|
- 8 (32 and 64 bit)
|
|
- 10 (32 and 64 bit)
|
|
\par Apple macOS (with Xcode 7.3 or newer)
|
|
- 10.9 - 10.15 (32 and 64 bit)
|
|
\par Apple iOS
|
|
- 8.0 - 13.0 (32 and 64 bit)
|
|
\par Linux (with gcc >= 5.4 or clang >= 3.8)
|
|
- Ubuntu 2016.04 or newer
|
|
|
|
\sa [VSTGUI @ GitHub](https://github.com/steinbergmedia/vstgui)
|
|
|
|
@page page_setup Setup
|
|
|
|
\par To include VSTGUI in your projects you only have to add
|
|
|
|
- vstgui_win32.cpp (for Windows)
|
|
- vstgui_linux.cpp (for Linux)
|
|
- vstgui_mac.mm (for macOS)
|
|
- vstgui_ios.mm (for iOS)
|
|
|
|
to your IDE project and add a search path to the parent of the root folder of vstgui.
|
|
|
|
\par On macOS, you need to link to the following Frameworks:
|
|
|
|
- Accelerate
|
|
- Cocoa
|
|
- QuartzCore
|
|
- OpenGL (Optional)
|
|
|
|
\par On iOS, you need to link to the following Frameworks:
|
|
|
|
- UIKit
|
|
- CoreGraphics
|
|
- ImageIO
|
|
- CoreText
|
|
- GLKit
|
|
- Accelerate
|
|
- QuartzCore
|
|
|
|
\par On Linux you have to install xcb, freetype, fontconfig and cairo
|
|
|
|
Debian/Ubuntu based distribution:
|
|
|
|
- libx11-dev
|
|
- libx11-xcb-dev
|
|
- libxcb-util-dev
|
|
- libxcb-cursor-dev
|
|
- libxcb-keysyms1-dev
|
|
- libxcb-xkb-dev
|
|
- libxkbcommon-dev
|
|
- libxkbcommon-x11-dev
|
|
- libfontconfig1-dev
|
|
- libcairo2-dev
|
|
- libfreetype6-dev
|
|
- libpango1.0-dev
|
|
|
|
*/
|