vc::effectArgument Struct Reference

#include <effectArgument.h>

Collaboration diagram for vc::effectArgument:

[legend]

List of all members.

---

Detailed Description

A container for passing arguments into plugin effect functions.

Public Member Functions
	effectArgument ()
	effectArgument (std::string _name, std::string _description, effectArgumentType _type)
Public Attributes
std::string	name
	The name of the argument. Required.
std::string	description
	A brief description of the argument.
effectArgumentType	type
	The type of the argument.
bool	_boolean
	The value of the argument if it is a boolean.
int	_integer
	The value of the argument if it is an integer.
double	_double
	The value of the argument if it is a double.
std::string	_string
	The value of the argument if it is a string.

---

Constructor & Destructor Documentation

vc::effectArgument::effectArgument

(

)

[inline]

vc::effectArgument::effectArgument	(	std::string	_name,
		std::string	_description,
		effectArgumentType	_type
	)			[inline]

---

Member Data Documentation

std::string vc::effectArgument::name

The name of the argument. Required.

std::string vc::effectArgument::description

A brief description of the argument.

effectArgumentType vc::effectArgument::type

The type of the argument.

bool vc::effectArgument::_boolean

The value of the argument if it is a boolean.

int vc::effectArgument::_integer

The value of the argument if it is an integer.

double vc::effectArgument::_double

The value of the argument if it is a double.

std::string vc::effectArgument::_string

The value of the argument if it is a string.

---

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

• lib/effectArgument.h

---