EffectSettingsAccess::Message Class Reference

Type of messages to send from main thread to processing. More...

#include <EffectInterface.h>

Inheritance diagram for EffectSettingsAccess::Message:

Public Member Functions
virtual	~Message ()
virtual std::unique_ptr< Message >	Clone () const =0
virtual void	Assign (Message &&src)=0
	Update one Message object from another, which is then left "empty". More...
virtual void	Merge (Message &&src)=0
	Combine one Message object with another, which is then left "empty". More...

Detailed Description

Type of messages to send from main thread to processing.

Definition at line 156 of file EffectInterface.h.

Constructor & Destructor Documentation

~Message()

EffectSettingsAccess::Message::~Message ( )

virtualdefault

Member Function Documentation

Assign()

virtual void EffectSettingsAccess::Message::Assign ( Message &&  src )

pure virtual

Update one Message object from another, which is then left "empty".

This may run in a worker thread, and should avoid allocating and freeing. Therefore do not copy, grow or clear any containers in it, but assign the preallocated contents of *this from another, which then should be reassigned to an initial state.

Assume that src and *this come from the same EffectInstance.

Parameters

src	settings to copy from

Clone()

virtual std::unique_ptr< Message > EffectSettingsAccess::Message::Clone ( ) const

pure virtual

Implemented in anonymous_namespace{AudioUnitInstance.cpp}::AudioUnitMessage, and anonymous_namespace{VSTEffect.cpp}::VSTEffectMessage.

Merge()

virtual void EffectSettingsAccess::Message::Merge ( Message &&  src )

pure virtual

Combine one Message object with another, which is then left "empty".

This runs in the main thread. Combine the contents of one message into *this, and then the other should be reassigned to an initial state.

Assume that src and *this come from the same EffectInstance.

Parameters

src	settings to copy from

---

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

• EffectInterface.h
• EffectInterface.cpp