Interface Technology Basics
VST 3.6.12
SDK for developing VST Plug-in
|
Namespaces | |
FUnknownPrivate | |
GeoConstants | |
KeyCodes | |
Utility functions to handle key-codes. | |
Linux | |
Classes | |
class | ConstStringTable |
Constant unicode string table. More... | |
struct | FReleaser |
Release an interface using automatic object (obsolete). More... | |
class | FUID |
Handling 16 Byte Globally Unique Identifiers. More... | |
class | FUnknown |
The basic interface of all interfaces. More... | |
class | FUnknownPtr |
FUnknownPtr - automatic interface conversion and smart pointer in one. More... | |
class | FVariant |
A Value of variable type. More... | |
class | IAttributes |
Object Data Archive Interface. More... | |
class | IAttributes2 |
Extended access to Attributes; supports Attribute retrieval via iteration. More... | |
class | IBStream |
Base class for streams. More... | |
class | ICloneable |
Interface allowing an object to be copied. More... | |
class | IDependent |
A dependent will get notified about changes of a model. More... | |
class | IErrorContext |
Interface for error handling. More... | |
class | IPersistent |
Persistent Object Interface. More... | |
class | IPlugFrame |
Callback interface passed to IPlugView. More... | |
class | IPluginBase |
Basic interface to a Plug-in component. More... | |
class | IPluginFactory |
Class factory that any Plug-in defines for creating class instances. More... | |
class | IPluginFactory2 |
Version 2 of class factory supporting PClassInfo2. More... | |
class | IPluginFactory3 |
Version 3 of class factory supporting PClassInfoW. More... | |
class | IPlugView |
Plug-in definition of a view. More... | |
class | IPlugViewContentScaleSupport |
Plug-in view content scale support. More... | |
class | IPtr |
IPtr - Smart pointer template class. More... | |
class | ISizeableStream |
Stream with a size. More... | |
class | IString |
Interface to a string of variable size and encoding. More... | |
class | IStringResult |
Interface to return an ascii string of variable size. More... | |
class | IUpdateHandler |
Host implements dependency handling for plugins. More... | |
struct | KeyCode |
Simple data-struct representing a key-stroke on the keyboard. More... | |
class | OPtr |
OPtr - "owning" smart pointer used for newly created FObjects. More... | |
struct | PClassInfo |
Basic Information about a class provided by the Plug-in. More... | |
struct | PClassInfo2 |
Version 2 of Basic Information about a class provided by the Plug-in. More... | |
struct | PClassInfoW |
Unicode Version of Basic Information about a class provided by the Plug-in. More... | |
struct | PFactoryInfo |
Basic Information about the class factory of the Plug-in. More... | |
class | UString |
UTF-16 string class without buffer management. More... | |
class | UStringBuffer |
UTF-16 string with fixed buffer size. More... | |
struct | ViewRect |
Graphical rectangle structure. More... | |
Typedefs | |
typedef char | int8 |
typedef unsigned char | uint8 |
typedef unsigned char | uchar |
typedef short | int16 |
typedef unsigned short | uint16 |
typedef int | int32 |
typedef unsigned int | uint32 |
typedef long long | int64 |
typedef unsigned long long | uint64 |
typedef int64 | TSize |
typedef int32 | tresult |
typedef uint64 | TPtrInt |
typedef uint8 | TBool |
typedef char | char8 |
typedef int16 | char16 |
typedef char16 | char |
typedef const char8 * | CStringA |
typedef const char16 * | CStringW |
typedef const char * | CString |
typedef const char8 * | FIDString |
typedef int32 | UCoord |
Coordinates. More... | |
typedef int64 | LARGE_INT |
typedef int8 | TUID [16] |
plain UID type More... | |
typedef FIDString | IAttrID |
typedef uint32 | ColorSpec |
typedef uint8 | ColorComponent |
typedef ColorSpec | UColorSpec |
typedef ColorComponent | UColorComponent |
typedef UStringBuffer< 128 > | UString128 |
128 character UTF-16 string More... | |
typedef UStringBuffer< 256 > | UString256 |
256 character UTF-16 string More... | |
Functions | |
template<class T > | |
int32 | _tstrlen (const T *wcs) |
int32 | tstrlen (const char *str) |
int32 | strlen8 (const char8 *str) |
int32 | strlen16 (const char16 *str) |
template<class T > | |
int32 | _tstrcmp (const T *src, const T *dst) |
int32 | tstrcmp (const char *src, const char *dst) |
int32 | strcmp8 (const char8 *src, const char8 *dst) |
int32 | strcmp16 (const char16 *src, const char16 *dst) |
template<typename T > | |
int32 | strcmpT (const T *first, const T *last) |
template<> | |
int32 | strcmpT< char8 > (const char8 *first, const char8 *last) |
template<> | |
int32 | strcmpT< char16 > (const char16 *first, const char16 *last) |
template<class T > | |
int32 | _tstrncmp (const T *first, const T *last, uint32 count) |
int32 | tstrncmp (const char *first, const char *last, uint32 count) |
int32 | strncmp8 (const char8 *first, const char8 *last, uint32 count) |
int32 | strncmp16 (const char16 *first, const char16 *last, uint32 count) |
template<typename T > | |
int32 | strncmpT (const T *first, const T *last, uint32 count) |
template<> | |
int32 | strncmpT< char8 > (const char8 *first, const char8 *last, uint32 count) |
template<> | |
int32 | strncmpT< char16 > (const char16 *first, const char16 *last, uint32 count) |
template<class T > | |
T * | _tstrcpy (T *dst, const T *src) |
char * | tstrcpy (char *dst, const char *src) |
char8 * | strcpy8 (char8 *dst, const char8 *src) |
char16 * | strcpy16 (char16 *dst, const char16 *src) |
template<class T > | |
T * | _tstrncpy (T *dest, const T *source, uint32 count) |
char * | tstrncpy (char *dest, const char *source, uint32 count) |
char8 * | strncpy8 (char8 *dest, const char8 *source, uint32 count) |
char16 * | strncpy16 (char16 *dest, const char16 *source, uint32 count) |
template<class T > | |
T * | _tstrcat (T *dst, const T *src) |
char * | tstrcat (char *dst, const char *src) |
char8 * | strcat8 (char8 *dst, const char8 *src) |
char16 * | strcat16 (char16 *dst, const char16 *src) |
void | str8ToStr16 (char16 *dst, const char8 *src, int32 n=-1) |
bool | FIDStringsEqual (FIDString id1, FIDString id2) |
bool | strEmpty (const char *str) |
bool | str8Empty (const char8 *str) |
bool | str16Empty (const char16 *str) |
template<class T > | |
const T & | Min (const T &a, const T &b) |
template<class T > | |
const T & | Max (const T &a, const T &b) |
template<class T > | |
T | Abs (const T &value) |
template<class T > | |
T | Sign (const T &value) |
template<class T > | |
T | Bound (T minval, T maxval, T x) |
template<class T > | |
void | Swap (T &t1, T &t2) |
template<class T > | |
bool | IsApproximateEqual (T t1, T t2, T epsilon) |
template<class T > | |
T | ToNormalized (const T &value, const int32 numSteps) |
template<class T > | |
int32 | FromNormalized (const T &norm, const int32 numSteps) |
bool | operator== (const FVariant &v1, const FVariant &v2) |
bool | operator!= (const FVariant &v1, const FVariant &v2) |
char | VirtualKeyCodeToChar (uint8 vKey) |
uint8 | CharToVirtualKeyCode (char character) |
template<class I > | |
IPtr< I > | owned (I *p) |
Assigning newly created object to an IPtr. More... | |
template<class I > | |
IPtr< I > | shared (I *p) |
Assigning shared object to an IPtr. More... | |
ColorSpec | MakeColorSpec (ColorComponent r, ColorComponent g, ColorComponent b) |
Create color specifier with RGB values (alpha is opaque) More... | |
ColorSpec | MakeColorSpec (ColorComponent r, ColorComponent g, ColorComponent b, ColorComponent a) |
Create color specifier with RGBA values. More... | |
ColorComponent | GetBlue (ColorSpec cs) |
ColorComponent | GetGreen (ColorSpec cs) |
ColorComponent | GetRed (ColorSpec cs) |
ColorComponent | GetAlpha (ColorSpec cs) |
void | SetBlue (ColorSpec &argb, ColorComponent b) |
void | SetGreen (ColorSpec &argb, ColorComponent g) |
void | SetRed (ColorSpec &argb, ColorComponent r) |
void | SetAlpha (ColorSpec &argb, ColorComponent a) |
double | NormalizeColorComponent (ColorComponent c) |
Normalized color components. More... | |
ColorComponent | DenormalizeColorComponent (double c) |
void | SetAlphaNorm (ColorSpec &argb, double a) |
double | GetAlphaNorm (ColorSpec cs) |
double | NormalizeAlpha (uint8 alpha) |
ColorComponent | DenormalizeAlpha (double alphaNorm) |
ColorSpec | StripAlpha (ColorSpec argb) |
} More... | |
template<class TDstChar , class TSrcChar > | |
void | StringCopy (TDstChar *dst, int32 dstSize, const TSrcChar *src, int32 srcSize=-1) |
Copy strings of different character width. More... | |
template<class TSrcChar > | |
int32 | StringLength (const TSrcChar *src, int32 srcSize=-1) |
Find length of null-terminated string. More... | |
Variables | |
const FIDString | kPlatformStringWin = "WIN" |
const FIDString | kPlatformStringMac = "MAC" |
const FIDString | kPlatformStringIOS = "IOS" |
const FIDString | kPlatformStringLinux = "Linux" |
const FIDString | kPlatformString = kPlatformStringLinux |
const FIDString | kPlatformTypeHIView = "HIView" |
The parent parameter in IPlugView::attached() is a WindowRef. More... | |
const FIDString | kPlatformTypeNSView = "NSView" |
The parent parameter in IPlugView::attached() is a NSView pointer. More... | |
const FIDString | kPlatformTypeUIView = "UIView" |
The parent parameter in IPlugView::attached() is a UIView pointer. More... | |
const FIDString | kPlatformTypeX11EmbedWindowID = "X11EmbedWindowID" |
The parent parameter in IPlugView::attached() is a X11 Window supporting XEmbed. More... | |
typedef short int16 |
typedef unsigned short uint16 |
typedef int int32 |
typedef unsigned int uint32 |
typedef long long int64 |
typedef unsigned long long uint64 |
typedef int8 TUID[16] |
plain UID type
typedef uint8 ColorComponent |
typedef ColorSpec UColorSpec |
typedef ColorComponent UColorComponent |
typedef UStringBuffer<128> UString128 |
128 character UTF-16 string
typedef UStringBuffer<256> UString256 |
256 character UTF-16 string
anonymous enum |
enum Direction |
enum Orientation |
enum VirtualKeyCodes |
Virtual Key Codes.
OS-independent enumeration of virtual keycodes.
enum KeyModifier |
enum StandardColor |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
void Steinberg::Swap | ( | T & | t1, |
T & | t2 | ||
) |
bool Steinberg::IsApproximateEqual | ( | T | t1, |
T | t2, | ||
T | epsilon | ||
) |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
IPtr<I> Steinberg::owned | ( | I * | p | ) |
IPtr<I> Steinberg::shared | ( | I * | p | ) |
|
inline |
Create color specifier with RGB values (alpha is opaque)
|
inline |
Create color specifier with RGBA values.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Normalized color components.
{
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
}
void Steinberg::StringCopy | ( | TDstChar * | dst, |
int32 | dstSize, | ||
const TSrcChar * | src, | ||
int32 | srcSize = -1 |
||
) |
Copy strings of different character width.
int32 Steinberg::StringLength | ( | const TSrcChar * | src, |
int32 | srcSize = -1 |
||
) |
Find length of null-terminated string.
const FIDString kPlatformStringWin = "WIN" |
const FIDString kPlatformStringMac = "MAC" |
const FIDString kPlatformStringIOS = "IOS" |
const FIDString kPlatformStringLinux = "Linux" |
const FIDString kPlatformString = kPlatformStringLinux |
const FIDString kPlatformTypeHIView = "HIView" |
The parent parameter in IPlugView::attached() is a WindowRef.
You should attach a HIViewRef to the content view of the window. HIViewRef. (Mac OS X)
const FIDString kPlatformTypeNSView = "NSView" |
The parent parameter in IPlugView::attached() is a NSView pointer.
You should attach a NSView to it. NSView pointer. (Mac OS X)
const FIDString kPlatformTypeUIView = "UIView" |
The parent parameter in IPlugView::attached() is a UIView pointer.
You should attach an UIView to it. UIView pointer. (iOS)
const FIDString kPlatformTypeX11EmbedWindowID = "X11EmbedWindowID" |
The parent parameter in IPlugView::attached() is a X11 Window supporting XEmbed.
You should attach a Window to it that supports the XEmbed extension. See https://standards.freedesktop.org/xembed-spec/xembed-spec-latest.html X11 Window ID. (X11)