Most frequently you are setting up the Window COMP
/perform in the default TouchDesigner project.
/perform is the default window for Perform Mode. In the Parameter dialog of the Window component you adjust its settings such as resolution, centering, and which monitor(s) the window will get displayed on.
You then press F1 to go into Perform Mode and operate/display the panel standalone.
Press Esc over a window to close it and go back to Designer Mode.
You can create more Window Components, point them to panels or other Operators like TOPs, adjust their parameters and then pulse the parameter Open as Separate Window to see its effect.
Use the Dialog-> Window Placement Dialog which controls which window COMPs get displayed on startup. All Window COMPS in your project are listed there and you can test them individually.
A window can be fit to a single monitor, or span several monitors.
Attach an Info CHOP to the Window component - it will show you the window's current location and size, and whether the window is actually open.
Parameters - Window Page
winop - Specifies the operator the window will display.
title - Specify the window's title.
Justisy and Offset to...
justifyoffsetto - ⊞ - All the positioning parameters below are done relative to the location you specify here. Your window can span more than the specified 'area', it's just used as the reference for positioning. Note for macOS: When using 'Bounds of all Monitors' you must turn off the 'Displays have separate Spaces' toggle in System Preferences > Desktop & Dock > Mission Control
- Primary Monitor
primarymonitor- The primary monitor which is sometimes referred to as the main display in Windows control panel or the primary display in the NVIDIA control panel.
- Specify Monitor
specifymonitor- Defines the location to be the monitor specified in the Monitor parameter below.
- Bounds of All Monitors
allmonitors- Defines the location to include all monitors. The TaskBar is ignored when using this option.
ignoretaskbar - The Windows taskBar is ignored when this option is 'On'. When off the taskbar is accounted for so position and sizing will not cover it up.
monitor - Specify the monitor index when Area is set to Single Monitor.
justifyh - ⊞ - Aligns the window horizontally with the monitor or bounds of all monitors.
left- Align window so that left edge coincides with left edge of specified area.
center- Align window so that horizontal center coincides with horizontal center of specified area.
right- Align window so that right edge coincides with right edge of specified area.
mouse- Align window so it opens horizontally centered on the mouse cursor.
justifyv - ⊞ - Aligns the window vertically with the monitor or bounds of all monitors.
top- Align window so that top edge coincides with top edge of specified area.
center- Align window so that vertical center coincides with vertical center of specified area.
bottom- Align window so that bottom edge coincides with bottom edge of specified area.
mouse- Align window so it opens vertically centered on the mouse cursor.
winoffset - ⊞ - Horizontal offset applied to window after justifying.
winoffsetx- Horizontal offset applied to window after justifying.
winoffsety- Vertical offset applied to window after justifying.
Shift to Single Monitor
single - This menu has options for shifting the opening window. You can either shift to a single monitor or shift to the monitor the cursor is over when the window opens.
dpiscaling - ⊞ - Options for managing DPI scaling on high DPI monitors. To inspect a monitor's DPI scaling setting, you can use the Monitors DAT and refer to the
native- Uses the full resolution of the monitor's native pixels, regardless of the operating system's display scaling setting for that monitor. ie Display Scale = 1.0
- Use DPI Scale
usedpiscale- Uses the resolution set by the operating system's display scaling setting for that monitor. For example, a 3840x2160 monitor with display scaling set to 2.0 results in an addressable resolution of 1920x1080. On Windows system this would be a Display Scaling setting of 200%.
size - ⊞ - Determines how the size of the window is determined.
- Automatic from Panel COMP/TOP
automatic- Determines the size automatically from the size of the COMP/TOP specified.
- Fill Location
fill- Fills the location specified in the Justify and Offset To... parameter above.
custom- Use the Width and Height parameters below to specify a custom size.
winw - The width of the window when Opening Size parameter is set to Custom.
winh - The height of the window when Opening Size parameter is set to Custom.
Update Settings from Window
update - When the window is open you can reposition and resize it. Clicking this button will then read its current windows settings and apply them to the parameters above.
borders - Controls whether or not the window contains borders and a title bar.
Include Borders in Size
bordersinsize - When 'On' the borders are included in the size of the window.
Always on Top
alwaysontop - Controls whether or not the window always sits atop other floating windows.
cursorvisible - ⊞ - Controls whether or not the cursor remains visible when over this window.
nocursor- The cursor is never visible over the window.
- When Moving
cursoronmove- The cursor will only be visible when moving and for a short period after it stops moving.
alwaysvisible- The cursor will always be visble when over the window.
Close on Escape Key
closeescape - When 'On' pressing the escape key over this window will close it. TIP: Shift-Escape will always close it, whether this parameter is on or off.
Allow Viewer Interaction
interact - Enables interactions with the operator specified in the Window Operator parameter.
allowminimize - Enables the window to be minimized in the taskbar (dock in macOS).
vsyncmode - ⊞ - Controls how the window is updated with regards to V-Sync. Enabled means it will update in sync with the monitors refresh which avoids tearing and lost frames. Disabled means it can update at any point during the refresh which can result in tearing or lost frames. FPS is Half Monitor Rate should be used when doing things such as running a 30fps file on a 60Hz display. This makes each update be shown for exactly 2 refreshes which keeps motion looking smooth.
disabled- Vertical Sync off.
enabled- Vertical Sync on.
- FPS is Half Monitor Rate
halfmonitorrate- This allows you to run your project at 30FPS on a 60Hz monitor, but ensuring every image is shown for exactly 2 refreshes. Without this option an image may be shown for 1 or 3 refreshes, which makes the content look like it is stuttering. Currently this feature is not functional in the 2022.20000+ series of builds, but we hope to bring back this feature when Vulkan adds support for it.
drawwindow - When disabled the window will not update it's contents at all. Useful for processes that arn't doing rendering such as Audio or networking processes, or for when using VR devices.
openglstereo - Turn 'On' when using openGL stereoscopic output.
Right Eye Operator
winrightop - This parameter is enabled when the OpenGL Stereo parameter above is turned on. Specify the Camera COMP used for the right eye here.
Open as Perform Window
performance - Opens this Window COMP in Perform Mode. Any Window COMP can be set as default Perform Window (opens using F1 shortcut) using the Window Placement Dialog. This button allows you to open this Window COMP in Perform Mode without changing what is currently selected as the 'default' Perform Window.
Open as Separate Window
winopen - Opens this Window COMP as its own floating window, not as the Perform Window. Useful for things such as dialog boxes, popups, or testing, but should not be used for putting final rendered content to outputs. Use a single large Perform Window for that instead of separate windows.
winclose - Closes the window, if it's open.
Set as Perform Window
setperform - Permanently changes the Perform Window setting in the Window Placement dialog to this window.
Window Placement Dialog
opendialog - A shortcut to open the Window Placement dialog.
Include in Placement Dialog
includedialog - When 'On' this Window COMP will be displayed in the Window Placement Dialog.
Parameters - Extensions Page
The Extensions parameter page sets the component's python extensions. Please see extensions for more information.
ext0object - A number of class instances that can be attached to the component.
ext0name - Optional name to search by, instead of the instance class name.
ext0promote - Controls whether or not the extensions are visible directly at the component level, or must be accessed through the
.ext member. Example:
reinitextensions - Recompile all extension objects. Normally extension objects are compiled only when they are referenced and their definitions have changed.
Parameters - Common Page
parentshortcut - Specifies a name you can use anywhere inside the component as the path to that component. See Parent Shortcut.
Global OP Shortcut
opshortcut - Specifies a name you can use anywhere at all as the path to that component. See Global OP Shortcut.
iop0shortcut - Specifies a name you can use anywhere inside the component as a path to "Internal OP" below. See Internal Operators.
iop0op - The path to the Internal OP inside this component. See Internal Operators.
opviewer - Select which operator's node viewer to use when the Node View parameter above is set to Operator Viewer.
enablecloning - Control if the OP should be actively cloneing. Turning this off causes this node to stop cloning it's 'Clone Master'.
Enable Cloning Pulse
enablecloningpulse - Instantaneously clone the contents.
clone - Path to a component used as the Master Clone.
Load on Demand
loadondemand - Loads the component into memory only when required. Good to use for components that are not always used in the project.
Enable External .tox
enableexternaltox - When on (default), the external .tox file will be loaded when the .toe starts and the contents of the COMP will match that of the external .tox. This can be turned off to avoid loading from the referenced external .tox on startup if desired (the contents of the COMP are instead loaded from the .toe file). Useful if you wish to have a COMP reference an external .tox but not always load from it unless you specifically push the Re-Init Network parameter button.
Enable External .tox Pulse
enableexternaltoxpulse - This button will re-load from the external
.tox file (if present).
External .tox Path
externaltox - Path to a
.tox file on disk which will source the component's contents upon start of a
.toe. This allows for components to contain networks that can be updated independently. If the
.tox file can not be found, whatever the
.toe file was saved with will be loaded.
Reload Custom Parameters
reloadcustom - When this checkbox is enabled, the values of the component's Custom Parameters are reloaded when the .tox is reloaded. This only affects top-level parameters on the component, all parameters on nodes inside the component are always reloaded with the .tox.
Reload Built-In Parameters
reloadbuiltin - When this checkbox is enabled, the values of the component's built-in parameters are reloaded when the .tox is reloaded. This only affects top-level parameters on the component, all parameters on nodes inside the component are always reloaded with the .tox.
Save Backup of External
savebackup - When this checkbox is enabled, a backup copy of the component specified by the External
.tox parameter is saved in the
.toe file. This backup copy will be used if the External
.tox can not be found. This may happen if the
.tox was renamed, deleted, or the
.toe file is running on another computer that is missing component media.
Sub-Component to Load
subcompname - When loading from an External
.tox file, this option allows you to reach into the
.tox and pull out a COMP and make that the top-level COMP, ignoring everything else in the file (except for the contents of that COMP). For example if a
.tox file named
geo1 as the Sub-Component to Load, will result in
geo1 being loaded in place of the current COMP. If this parameter is blank, it just loads the
.tox file normally using the top level COMP in the file.
Relative File Path Behavior
relpath - ⊞ - Set whether the child file paths within this COMP are relative to the .toe itself or the .tox, or inherit from parent.
- Use Parent's Behavior
inherit- Inherit setting from parent.
- Relative to Project File (.toe)
project- The path, when specified as a relative path, will be relative to the .toe file.
- Relative to External COMP File (.tox)
externaltox- The path, when specified as a relative path, will be relative to the .tox file. When no external COMP file is specified, or when Enable External .tox is not toggled on, this doesn't have any impact.
Info CHOP Channels
Extra Information for the Window COMP can be accessed via an Info CHOP.
Specific Window COMP Info Channels
- winx -
- winy -
- winw -
- winh -
- winopen -
- fill -
- borders -
Common COMP Info Channels
- num_children - Number of children in this component.
Common Operator Info Channels
- total_cooks - Number of times the operator has cooked since the process started.
- cook_time - Duration of the last cook in milliseconds.
- cook_frame - Frame number when this operator was last cooked relative to the component timeline.
- cook_abs_frame - Frame number when this operator was last cooked relative to the absolute time.
- cook_start_time - Time in milliseconds at which the operator started cooking in the frame it was cooked.
- cook_end_time - Time in milliseconds at which the operator finished cooking in the frame it was cooked.
- cooked_this_frame - 1 if operator was cooked this frame.
- warnings - Number of warnings in this operator if any.
- errors - Number of errors in this operator if any.