|
Base Module
VST 3.6.6
SDK for developing VST Plug-in
|
Namespaces | |
| CommandLine | |
| Very simple command-line parser. | |
| FPanicAssert | |
| HexBinary | |
| MetaClasses | |
| Performance | |
| Singleton | |
| Automatic creation and destruction of singleton instances. | |
| StringMethods | |
| SystemTime | |
Data Structures | |
| class | BitSet |
| Bitset - A collection of bits. More... | |
| class | Buffer |
| Buffer. More... | |
| class | ClassFactory |
| Registry for meta classes. More... | |
| class | ConstString |
| Invariant String. More... | |
| class | DisableDispatchingTimers |
| Disables dispatching of timers for the live time of this object. More... | |
| struct | FArrayDeleter |
| Template definition for classes that help guarding against memory leaks. More... | |
| class | FBlockAllocator |
| FBlockAllocator provides a simple allocator that works on larger blocks of memory. More... | |
| struct | FBooleanSetter |
| Class definition for objects that help resetting boolean variables. More... | |
| struct | FCloser |
| Template definition for classes that help closing resourses. More... | |
| class | FComparablePtr |
| Extends IPtr to allow comparison in containers. More... | |
| class | FCondition |
| FCondition - wraps the signal and wait calls in win32. More... | |
| struct | FConditionalBoolSetter |
| Class definition for objects that help setting boolean variables. More... | |
| class | FConditionalGuard |
| Conditional Guard - Locks only if valid lock is passed. More... | |
| class | FConditionalReadGuard |
| Conditional Read Guard - Locks only if valid lock is passed. More... | |
| class | FConditionalWriteGuard |
| Conditional Write Guard - Locks only if valid lock is passed. More... | |
| class | FCpuInfo |
| CPU Info. More... | |
| class | FCriticalPerformanceEnabler |
| FCriticalPerformanceEnabler. More... | |
| struct | FDeleter |
| Template definition for classes that help guarding against memory leaks. More... | |
| class | FDynLibrary |
| Platform independent dynamic library loader. More... | |
| class | FGuard |
| FGuard - automatic object for locks. More... | |
| class | FLocalThreadStorage |
| Local storage for threadsLocal thread storage enables multiple threads to use the same ID to store and retrieve an object that is local to the thread. More... | |
| class | FLock |
| FLock declaration. More... | |
| class | FLockObject |
| FLockObj declaration. More... | |
| class | FMallocReleaser |
| Class definition for objects that help guarding against memory leaks. More... | |
| class | FMemoryBlockPool |
| FMemoryBlockPool provides a pool of equal sized preallocated memory blocks. More... | |
| class | FMemoryPool |
| FMemoryPool provides a pool of equal sized cached memory blocks. More... | |
| struct | FNuller |
| Template definition for classes that help resetting an object's value. More... | |
| class | FObject |
| Implements FUnknown and IDependent. More... | |
| class | FObjectPool |
| FObjectPool allocates objects in blocks with MAX_USHORT elements per block. More... | |
| struct | FPtrNuller |
| Template definition for classes that help guarding against dangling pointers. More... | |
| class | FReadGuardT |
| Scope object for setting a read lock. More... | |
| class | FRecursionCounter |
| Prevent recursive calls or from another thread to a method use in combination with FRecursionGuard. More... | |
| class | FRecursionGuard |
| Guard for a FRecursionCounterusage example: More... | |
| class | FRwLock |
| FRwLock - read / write lock. More... | |
| class | FSemaphore |
| Semaphore. More... | |
| class | FSemaphoreGuard |
| Semaphore Guard - automatic object for semaphores. More... | |
| class | FSortablePtr |
| Extends IPtr to allow sorted containers. More... | |
| class | FStreamer |
| Byteorder-aware base class for typed stream i/o. More... | |
| class | FStreamSizeHolder |
| FStreamSizeHolder Declaration remembers size of stream chunk for backward compatibility. More... | |
| class | FThread |
| FThread wraps threads for each platform. More... | |
| class | FUnknownFactory |
| FUnknown factory singleton. More... | |
| class | FWriteGuardT |
| Scope object for setting a write lock. More... | |
| class | IBStreamer |
| Wrapper class for typed reading/writing from or to IBStream. More... | |
| class | IDSet |
| IDSet is a BitSet allowing to generate/release IDs starting with a given start offset. More... | |
| struct | ILock |
| Lock interface declaration. More... | |
| class | ISortablePtr |
| struct | IThreadSpy |
| Thread Spy interface declaration. More... | |
| class | ITimerCallback |
| Implement this callback interface to receive triggers from a timer. More... | |
| class | IUpdateManager |
| Handle Send and Cancel pending message for a given object. More... | |
| class | MetaClass |
| Class whose instances are classes. More... | |
| class | OneTimeProcedure |
| Manager for initialization & termination code. More... | |
| class | Point |
| Point Representation. More... | |
| struct | PThreadReaderPreferenceRWLock |
| struct | PThreadSlimWriterPreferenceRWLock |
| struct | PThreadWriterPreferenceRWLock |
| class | Rect |
| Rectangle Class. More... | |
| class | Region |
| Region Class. More... | |
| class | RWLockRecursion |
| class | String |
| String. More... | |
| class | StringObject |
| StringObject implements IStringResult and IString methods. More... | |
| class | TArray |
| Array container template. More... | |
| class | TArrayBase |
| Template array base class. More... | |
| class | TArrayIterator |
| Iterator for array template container. More... | |
| class | TAssociation |
| Association template definition. More... | |
| class | TAssociationArray |
| Association Array template definition. More... | |
| class | TBag |
| Bag template. More... | |
| class | TBinaryTree |
| TBinaryTree is a rooted binary tree. More... | |
| class | TBinaryTreeIterator |
| class | TBinaryTreeNode |
| class | TBTree |
| BTree template definition. More... | |
| class | TBTreeDictionary |
| B-Tree dictionary template definition. More... | |
| class | TBTreeIterator |
| Iterator for the BTree template. More... | |
| class | TBTreeNode |
| class | TBTreeSet |
| B-Tree set template definition. More... | |
| class | TContainer |
| Template container base class (abstract). More... | |
| class | TDeque |
| TDeque is a double ended queue. More... | |
| class | TDictionary |
| Dictionary template definition. More... | |
| class | TDictionaryIterator |
| class | TDLinkedList |
| Doubly linked template list. More... | |
| class | TDLinkedListIterator |
| Iterator for doubly linked template list. More... | |
| class | THashBucket |
| Private class to THashTable. More... | |
| class | THashDictionary |
| Hash dictionary template definition. More... | |
| class | THashDictionaryIterator |
| class | THashNode |
| Private class to THashTable. More... | |
| class | THashSet |
| A hash set is a collection of items, without any particular order and without repetitions stored in a hash table. More... | |
| class | THashTable |
| Hash Table templateA hash table is a list of buckets. More... | |
| class | THashTableIterator |
| Iterator for a THashTable. More... | |
| class | Timer |
| Timer is a class that allows you to receive triggers at regular intervals. More... | |
| class | TIterator |
| Template container iterator base class (abstract). More... | |
| class | TLinkedList |
| Single linked list template definition. More... | |
| class | TLinkedListIterator |
| Iterator for single linked template list. More... | |
| class | TOrderedArray |
| Ordered Array container template. More... | |
| class | TQueue |
| Queue template. More... | |
| class | TRingBuffer |
| RingBuffer template. More... | |
| class | TSortable |
| class | TSortableArray |
| Sortable Array container template. More... | |
| class | TSortablePtr |
| struct | TSorterFunc |
| class | TStack |
| TStack is a template container based on the LIFO-principle (last in/first out). More... | |
| class | TVector |
| TVector provides a basic templated container for arrays of dynamic sizeTVector is a base class that is not meant to be derived from. More... | |
| class | UpdateHandler |
| UpdateHandler implements IUpdateManager and IUpdateHandler to handle dependencies between objects to store and forward messages to dependent objects. More... | |
| class | WindowsCompatibilityRWLock |
| struct | WindowsReaderPreferenceRWLock |
| struct | WindowsWriterPreferenceRWLock |
Typedefs | |
| typedef FBooleanSetter< bool > | FBoolSetter |
| typedef TArray< IPtr< FUnknown > > | FArray |
| Array holding FUnknown pointers. More... | |
| typedef TLinkedList< IPtr < FUnknown > > | FLinkedList |
| Linked List holding FUnknown pointers. More... | |
| typedef TContainer< IPtr < FUnknown > > | FContainer |
| Template container holding FUnknown pointers - can be used as function parameter. More... | |
| typedef bool(* | InitTermFunc )() |
| Initialization / Termination procedure format. There must not be parameters. Return true to indicate execution success. An initialization procedure returning false causes immediate initialization abort. More... | |
| typedef FIDString | FClassID |
| typedef Point | UPoint |
| typedef Rect | URect |
| typedef void(* | OverlapFunc )(register Region &dest, register const Rect *r1, const Rect *r1End, register const Rect *r2, const Rect *r2End, register UCoord y1, register UCoord y2) |
| typedef void(* | NonOverlapFunc )(register Region &dest, register const Rect *r, const Rect *rEnd, register UCoord y1, register UCoord y2) |
| typedef TArray< Rect > | RectangleArray |
| typedef FReadGuardT< FRwLock > | FReadGuard |
| typedef FWriteGuardT< FRwLock > | FWriteGuard |
Enumerations | |
| enum | InitLevel { kInitLevelFirst = 0, kInitLevelBelowStd = 25, kInitLevelStd = 50, kInitLevelAboveStd = 75, kInitLevelLast = 100 } |
| With init levels, you may initialize things in different places / at different program startup stages. More... | |
| enum | FSeekMode { kSeekSet, kSeekCurrent, kSeekEnd } |
| enum | MBCodePage { kCP_ANSI = 0, kCP_MAC_ROMAN = 2, kCP_ANSI_WEL = 1252, kCP_MAC_CEE = 10029, kCP_Utf8 = 65001, kCP_ShiftJIS = 932, kCP_US_ASCII = 20127, kCP_Default = kCP_ANSI } |
| enum | UnicodeNormalization { kUnicodeNormC, kUnicodeNormD, kUnicodeNormKC, kUnicodeNormKD } |
| enum | FThreadPriority { kLowPriority, kBelowNormalPriority, kNormalPriority, kAboveNormalPriority, kHighPriority, kRealtimePriority } |
| Thread priority enum. More... | |
Functions | |
| int32 | FAtomicIncrement (volatile int32 &var) |
| Thread and multiprocessor safe increment. More... | |
| int32 | FAtomicDecrement (volatile int32 &var) |
| Thread and multiprocessor safe decrement. More... | |
| int32 | FAtomicAdd (volatile int32 &var, int32 d) |
| Thread & multiprocessor safe addition. More... | |
| bool | FAtomicCompareAndSwap (volatile int32 &var, int32 oldVar, int32 newVar) |
| Thread & multiprocessor safe compare and swap compare var with oldVar and if they are equal set var to newVar. More... | |
| bool | FAtomicCompareAndSwap (volatile void *&var, void *oldVar, void *newVar) |
| Thread & multiprocessor safe compare and swap compare var with oldVar and if they are equal set var to newVar. More... | |
| void * | alignedMalloc (int32 size, int32 alignment=16) |
| Allocate memory aligned to a given alignment. More... | |
| bool | alignedFree (void *buffer) |
| Free aligned memory allocated by alignedMalloc. More... | |
| template<class C > | |
| C * | FCast (const FObject *object) |
| FCast overload 1 - FObject to FObject. More... | |
| template<class C > | |
| C * | FCast (FUnknown *unknown) |
| FCast overload 2 - FUnknown to FObject. More... | |
| template<class C > | |
| C * | FUCast (FObject *object) |
| FUCast - casting from FUnknown to Interface. More... | |
| template<class C > | |
| C * | FUCast (FUnknown *object) |
| template<class T > | |
| void | AssignShared (T *&dest, T *newPtr) |
| template<class T > | |
| void | AssignSharedDependent (IDependent *_this, T *&dest, T *newPtr) |
| template<class T > | |
| void | AssignSharedDependent (IDependent *_this, IPtr< T > &dest, T *newPtr) |
| template<class T > | |
| void | SafeReleaseDependent (IDependent *_this, T *&dest) |
| template<class T > | |
| void | SafeReleaseDependent (IDependent *_this, IPtr< T > &dest) |
| bool | operator== (const Point &p1, const Point &p2) |
| bool | operator< (const Point &p1, const Point &p2) |
| bool | operator== (const Rect &r1, const Rect &r2) |
| bool | operator!= (const Rect &r1, const Rect &r2) |
| bool | operator< (const Rect &r1, const Rect &r2) |
| void | MergeRect (register TArray< Rect > &destRects, const Rect *&r, register int32 y1, register int32 y2) |
| uint32 | hashString8 (const char8 *s, uint32 m) |
| uint32 | hashString16 (const char16 *s, uint32 m) |
| template<class T > | |
| int32 | tstrnatcmp (const T *s1, const T *s2, bool caseSensitive=true) |
| int32 | strnatcmp8 (const char8 *s1, const char8 *s2, bool caseSensitive) |
| int32 | strnatcmp16 (const char16 *s1, const char16 *s2, bool caseSensitive) |
| uint32 | hashString (const char *s, uint32 m) |
| String | operator+ (const ConstString &s1, const ConstString &s2) |
| String | operator+ (const ConstString &s1, const char8 *s2) |
| String | operator+ (const ConstString &s1, const char16 *s2) |
| String | operator+ (const char8 *s1, const ConstString &s2) |
| String | operator+ (const char16 *s1, const ConstString &s2) |
| String | operator+ (const ConstString &s1, const String &s2) |
| String | operator+ (const String &s1, const ConstString &s2) |
| String | operator+ (const String &s1, const String &s2) |
| String | operator+ (const String &s1, const char8 *s2) |
| String | operator+ (const String &s1, const char16 *s2) |
| String | operator+ (const char8 *s1, const String &s2) |
| String | operator+ (const char16 *s1, const String &s2) |
| bool | operator< (const ConstString &s1, const ConstString &s2) |
| bool | operator<= (const ConstString &s1, const ConstString &s2) |
| bool | operator> (const ConstString &s1, const ConstString &s2) |
| bool | operator>= (const ConstString &s1, const ConstString &s2) |
| bool | operator== (const ConstString &s1, const ConstString &s2) |
| bool | operator!= (const ConstString &s1, const ConstString &s2) |
| bool | operator< (const ConstString &s1, const char8 *s2) |
| bool | operator<= (const ConstString &s1, const char8 *s2) |
| bool | operator> (const ConstString &s1, const char8 *s2) |
| bool | operator>= (const ConstString &s1, const char8 *s2) |
| bool | operator== (const ConstString &s1, const char8 *s2) |
| bool | operator!= (const ConstString &s1, const char8 *s2) |
| bool | operator< (const char8 *s1, const ConstString &s2) |
| bool | operator<= (const char8 *s1, const ConstString &s2) |
| bool | operator> (const char8 *s1, const ConstString &s2) |
| bool | operator>= (const char8 *s1, const ConstString &s2) |
| bool | operator== (const char8 *s1, const ConstString &s2) |
| bool | operator!= (const char8 *s1, const ConstString &s2) |
| bool | operator< (const ConstString &s1, const char16 *s2) |
| bool | operator<= (const ConstString &s1, const char16 *s2) |
| bool | operator> (const ConstString &s1, const char16 *s2) |
| bool | operator>= (const ConstString &s1, const char16 *s2) |
| bool | operator== (const ConstString &s1, const char16 *s2) |
| bool | operator!= (const ConstString &s1, const char16 *s2) |
| bool | operator< (const char16 *s1, const ConstString &s2) |
| bool | operator<= (const char16 *s1, const ConstString &s2) |
| bool | operator> (const char16 *s1, const ConstString &s2) |
| bool | operator>= (const char16 *s1, const ConstString &s2) |
| bool | operator== (const char16 *s1, const ConstString &s2) |
| bool | operator!= (const char16 *s1, const ConstString &s2) |
| int32 | strnatcmp (const char *s1, const char *s2, bool caseSensitive=true) |
| void | FThreadSleep (int32 milliseconds) |
| Sets current thread to sleep for a while, while releasing the CPU. More... | |
| template<typename T > | |
| IPtr< T > | newFUnknown () |
| template<typename Call > | |
| ITimerCallback * | newTimerCallback (const Call &call) |
| DEF_CLASS_IID (IUpdateManager) namespace Update | |
| SINGLE_CREATE_FUNC (UpdateHandler) UpdateHandler | |
Convenience methods that call release or delete respectively | |
on a pointer if it is non-zero, and then set the pointer to zero. Note: you should prefer using IPtr or OPtr instead of these methods whenever possible. Examples: ~Foo ()
{
// instead of ...
if (somePointer)
{
somePointer->release ();
somePointer = 0;
}
// ... just being lazy I write
SafeRelease (somePointer)
}
| |
| template<class I > | |
| void | SafeRelease (I *&ptr) |
| template<class I > | |
| void | SafeRelease (IPtr< I > &ptr) |
| template<class T > | |
| void | SafeDelete (T *&ptr) |
Variables | |
| struct Steinberg::FObjectIIDInitializer | gFObjectIidInitializer |
| typedef FBooleanSetter<bool> FBoolSetter |
| typedef bool(* InitTermFunc)() |
Initialization / Termination procedure format. There must not be parameters. Return true to indicate execution success. An initialization procedure returning false causes immediate initialization abort.
| typedef FIDString FClassID |
| typedef void(* OverlapFunc)(register Region &dest, register const Rect *r1, const Rect *r1End, register const Rect *r2, const Rect *r2End, register UCoord y1, register UCoord y2) |
| typedef void(* NonOverlapFunc)(register Region &dest, register const Rect *r, const Rect *rEnd, register UCoord y1, register UCoord y2) |
| typedef TArray<Rect> RectangleArray |
| typedef FReadGuardT<FRwLock> FReadGuard |
| typedef FWriteGuardT<FRwLock> FWriteGuard |
| enum InitLevel |
With init levels, you may initialize things in different places / at different program startup stages.
Assign init levels to initialization procedures to form groups of the same level. When calling OneTimeProcedure::initialize(untilLevel), only procedures with a level up to the indicated one will be executed & discarded.
| Enumerator | |
|---|---|
| kInitLevelFirst | |
| kInitLevelBelowStd | |
| kInitLevelStd | |
| kInitLevelAboveStd | |
| kInitLevelLast | |
| enum FSeekMode |
| enum MBCodePage |
| enum UnicodeNormalization |
| enum FThreadPriority |
| int32 FAtomicIncrement | ( | volatile int32 & | var | ) |
Thread and multiprocessor safe increment.
| [in,out] | var | : the value to increment |
| int32 FAtomicDecrement | ( | volatile int32 & | var | ) |
Thread and multiprocessor safe decrement.
| [in,out] | var | : the value to decrement |
| int32 FAtomicAdd | ( | volatile int32 & | var, |
| int32 | d | ||
| ) |
Thread & multiprocessor safe addition.
| [in,out] | var | : the initial value and the result |
| [in] | d | : the value to add |
| bool FAtomicCompareAndSwap | ( | volatile int32 & | var, |
| int32 | oldVar, | ||
| int32 | newVar | ||
| ) |
Thread & multiprocessor safe compare and swap compare var with oldVar and if they are equal set var to newVar.
| bool FAtomicCompareAndSwap | ( | volatile void *& | var, |
| void * | oldVar, | ||
| void * | newVar | ||
| ) |
Thread & multiprocessor safe compare and swap compare var with oldVar and if they are equal set var to newVar.
Parameter are based on pointer, so it can be used in 32 and 64bit version.
| void * alignedMalloc | ( | int32 | size, |
| int32 | alignment = 16 |
||
| ) |
Allocate memory aligned to a given alignment.
| [in] | size | : size of the memory to be allocated |
| [in] | alignment | : specifies the desired byte alignment of the returned address. This must be even and greater than 2. You will get undefined behavior if the alignment is not a power of 2. |
Allocation is done on the heap of the standard runtime by allocating more memory and returning the first address that meets the alignment demands. You must free the memory by calling alignedFree.
| bool alignedFree | ( | void * | buffer | ) |
Free aligned memory allocated by alignedMalloc.
| [in] | buffer | : pointer to the memory allocated by alignedMalloc |
|
inline |
FCast overload 2 - FUnknown to FObject.
|
inline |
FUCast - casting from FUnknown to Interface.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
| uint32 hashString8 | ( | const char8 * | s, |
| uint32 | m | ||
| ) |
| uint32 hashString16 | ( | const char16 * | s, |
| uint32 | m | ||
| ) |
| int32 Steinberg::tstrnatcmp | ( | const T * | s1, |
| const T * | s2, | ||
| bool | caseSensitive = true |
||
| ) |
| int32 strnatcmp8 | ( | const char8 * | s1, |
| const char8 * | s2, | ||
| bool | caseSensitive | ||
| ) |
| int32 strnatcmp16 | ( | const char16 * | s1, |
| const char16 * | s2, | ||
| bool | caseSensitive | ||
| ) |
|
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 |
|
inline |
|
inline |
|
inline |
|
inline |
| IPtr<T> Steinberg::newFUnknown | ( | ) |
| ITimerCallback* Steinberg::newTimerCallback | ( | const Call & | call | ) |
| Steinberg::DEF_CLASS_IID | ( | IUpdateManager | ) |
| Steinberg::SINGLE_CREATE_FUNC | ( | UpdateHandler | ) |
| struct Steinberg::FObjectIIDInitializer gFObjectIidInitializer |