class EffectReg

Defined in: C4Effects.h

The EffectReg class represents a custom effect type.

Definition

template <class classType> class EffectReg : public EffectRegistration

Template Parameters

classType The custom effect class.

Constructor

EffectReg(EffectType type, const char *name);

Parameters

`type`	The effect type.
`name`	The effect name.

Description

The EffectReg template class is used to advertise the existence of a custom effect type. The Effect Manager uses an effect registration to construct a custom effect. The act of instantiating an EffectReg object automatically registers the corresponding effect type. The effect type is unregistered when the EffectReg object is destroyed.

No more than one effect registration should be created for each distinct effect type.

Base Classes

EffectRegistration All specific effect registration classes share the common base class EffectRegistration.