beta
cables is under heavy development.
There might be one or another bug, please let us know about it!
cables DocumentationHow To UseWorking with filesKeyboard ShortcutsUser Interface WalkthroughBeginner TutorialBeginner 1: Drawing A CircleBeginner 2: TransformationsBeginner 3: ColorMore TransformationsintermediateImage CompositionsPost-Processing 3D Scenescommunicationcables APICommunication with an Arduino via SerialCommunicating with Arduino over MQTTExporting And EmbeddingHow to serve files externally and fix CORS headersExporting PatchesExport using the cables command line interfaceExport via IframeExport creating a standalone executableExport to github (pages)Export and deploy to netlifyExport a ZIP fileExternal triggers / functionsUsing variablesPreviewing / uploading exported cables patchescoding opsCreating AttachmentsGeneral op/Port CallbacksPortsDynamic PortsArray PortsBoolean portsInteger Number PortsObject PortsString portsTrigger PortsFloating Point Number PortsGUI/UI attributesHello Op - Part 1LibrariesDeveloping OpsGuidelinesObject PortsWriting ShadersWeb Audio Op DevelopmentHTML and CSS in cablesLightingLightsShadowsWorking with audioBasic Audio SetupWorking with EffectsReal-Time Audio Analyzation & Audio VisualizationOffline Audio Visualization & AnalyzationFAQEmbeddingHow to integrate my cables patch into my CMS (webflow/wix/squarespace/...)?getting a warning when running the patch in electronHow to remove grey rectangles on touch (mobile)?Why doesn't the DownloadTexture op work on iOS?How to disable page scrolling on mobile?Mobile tippsTransparent CanvasFeatures and SupportHow to contribute code to cablesWill there be support for (animated) GIFs?How to report a bug in cablesGeneral questionsLicences and paymentWhat licence do i need to use cables?Will I have to pay for it in the future?How is my work licenced when using cables?Does cables support midi and OSC?ShadertoyTechnical questionsUI / EditorGuide to VR in cablesWebGL1 and WebGL2

Ports

Port Types

These are the different types of ports your op can use:

Trigger Ports - Yellow

Button

Trigger ports are used to trigger another op.
Trigger ops can also have a button in the op pane which can be clicked

Button

Click this link for an example

Value Ports - Green

Button

Value ports can hold a single value, a number (e.g. -1, 2.45), a bool (true, false), a string ("foo bar"), a string with multiple lines or a certain value from a dropdown-input.
Creating a value port also creates a slider in the ui pane which can be used

Button

Click this link for an example

String Ports - Green

Button

JavaScript strings are used for storing and manipulating text
A string is zero or more characters written inside quotes

Eg. "This is a string" "this as well 123456789"

Click this link for an example

Boolean Ports - Green

Button

Boolean ports can hold one of two values : true or false

Click this link for an example

Array Ports - Light purple

Button

A Javascript array can contain either simple values, arrays or objects

Arrays are used to store multiple values in a single variable.

E.g. [1, 2, 3], [[1, 2], [3, 4]], [{"one": 2}, {"three": 4}]

Click this link for an example

Object Ports - Dark purple

Button

Click this link for an example

Display: String
var inPort = op.inString("inPort");

inPort.onChange=function() {
    op.log( "Port changed to: " + inPort.get() === "foo bar" );
};
Display: Editor

Editor Edit View
Editor Button

var text = op.inStringEditor("text");

text.onChange=function() {
    op.log('text changed to:' + text.get());
};

If you click the edit button, text can be edited in the editor. Used for all kinds of multiline-input.

It is also possible to define the syntax highlighting for the editor-tab:

text.setUiAttribs({ "editorSyntax": "css" });
Display: Dropdown

For a fixed amount of values to choose from.

var options = op.inDropDown("options", ['option a','option b']);

Array Ports

var options = op.inArray("options");

A Javascript array, which can either contain simple values, arrays or objects.

E.g. [1, 2, 3], [[1, 2], [3, 4]], [{"one": 2}, {"three": 4}]

Object Ports

var data = op.inObject("data");

An object can contain basically anything, e.g.:

{
  "a": 123,
  "b": "foo",
  "c": true,
  "d": {
    "e": [1, 2, 3, 4]
  }
}

Port linking

Once a port is linked with another port myPort.onLinkChanged is executed. When it is executed the port may not have a value yet, it just sais: «There is a new connection». Later on myPort.onLinkChanged is called and you can get the new value with myPort.get().

var myPort = op.inFloat("My Port");

myPort.onLinkChanged = function() {
    op.log("A link to myPort has been added or removed");
    if(myPort.isLinked()) {
        op.log("myPort has been linked");
    } else {
        op.log("myPort has been unlinked ");
    }
};

myPort.onLinkChanged = function() {
    op.log("The value on myPort changed to: ", myPort.get());
}

If you need to access to other (linked) port you can also do so:

myPort.onLinkChanged = function() {
    op.log("A link to myPort has been added or removed");
    if(myPort.isLinked()) {
        op.log("myPort has been linked");
        // get the other port, as there can be multiple connections, get the last added one
        var otherPort = myPort.links[links.length-1].getOtherPort(myPort);
        op.log("Port is linked to: ", otherPort.name);
    } else {
        op.log("myPort has been unlinked ");
    }
};

help cables get better and edit this file on github