Audacity 3.2.0
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
EffectSettings Struct Reference

Externalized state of a plug-in. More...

#include <EffectInterface.h>

Inheritance diagram for EffectSettings:
[legend]
Collaboration diagram for EffectSettings:
[legend]

Public Member Functions

void swap (EffectSettings &other)
 
- Public Member Functions inherited from audacity::TypedAny< EffectSettings >
 TypedAny (Args &&... args)
 Constructor with arguments just as for std::any, but it is explicit. More...
 
 TypedAny (const TypedAny &)=default
 
 TypedAny (TypedAny &&)=default
 
TypedAnyoperator= (const TypedAny &)=default
 
TypedAnyoperator= (TypedAny &&)=default
 
std::decay_t< ValueType > & emplace (Args &&... args)
 
void reset () noexcept
 
void swap (TypedAny &other) noexcept
 
bool has_value () const noexcept
 
const std::type_info & type () const noexcept
 
const T * cast () const noexcept
 Like pointer-valued any_cast but a non-static member function. More...
 
T * cast () noexcept
 Like pointer-valued any_cast but a non-static member function. More...
 

Static Public Member Functions

template<typename T , typename... Args>
static EffectSettings Make (Args &&... args)
 Like make_any but a static member function. More...
 
template<typename T >
static bool Copy (const EffectSettings &src, EffectSettings &dst)
 
- Static Public Member Functions inherited from audacity::TypedAny< EffectSettings >
static TypedAny make (Args &&... args)
 Like make_any but a static member function. More...
 

Public Attributes

EffectSettingsExtra extra
 

Detailed Description

Externalized state of a plug-in.

Definition at line 93 of file EffectInterface.h.

Member Function Documentation

◆ Copy()

template<typename T >
static bool EffectSettings::Copy ( const EffectSettings src,
EffectSettings dst 
)
inlinestatic

Convenience for defining overrides of EffectDefinitionInterface::CopySettingsContents

Definition at line 113 of file EffectInterface.h.

114 {
115 const T *pSrc = src.cast<T>();
116 T *pDst = dst.cast<T>();
117 if (pSrc && pDst) {
118 *pDst = *pSrc;
119 return true;
120 }
121 return false;
122 }
const T * cast() const noexcept
Like pointer-valued any_cast but a non-static member function.
Definition: TypedAny.h:68

References audacity::TypedAny< Tag >::cast().

Here is the call graph for this function:

◆ Make()

template<typename T , typename... Args>
static EffectSettings EffectSettings::Make ( Args &&...  args)
inlinestatic

Like make_any but a static member function.

Definition at line 105 of file EffectInterface.h.

106 {
107 return EffectSettings(std::in_place_type<T>, std::forward<Args>(args)...);
108 }
Externalized state of a plug-in.

◆ swap()

void EffectSettings::swap ( EffectSettings other)
inline

Definition at line 97 of file EffectInterface.h.

98 {
99 TypedAny::swap(other);
100 std::swap(extra, other.extra);
101 }
void swap(std::unique_ptr< Alg_seq > &a, std::unique_ptr< Alg_seq > &b)
Definition: NoteTrack.cpp:753
EffectSettingsExtra extra

References extra, and anonymous_namespace{NoteTrack.cpp}::swap().

Referenced by RealtimeEffectState::SettingsAndCounter::swap().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ extra

EffectSettingsExtra EffectSettings::extra

The documentation for this struct was generated from the following file: