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 APIExporting 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 OpsCreating Viz OpsGuidelinesObject PortsWriting ShadersWeb Audio Op DevelopmentHTML and CSS in cablesLightingLightsShadowsWorking with audioBasic Audio SetupWorking with EffectsReal-Time Audio Analyzation & Audio VisualizationOffline Audio Visualization & AnalyzationOptimizing Performance in PatchesTools for debugging your patchHow to optimize cables patches with the Performance opHow to optimize cables patches with the ProfilerCommon pitfalls with the "usual suspects"Optimizing arraysDebugging Shaders with ShaderInfoFAQAudio in web browsersEmbeddingHow 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 tippsHow to run exported patches on your local machineTransparent CanvasFeatures and SupportHow to contribute code to cablesWill there be support for (animated) GIFs?Screenshots and Video recordingHow to report a bug in cableshow can I support cables?Video playback in cablesGeneral questionsLicenses and paymentWhat license do i need to use cables?Will I have to pay for it in the future?How is my work licensed when using cables?Does cables support midi and OSC?My User Profile & Social MediaShadertoyTechnical questionsGuide to VR in cablesWebGL1 and WebGL2

Creating Viz Ops

Viz Ops can be used to easily visualize things in the patchfield.

You can use the canvas drawing API to draw things in the patchfield.

There is quite a variety of Viz Ops in cables already, take a look

To make any of your ops a Viz Ops, you have to implement the function renderVizLayer:

Parameters:

  • ctx is the 2d drawing context
  • layer contains information about the current op size, scale and positioning. For example:
op.renderVizLayer = (ctx, layer) =>
{
};

If exists, this function will be called whenever an update is needed.

Properties of layer:

x,y is your topleft corner where you start drawing.
width,height is the size of the canvas of your op.

{
    "x":0,
    "y":0,
    "width":200, 
    "height":200 
}

Have a look at this example op: Ops.Templates.ExampleVizOp

const inNum = op.inFloat("Number", 23);
op.setUiAttrib({ "height": 200, "width": 200, "resizable": true });

op.renderVizLayer = (ctx, layer) =>
{
    // clear the canvas in a dark grey color
    ctx.fillStyle = "#222";
    ctx.fillRect(
        layer.x, layer.y,
        layer.width, layer.height);

    const padding = 10;

    ctx.fillStyle = "#05f";

    // draw a circle with a radius of the height of our op canvas
    let circle = new Path2D();
    circle.arc(layer.x + layer.height / 2, layer.y + layer.height / 2, layer.height/2, 0, 2 * Math.PI, false);
    ctx.fill(circle);

    // draw text, use layer height for fontsize, so it is fixed when resizing the op or zooming the patch
    ctx.fillStyle = "#fff";
    const fontSize = layer.height * 0.7;
    ctx.font = "normal " + fontSize + "px sourceCodePro";
    ctx.fillText(Math.round(inNum.get() * 10000) / 10000, layer.x + padding, layer.y + fontSize);

    // this text will not scale and be at fixed size when zooming in/out
    ctx.font = "normal " + 12 + "px sourceCodePro";
    ctx.fillText(Math.round(inNum.get() * 10000) / 10000, layer.x + padding, layer.y+20);


};

For more information on how to write your own ops, start with this part of the docs.


help cables get better and edit this file on github