The SFModulatorKey class represents the unique key of a modulator. More...

#include <modulator_key.hpp>

Public Member Functions
	SFModulatorKey ()
	Constructs a new SFModulatorKey.

	SFModulatorKey (SFModulator source_op, SFGenerator destination_op, SFModulator amount_source_op)
	Constructs a new SFModulatorKey using the specified controllers. More...

	SFModulatorKey (const SFModulatorKey &origin)=default
	Constructs a new copy of specified SFModulatorKey. More...

SFModulatorKey &	operator= (const SFModulatorKey &origin)=default
	Copy-assigns a new value to the SFModulatorKey, replacing its current contents. More...

	SFModulatorKey (SFModulatorKey &&origin)=default
	Acquires the contents of specified SFModulatorKey. More...

SFModulatorKey &	operator= (SFModulatorKey &&origin)=default
	Move-assigns a new value to the SFModulatorKey, replacing its current contents. More...

	~SFModulatorKey ()=default
	Destructs the SFModulatorKey.

SFModulator	source_op () const noexcept
	Returns the source of data for the modulator. More...

void	set_source_op (SFModulator source_op)
	Sets the source of data for the modulator. More...

SFGenerator	destination_op () const noexcept
	Returns the destination of the modulator. More...

void	set_destination_op (SFGenerator destination_op)
	Sets the destination of the modulator. More...

SFModulator	amount_source_op () const noexcept
	Returns the modulation source to be applied to the modulation amount. More...

void	set_amount_source_op (SFModulator amount_source_op)
	Sets the modulation source to be applied to the modulation amount. More...

Friends
bool	operator== (const SFModulatorKey &x, const SFModulatorKey &y) noexcept
	Indicates a SFModulatorKey object is "equal to" the other one. More...

bool	operator!= (const SFModulatorKey &x, const SFModulatorKey &y) noexcept
	Indicates a SFModulatorKey object is "not equal to" the other one. More...

bool	operator< (const SFModulatorKey &x, const SFModulatorKey &y) noexcept
	Indicates a SFModulatorKey object is "less than" the other one. More...

bool	operator<= (const SFModulatorKey &x, const SFModulatorKey &y) noexcept
	Indicates a SFModulatorKey object is "less than or equal to" the other one. More...

bool	operator> (const SFModulatorKey &x, const SFModulatorKey &y) noexcept
	Indicates a SFModulatorKey object is "greater than" the other one. More...

bool	operator>= (const SFModulatorKey &x, const SFModulatorKey &y) noexcept
	Indicates a SFModulatorKey object is "greater than or equal to" the other one. More...

Detailed Description

The SFModulatorKey class represents the unique key of a modulator.

Remarks: This class represents a part of the sfModList/sfInstModList type.

See also: "7.4 The PMOD Sub-chunk". In SoundFont Technical Specification 2.04.; "7.8 The IMOD Sub-chunk". In SoundFont Technical Specification 2.04.

Constructor & Destructor Documentation

sf2cute::SFModulatorKey::SFModulatorKey	(	SFModulator	source_op,
		SFGenerator	destination_op,
		SFModulator	amount_source_op
	)

Constructs a new SFModulatorKey using the specified controllers.

Parameters

source_op	the source of data for the modulator.
destination_op	the destination of the modulator.
amount_source_op	the modulation source to be applied to the modulation amount.

sf2cute::SFModulatorKey::SFModulatorKey ( const SFModulatorKey & origin )

default

Constructs a new copy of specified SFModulatorKey.

Parameters

origin a SFModulatorKey object.

sf2cute::SFModulatorKey::SFModulatorKey ( SFModulatorKey && origin )

default

Acquires the contents of specified SFModulatorKey.

Parameters

origin a SFModulatorKey object.

Member Function Documentation

SFModulator sf2cute::SFModulatorKey::amount_source_op ( ) const

noexcept

Returns the modulation source to be applied to the modulation amount.

Returns: the modulation source to be applied to the modulation amount.

SFGenerator sf2cute::SFModulatorKey::destination_op ( ) const

noexcept

Returns the destination of the modulator.

Returns: the destination of the modulator.

SFModulatorKey& sf2cute::SFModulatorKey::operator= ( const SFModulatorKey & origin )

default

Copy-assigns a new value to the SFModulatorKey, replacing its current contents.

Parameters

origin a SFModulatorKey object.

SFModulatorKey& sf2cute::SFModulatorKey::operator= ( SFModulatorKey && origin )

default

Move-assigns a new value to the SFModulatorKey, replacing its current contents.

Parameters

origin a SFModulatorKey object.

void sf2cute::SFModulatorKey::set_amount_source_op ( SFModulator amount_source_op )

Sets the modulation source to be applied to the modulation amount.

Parameters

amount_source_op the modulation source to be applied to the modulation amount.

void sf2cute::SFModulatorKey::set_destination_op ( SFGenerator destination_op )

Sets the destination of the modulator.

Parameters

destination_op the destination of the modulator.

void sf2cute::SFModulatorKey::set_source_op ( SFModulator source_op )

Sets the source of data for the modulator.

Parameters

source_op the source of data for the modulator.

SFModulator sf2cute::SFModulatorKey::source_op ( ) const

noexcept

Returns the source of data for the modulator.

Returns: the source of data for the modulator.

Friends And Related Function Documentation

bool operator!=	(	const SFModulatorKey &	x,
		const SFModulatorKey &	y
	)

friend

Indicates a SFModulatorKey object is "not equal to" the other one.

Parameters

x	the first object to be compared.
y	the second object to be compared.

Returns: true if a SFModulatorKey object is "not equal to" the other one.

bool operator<	(	const SFModulatorKey &	x,
		const SFModulatorKey &	y
	)

friend

Indicates a SFModulatorKey object is "less than" the other one.

Parameters

x	the first object to be compared.
y	the second object to be compared.

Returns: true if a SFModulatorKey object is "less than" the other one.

bool operator<=	(	const SFModulatorKey &	x,
		const SFModulatorKey &	y
	)

friend

Indicates a SFModulatorKey object is "less than or equal to" the other one.

Parameters

x	the first object to be compared.
y	the second object to be compared.

Returns: true if a SFModulatorKey object is "less than or equal to" the other one.

bool operator==	(	const SFModulatorKey &	x,
		const SFModulatorKey &	y
	)

friend

Indicates a SFModulatorKey object is "equal to" the other one.

Parameters

x	the first object to be compared.
y	the second object to be compared.

Returns: true if a SFModulatorKey object is "equal to" the other one.

bool operator>	(	const SFModulatorKey &	x,
		const SFModulatorKey &	y
	)

friend

Indicates a SFModulatorKey object is "greater than" the other one.

Parameters

x	the first object to be compared.
y	the second object to be compared.

Returns: true if a SFModulatorKey object is "greater than" the other one.

bool operator>=	(	const SFModulatorKey &	x,
		const SFModulatorKey &	y
	)

friend

Indicates a SFModulatorKey object is "greater than or equal to" the other one.

Parameters

x	the first object to be compared.
y	the second object to be compared.

Returns: true if a SFModulatorKey object is "greater than or equal to" the other one.

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

include/sf2cute/modulator_key.hpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation