#include <PortInfo.hpp>

Public Member Functions
virtual	~PortInfo ()

virtual std::string	getName ()

std::string	getFullName ()
	Returns name with "input" or "output" appended.

virtual std::string	getDescription ()

Public Attributes
Port::Type	type = Port::INPUT

int	portId = -1

std::string	name
	The name of the port, using sentence capitalization.

std::string	description
	An optional one-sentence description of the parameter.

Constructor & Destructor Documentation

◆ ~PortInfo()

virtual rack::engine::PortInfo::~PortInfo ( )

inlinevirtual

Member Function Documentation

◆ getName()

virtual std::string rack::engine::PortInfo::getName ( )

virtual

◆ getFullName()

std::string rack::engine::PortInfo::getFullName ( )

Returns name with "input" or "output" appended.

◆ getDescription()

virtual std::string rack::engine::PortInfo::getDescription ( )

virtual

Member Data Documentation

◆ type

Port::Type rack::engine::PortInfo::type = Port::INPUT

◆ portId

int rack::engine::PortInfo::portId = -1

◆ name

std::string rack::engine::PortInfo::name

The name of the port, using sentence capitalization.

e.g. "Sine", "Pitch input", "Mode CV".

Don't use the words "input" or "output" in the name. Since this text is often prepended or appended to the name, the name will appear as e.g. "Sine input input", "Input: Sine input".

◆ description

std::string rack::engine::PortInfo::description

An optional one-sentence description of the parameter.

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

/home/vortico/src/vcv/Rack2/include/engine/PortInfo.hpp

Public Member Functions

Public Attributes