docs-v2/PortInfo_8hpp_source.html

#pragma once

#include <common.hpp>

#include <engine/Port.hpp>


namespace rack {

namespace engine {


struct Module;


struct PortInfo {

    Module* module = NULL;

    Port::Type type = Port::INPUT;

    int portId = -1;


    std::string name;


    std::string description;


    virtual ~PortInfo() {}

    virtual std::string getName();

    std::string getFullName();

    virtual std::string getDescription();

};


} // namespace engine

} // namespace rack

Port.hpp

rack
Root namespace for the Rack API.
Definition AudioDisplay.hpp:9

rack::engine::Module
DSP processor instance for your module.
Definition Module.hpp:29

rack::engine::PortInfo
Definition PortInfo.hpp:13

rack::engine::PortInfo::name
std::string name
The name of the port, using sentence capitalization.
Definition PortInfo.hpp:24

rack::engine::PortInfo::~PortInfo
virtual ~PortInfo()
Definition PortInfo.hpp:29

rack::engine::PortInfo::description
std::string description
An optional one-sentence description of the parameter.
Definition PortInfo.hpp:27

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

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

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

rack::engine::PortInfo::type
Port::Type type
Definition PortInfo.hpp:15

rack::engine::PortInfo::portId
int portId
Definition PortInfo.hpp:16

rack::engine::Port::Type
Type
Definition Port.hpp:37

rack::engine::Port::INPUT
@ INPUT
Definition Port.hpp:38