From TouchDesigner Documentation
Jump to: navigation, search


This embeds a file inside a component so you don't have to refer to, or depend on external files in your project - they can all be embedded in the .toe or a .tox.

It will of course make your .toe or .tox file larger. Two 1 Meg images that are embedded will make your.toe file 2 Meg larger.

Change the Source File parameter and press Create Virtual File. That will replace the virtual file held in this node with your new one.

You can access the virtual file with a File In TOP like Movie File In TOP or Audio File In TOP using the vfs: syntax that you see in out1 DAT. and

When using the virtual file, to specify the path, use which ever is convenient in the File parameter of the OP that will read the virtual file:

Get from the out1 DAT:


or if you create a Null DAT outside this component:


or you can use the read-only Virtual Path parameter on this component:


You can copy/paste this component anywhere and it will contain the file contents in the component and in its .tox, even if you remove the original file.

You generally don't need to press the List Virtual File parameter or the Remove Virtual File parameter as everything is automatically updated when you press Create Virtual File.

This component has a tag 'vfs' and a Parent Shortcut 'vfs' so you can locate all the virtual files in a project.

This is set up to hold one file per virtualFile component, though you can hack this to hold more with the Tscript vfs command. Not sure why you would.

PythonIcon.pngPalette:virtualFile Ext

Parameters - VFS Page

Help Help -  

Version Version -  

Source File Filesource -  

Create Virtual File Create -  

List Virtual File List -  

Remove Virtual File Remove -  

Virtual Path Virtualpath -  

Operator Outputs

  • Output 0 -
  • Output 1 -

Palette • Palette:arcBallCamera • Palette:arcBallGeometry • Palette:audioAnalysis • Palette:audioSet • Palette:battery • Palette:blendModes • Palette:bloom • Palette:cameraBrowser • Palette:camSchnappr • Palette:changeColor • Palette:changeToColor • Palette:checker • Palette:chromaKey • Palette:colorThreshold • Palette:compareComp • Palette:convolve • Palette:cornerPinSOP • Palette:customAttributes • Palette:dent • Palette:depthExtract • Palette:dilate • Palette:equalizer • Palette:feedback • Palette:feedbackEdge • Palette:geoPanel • Palette:gestureCapture • Palette:graphPlot • Palette:histogram • Palette:hsvBlur • Palette:imageSearch • Palette:julia • Palette:kantanMapper • Palette:kinectCalibration • Palette:kinectPointcloud • Palette:leapPaint • Palette:lightTunnel • Palette:mandelbrot • Palette:mesh • Palette:monochrome • Palette:motionSense • Palette:moviePlayer • Palette:multiLevel • Palette:multiMix • Palette:noise • Palette:onScreenKeyboard • Palette:opticalFlow • Palette:particlesGpu • Palette:pixelate • Palette:pixelRelocator • Palette:pointGenerator • Palette:pointillize • Palette:pointMerge • Palette:pointRender • Palette:pointRepack • Palette:pointTransform • Palette:pointWeight • Palette:popDialog • Palette:probe • Palette:projectorBlend • Palette:pushPins • Palette:puzzle • Palette:radialBlur • Palette:remotePanel • Palette:rgbaBlur • Palette:rgbaDelay • Palette:rgbContrast • Palette:search • Palette:searchReplace • Palette:sharpen • Palette:softenAlpha • Palette:solarize • Palette:sopRender • Palette:stitcher • Palette:stoner • Palette:superFormula • Palette:sweetSpotPreviz • Palette:TDVR • Palette:transitMap • Palette:twirl • Palette:vectorScope • Palette:virtualFile • Palette:waveformMonitor • Palette:webBrowser • Palette:xyScope

TOuch Environment file, the file type used by TouchDesigner to save your project.

TouchDesigner Component file, the file type used to save a Component from TouchDesigner.

An Operator Family that creates, composites and modifies images, and reads/writes images and movies to/from files and the network. TOPs run on the graphics card's GPU.

An Operator Family that manipulates text strings: multi-line text or tables. Multi-line text is often a command Script, but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.

The location of an operator within the TouchDesigner environment, for example, /geo1/torus1, a node called torus1 in a component called geo1. The path / is called Root. To refer instead to a filesystem folder, directory, disk file or http: address, see Folder.

A Parent Shortcut is a parameter on a component that contains a name that you can use anywhere inside the component to refer to that component using the syntax parent.Name, for example parent.Effect.width to obtain panel width.

TouchDesigner's original built-in Command scripting language prior to Python.

Lets you embed files inside a .tox or .toe file. Operators like the Movie File In TOP that read regular files can also read the embedded VFS files using a vfs: syntax.

A built-in panel in TouchDesigner that contains a library of components and media that can be dragged-dropped into a TouchDesigner network.