Difference between revisions of "Text TOP"

From TouchDesigner Documentation
Jump to: navigation, search
(cleaning)
Line 11: Line 11:
 
 
 
[[image:TextTOP.jpg]]
 
[[image:TextTOP.jpg]]
|OPlabel=Text
+
|opLabel=Text
|OPlicense=Non-Commercial
+
|opLicense=Non-Commercial
|OPfamily=TOP
+
|opFamily=TOP
 
|short=The Text TOP displays text strings in an image. It allows for multiple fonts, sizes, colors, borders, character separation and line separation.
 
|short=The Text TOP displays text strings in an image. It allows for multiple fonts, sizes, colors, borders, character separation and line separation.
|OPtype=text
+
|opType=text
|OPfilter=False
+
|opFilter=False
|OPclass=textTOP_Class
+
|opClass=textTOP_Class
 
}}
 
}}
 
{{ParameterPage
 
{{ParameterPage
 
|items=
 
|items=
{{ParPanelRef
+
{{Parameter|parOrder=0
|Parorder=0
+
|parSummary=Specifies a [[Field COMP|Field Component]] to use as the source of the text. The font and style of the text displayed in the Field Component are set using the parameters in the Text TOP.
|Parsummary=Specifies a [[Field COMP|Field Component]] to use as the source of the text. The font and style of the text displayed in the Field Component are set using the parameters in the Text TOP.
+
|parLabel=Field Component
|Parlabel=Field Component
+
|opType=text
|OPtype=text
+
|opFamily=TOP
|OPfamily=TOP
+
|parName=field
|Parname=field
+
|parType=
}}
+
|parReadOnly=
{{ParDatRef
+
|parItems=
|Parorder=1
+
}}
|Parsummary=Specifies a DAT to use for the source of the text. Drag and Drop a DAT onto this field, or manually enter the DAT's path.
+
{{Parameter|parOrder=1
|Parlabel=DAT
+
|parSummary=Specifies a DAT to use for the source of the text. Drag and Drop a DAT onto this field, or manually enter the DAT's path.
|OPtype=text
+
|parLabel=DAT
|OPfamily=TOP
+
|opType=text
|Parname=dat
+
|opFamily=TOP
}}
+
|parName=dat
{{ParInteger
+
|parType=
|Parorder=2
+
|parReadOnly=
|Parsummary=The row number (starting from 0) of the cell, if the DAT is a table.
+
|parItems=
|Parlabel=DAT Row
+
}}
|OPtype=text
+
{{Parameter|parOrder=2
|OPfamily=TOP
+
|parSummary=The row number (starting from 0) of the cell, if the DAT is a table.
|Parname=rowindex
+
|parLabel=DAT Row
}}
+
|opType=text
{{ParInteger
+
|opFamily=TOP
|Parorder=3
+
|parName=rowindex
|Parsummary=The column number of the cell, if the DAT is a table.
+
|parType=
|Parlabel=DAT Col
+
|parReadOnly=
|OPtype=text
+
|parItems=
|OPfamily=TOP
+
}}
|Parname=colindex
+
{{Parameter|parOrder=3
}}
+
|parSummary=The column number of the cell, if the DAT is a table.
{{ParDatRef
+
|parLabel=DAT Col
|Parorder=4
+
|opType=text
|Parsummary=A Table DAT that allows you to specify and position text by pixel, with the lower left corner being at 0, 0.  Column headers must include <code>position1</code> or <code>x</code>, <code>position2</code> or <code>y</code>, and <code>text</code>.  A sample table can be:
+
|opFamily=TOP
 +
|parName=colindex
 +
|parType=
 +
|parReadOnly=
 +
|parItems=
 +
}}
 +
{{Parameter|parOrder=4
 +
|parSummary=A Table DAT that allows you to specify and position text by pixel, with the lower left corner being at 0, 0.  Column headers must include <code>position1</code> or <code>x</code>, <code>position2</code> or <code>y</code>, and <code>text</code>.  A sample table can be:
 
 
 
  x y text
 
  x y text
 
  0 0 lower left text
 
  0 0 lower left text
 
  100 100 somewhere in the middle
 
  100 100 somewhere in the middle
|Parlabel=Specification DAT
+
|parLabel=Specification DAT
|OPtype=text
+
|opType=text
|OPfamily=TOP
+
|opFamily=TOP
|Parname=specdat
+
|parName=specdat
}}
+
|parType=
{{ParString
+
|parReadOnly=
|Parorder=5
+
|parItems=
|Parsummary=A string of text. It optionally can be followed by a numeric value and another post-string, as set with <span class="tipTextTOP">Value</span> and <span class="tipTextTOP">Post Text</span> below. If you want to display the characters <code>\ [ ] { }</code>, you must precede them with a <code>\</code>. If 'Legacy Parsing' is off you do not need to escape these characters.'''
+
}}
|Parlabel=Text
+
{{Parameter|parOrder=5
|OPtype=text
+
|parSummary=A string of text. It optionally can be followed by a numeric value and another post-string, as set with <span class="tipTextTOP">Value</span> and <span class="tipTextTOP">Post Text</span> below. If you want to display the characters <code>\ [ ] { }</code>, you must precede them with a <code>\</code>. If 'Legacy Parsing' is off you do not need to escape these characters.'''
|OPfamily=TOP
+
|parLabel=Text
|Parname=text
+
|opType=text
}}
+
|opFamily=TOP
{{ParToggle
+
|parName=text
|Parorder=6
+
|parType=
|Parsummary=In older builds the syntax \XXX (E.g \200 would be character 200), \t, \n as well as [] and {} (to position strings) was parsed in the string. This is now deprecated. For specifying characters codes, \t and \n [https://docs.python.org/3.3/howto/unicode.html Python syntax should be used instead.]. The 'Specification DAT' should be used to position strings instead of [], {}. This parameter can be enabled to turn back on this legacy parsing though.
+
|parReadOnly=
|Parlabel=Legacy Parsing
+
|parItems=
|OPtype=text
+
}}
|OPfamily=TOP
+
{{Parameter|parOrder=6
|Parname=legacyparsing
+
|parSummary=In older builds the syntax \XXX (E.g \200 would be character 200), \t, \n as well as [] and {} (to position strings) was parsed in the string. This is now deprecated. For specifying characters codes, \t and \n [https://docs.python.org/3.3/howto/unicode.html Python syntax should be used instead.]. The 'Specification DAT' should be used to position strings instead of [], {}. This parameter can be enabled to turn back on this legacy parsing though.
}}
+
|parLabel=Legacy Parsing
{{ParToggle
+
|opType=text
|Parorder=7
+
|opFamily=TOP
|Parsummary=Enables the <span class="tipTextTOP">Value</span> field defined below. This value is inserted between the <span class="tipTextTOP">Text</span> string and the <span class="tipTextTOP">Post Text</span> string.
+
|parName=legacyparsing
|Parlabel=Append Value
+
|parType=
|OPtype=text
+
|parReadOnly=
|OPfamily=TOP
+
|parItems=
|Parname=appendvalue
+
}}
}}
+
{{Parameter|parOrder=7
{{ParFloat
+
|parSummary=Enables the <span class="tipTextTOP">Value</span> field defined below. This value is inserted between the <span class="tipTextTOP">Text</span> string and the <span class="tipTextTOP">Post Text</span> string.
|Parorder=8
+
|parLabel=Append Value
|Parsummary=The numeric value to display.
+
|opType=text
|Parlabel=Value
+
|opFamily=TOP
|OPtype=text
+
|parName=appendvalue
|OPfamily=TOP
+
|parType=
|Parname=valuetouse
+
|parReadOnly=
}}
+
|parItems=
{{ParInteger
+
}}
|Parorder=9
+
{{Parameter|parOrder=8
|Parsummary=The total number of digits in the value displayed.
+
|parSummary=The numeric value to display.
|Parlabel=Total Digits
+
|parLabel=Value
|OPtype=text
+
|opType=text
|OPfamily=TOP
+
|opFamily=TOP
|Parname=totaldigits
+
|parName=valuetouse
}}
+
|parType=
{{ParInteger
+
|parReadOnly=
|Parorder=10
+
|parItems=
|Parsummary=The number of digits displayed after the decimal place.
+
}}
|Parlabel=Decimal Digits
+
{{Parameter|parOrder=9
|OPtype=text
+
|parSummary=The total number of digits in the value displayed.
|OPfamily=TOP
+
|parLabel=Total Digits
|Parname=decimaldigits
+
|opType=text
}}
+
|opFamily=TOP
{{ParString
+
|parName=totaldigits
|Parorder=11
+
|parType=
|Parsummary=The text string appended after Text and Value (if present).
+
|parReadOnly=
|Parlabel=Post Text
+
|parItems=
|OPtype=text
+
}}
|OPfamily=TOP
+
{{Parameter|parOrder=10
|Parname=posttext
+
|parSummary=The number of digits displayed after the decimal place.
}}
+
|parLabel=Decimal Digits
{{ParToggle
+
|opType=text
|Parorder=12
+
|opFamily=TOP
|Parsummary=
+
|parName=decimaldigits
|Parlabel=CHOP Value %-Replace
+
|parType=
|OPtype=text
+
|parReadOnly=
|OPfamily=TOP
+
|parItems=
|Parname=chopvaluereplace
+
}}
}}
+
{{Parameter|parOrder=11
{{ParChopRef
+
|parSummary=The text string appended after Text and Value (if present).
|Parorder=13
+
|parLabel=Post Text
|Parsummary=The CHOP containing all the values to insert in the <span class="tipTextTOP">Text</span> strings. The Text TOP will repeat the Text string until all CHOP channels are displayed. They are displayed by using a special syntax in your <span class="tipTextTOP">Text</span> string, defined as string starting with <code>%</code>, for example <code>%4d</code>:
+
|opType=text
 +
|opFamily=TOP
 +
|parName=posttext
 +
|parType=
 +
|parReadOnly=
 +
|parItems=
 +
}}
 +
{{Parameter|parOrder=12
 +
|parSummary=
 +
|parLabel=CHOP Value %-Replace
 +
|opType=text
 +
|opFamily=TOP
 +
|parName=chopvaluereplace
 +
|parType=
 +
|parReadOnly=
 +
|parItems=}}
 +
{{Parameter|parOrder=13
 +
|parSummary=The CHOP containing all the values to insert in the <span class="tipTextTOP">Text</span> strings. The Text TOP will repeat the Text string until all CHOP channels are displayed. They are displayed by using a special syntax in your <span class="tipTextTOP">Text</span> string, defined as string starting with <code>%</code>, for example <code>%4d</code>:
 
 
 
<blockquote>
 
<blockquote>
Line 149: Line 173:
 
 
 
[[image:TextTOPCHOPValue.jpg]]
 
[[image:TextTOPCHOPValue.jpg]]
|Parlabel=CHOP
+
|parLabel=CHOP
|OPtype=text
+
|opType=text
|OPfamily=TOP
+
|opFamily=TOP
|Parname=chop
+
|parName=chop
}}
+
|parType=
{{ParToggle
+
|parReadOnly=
|Parorder=14
+
|parItems=}}
|Parsummary=If there is an input into the Text TOP, the text is composited over the input image using an Over operation.
+
{{Parameter|parOrder=14
|Parlabel=Comp Over Input
+
|parSummary=If there is an input into the Text TOP, the text is composited over the input image using an Over operation.
|OPtype=text
+
|parLabel=Comp Over Input
|OPfamily=TOP
+
|opType=text
|Parname=compoverinput
+
|opFamily=TOP
}}
+
|parName=compoverinput
{{ParToggle
+
|parType=
|Parorder=15
+
|parReadOnly=
|Parsummary=When checked text is automatically line wrapped so it doesn't extend outside the TOP's borders.  When using Word Wrap and Auto-Size together, the text will first word-wrap based on the specified font size, then auto size the resulting block of text.
+
|parItems=
|Parlabel=Word Wrap
+
}}
|OPtype=text
+
{{Parameter|parOrder=15
|OPfamily=TOP
+
|parSummary=When checked text is automatically line wrapped so it doesn't extend outside the TOP's borders.  When using Word Wrap and Auto-Size together, the text will first word-wrap based on the specified font size, then auto size the resulting block of text.
|Parname=wordwrap
+
|parLabel=Word Wrap
}}
+
|opType=text
 +
|opFamily=TOP
 +
|parName=wordwrap
 +
|parType=
 +
|parReadOnly=
 +
|parItems=
 +
}}
 
 
|Pagename=Text
+
|pageName=Text
|Pagesummary=
+
|pageSummary=
|OPfamily=TOP
+
|opFamily=TOP
 
}}
 
}}
 
{{ParameterPage
 
{{ParameterPage
 
|items=
 
|items=
{{ParDynamicMenu
+
{{Parameter|parOrder=0
|Parorder=0
+
|parSummary=Select the font for the text from this drop down menu. All fonts are provided by Windows, any [http://en.wikipedia.org/wiki/TrueType TrueType] font that is loaded into Windows can be used.
|Parsummary=Select the font for the text from this drop down menu. All fonts are provided by Windows, any [http://en.wikipedia.org/wiki/TrueType TrueType] font that is loaded into Windows can be used.
+
|parLabel=Font
|Parlabel=Font
+
|opType=text
|OPtype=text
+
|opFamily=TOP
|OPfamily=TOP
+
|parItems=
|Paritems=
+
|parName=font
|Parname=font
+
|parType=
}}
+
|parReadOnly=
{{ParFilePath
+
}}
|Parorder=1
+
{{Parameter|parOrder=1
|Parsummary=Specify any TrueType font file (<code>.ttf file</code>) to use for the text.  When using a font file, the Font menu above is disabled.
+
|parSummary=Specify any TrueType font file (<code>.ttf file</code>) to use for the text.  When using a font file, the Font menu above is disabled.
|Parlabel=Font File
+
|parLabel=Font File
|OPtype=text
+
|opType=text
|OPfamily=TOP
+
|opFamily=TOP
|Parname=fontfile
+
|parName=fontfile
}}
+
|parType=
{{ParMenu
+
|parReadOnly=
|Parorder=2
+
|parItems=
|Parsummary=Select which character set to use.
+
}}
|Parlabel=Character Set
+
{{Parameter|parOrder=2
|OPtype=text
+
|parSummary=Select which character set to use.
|OPfamily=TOP
+
|parLabel=Character Set
|Paritems=
+
|opType=text
 +
|opFamily=TOP
 +
|parItems=
 
{{Menuitem
 
{{Menuitem
 
|Itemsummary=
 
|Itemsummary=
Line 216: Line 248:
 
}}
 
}}
 
 
|Parname=charset
+
|parName=charset
}}
+
|parType=
{{ParMenu
+
|parReadOnly=
|Parorder=3
+
}}
|Parsummary=The display method used.
+
{{Parameter|parOrder=3
|Parlabel=Display Method
+
|parSummary=The display method used.
|OPtype=text
+
|parLabel=Display Method
|OPfamily=TOP
+
|opType=text
|Paritems=
+
|opFamily=TOP
 +
|parItems=
 
{{Menuitem
 
{{Menuitem
 
|Itemsummary=Automatically chooses which display mode to use based on font size and settings.
 
|Itemsummary=Automatically chooses which display mode to use based on font size and settings.
Line 261: Line 294:
 
}}
 
}}
 
 
|Parname=dispmethod
+
|parName=dispmethod
}}
+
|parType=
{{ParMenu
+
|parReadOnly=
|Parorder=4
+
}}
|Parsummary=Smoothes out the edges of the text. Not available for Texture Display Mode.
+
{{Parameter|parOrder=4
|Parlabel=Anti-Alias
+
|parSummary=Smoothes out the edges of the text. Not available for Texture Display Mode.
|OPtype=text
+
|parLabel=Anti-Alias
|OPfamily=TOP
+
|opType=text
|Paritems=
+
|opFamily=TOP
 +
|parItems=
 
{{Menuitem
 
{{Menuitem
 
|Itemsummary=
 
|Itemsummary=
Line 334: Line 368:
 
}}
 
}}
 
 
|Parname=antialias
+
|parName=antialias
}}
+
|parType=
{{ParInteger
+
|parReadOnly=
|Parorder=5
+
}}
|Parsummary=Controls the width of the outline when using Stroke Display Method.
+
{{Parameter|parOrder=5
|Parlabel=Stroke Width
+
|parSummary=Controls the width of the outline when using Stroke Display Method.
|OPtype=text
+
|parLabel=Stroke Width
|OPfamily=TOP
+
|opType=text
|Parname=strokewidth
+
|opFamily=TOP
}}
+
|parName=strokewidth
{{ParToggle
+
|parType=
|Parorder=6
+
|parReadOnly=
|Parsummary=Displays the text in '''bold'''.
+
|parItems=
|Parlabel=Bold
+
}}
|OPtype=text
+
{{Parameter|parOrder=6
|OPfamily=TOP
+
|parSummary=Displays the text in '''bold'''.
|Parname=bold
+
|parLabel=Bold
}}
+
|opType=text
{{ParToggle
+
|opFamily=TOP
|Parorder=7
+
|parName=bold
|Parsummary=Displays the text in ''Italic''.
+
|parType=
|Parlabel=Italic
+
|parReadOnly=
|OPtype=text
+
|parItems=
|OPfamily=TOP
+
}}
|Parname=italic
+
{{Parameter|parOrder=7
}}
+
|parSummary=Displays the text in ''Italic''.
{{ParMenu
+
|parLabel=Italic
|Parorder=8
+
|opType=text
|Parsummary=Automatically controls font size using one of the following 3 options. '''NOTE:''' Auto-Size Font only work with ''Polygon'', ''Outline'', and ''Texture'' <span class="tipTextTOP">Display Methods</span>.  When using this feature along with Word Wrap turned on, it will first word-wrap the text based on the specified font size, then auto size the resulting block of text.
+
|opFamily=TOP
|Parlabel=Auto-Size Font
+
|parName=italic
|OPtype=text
+
|parType=
|OPfamily=TOP
+
|parReadOnly=
|Paritems=
+
|parItems=
 +
}}
 +
{{Parameter|parOrder=8
 +
|parSummary=Automatically controls font size using one of the following 3 options. '''NOTE:''' Auto-Size Font only work with ''Polygon'', ''Outline'', and ''Texture'' <span class="tipTextTOP">Display Methods</span>.  When using this feature along with Word Wrap turned on, it will first word-wrap the text based on the specified font size, then auto size the resulting block of text.
 +
|parLabel=Auto-Size Font
 +
|opType=text
 +
|opFamily=TOP
 +
|parItems=
 
{{Menuitem
 
{{Menuitem
 
|Itemsummary=Does not use any auto-fitting. Font Size specified in Font Size X and Font Size Y parameters.
 
|Itemsummary=Does not use any auto-fitting. Font Size specified in Font Size X and Font Size Y parameters.
Line 389: Line 430:
 
}}
 
}}
 
 
|Parname=fontautosize
+
|parName=fontautosize
}}
+
|parType=
{{ParFloat
+
|parReadOnly=
|Parorder=9
+
}}
|Parsummary=Sets the font size in X (horizontal). '''Note:''' Floating point font sizes are permissable when using ''Polygon'' and ''Outline'' <span class="tipTextTOP">Display Methods</span>.
+
{{Parameter|parOrder=9
|Parlabel=Font Size X
+
|parSummary=Sets the font size in X (horizontal). '''Note:''' Floating point font sizes are permissable when using ''Polygon'' and ''Outline'' <span class="tipTextTOP">Display Methods</span>.
|OPtype=text
+
|parLabel=Font Size X
|OPfamily=TOP
+
|opType=text
|Parname=fontsizex
+
|opFamily=TOP
}}
+
|parName=fontsizex
{{ParMenu
+
|parType=
|Parorder=10
+
|parReadOnly=
|Parsummary=
+
|parItems=
|Parlabel=Font Size X Unit
+
}}
|OPtype=text
+
{{Parameter|parOrder=10
|OPfamily=TOP
+
|parSummary=
|Paritems=
+
|parLabel=Font Size X Unit
|Parname=fontsizexunit
+
|opType=text
}}
+
|opFamily=TOP
{{ParFloat
+
|parItems=
|Parorder=11
+
|parName=fontsizexunit
|Parsummary=Sets the font size in Y (vertical). '''Note:''' Floating point font sizes are permissable when using ''Polygon'' and ''Outline'' <span class="tipTextTOP">Display Methods</span>.
+
|parType=
|Parlabel=Font Size Y
+
|parReadOnly=}}
|OPtype=text
+
{{Parameter|parOrder=11
|OPfamily=TOP
+
|parSummary=Sets the font size in Y (vertical). '''Note:''' Floating point font sizes are permissable when using ''Polygon'' and ''Outline'' <span class="tipTextTOP">Display Methods</span>.
|Parname=fontsizey
+
|parLabel=Font Size Y
}}
+
|opType=text
{{ParMenu
+
|opFamily=TOP
|Parorder=12
+
|parName=fontsizey
|Parsummary=
+
|parType=
|Parlabel=Font Size Y Unit
+
|parReadOnly=
|OPtype=text
+
|parItems=
|OPfamily=TOP
+
}}
|Paritems=
+
{{Parameter|parOrder=12
|Parname=fontsizeyunit
+
|parSummary=
}}
+
|parLabel=Font Size Y Unit
{{ParToggle
+
|opType=text
|Parorder=13
+
|opFamily=TOP
|Parsummary=Ignores Y value in Font Size. Sets both X and Y size to <span class="tipTextTOP">Font Size</span> X.
+
|parItems=
|Parlabel=Keep Font Ratio
+
|parName=fontsizeyunit
|OPtype=text
+
|parType=
|OPfamily=TOP
+
|parReadOnly=}}
|Parname=keepfontratio
+
{{Parameter|parOrder=13
}}
+
|parSummary=Ignores Y value in Font Size. Sets both X and Y size to <span class="tipTextTOP">Font Size</span> X.
{{ParString
+
|parLabel=Keep Font Ratio
|Parorder=14
+
|opType=text
|Parsummary=Language type hint to help format the glyphs correctly. This should be a abbreviation from the [[Text TOP/SOP Unicode Language Abbreviations]] table.
+
|opFamily=TOP
|Parlabel=Language
+
|parName=keepfontratio
|OPtype=text
+
|parType=
|OPfamily=TOP
+
|parReadOnly=
|Parname=language
+
|parItems=
}}
+
}}
{{ParMenu
+
{{Parameter|parOrder=14
|Parorder=15
+
|parSummary=Language type hint to help format the glyphs correctly. This should be a abbreviation from the [[Text TOP/SOP Unicode Language Abbreviations]] table.
|Parsummary=Use to set whether the language reads Left to Right or Right to Left.
+
|parLabel=Language
|Parlabel=Reading Direction
+
|opType=text
|OPtype=text
+
|opFamily=TOP
|OPfamily=TOP
+
|parName=language
|Paritems=
+
|parType=
 +
|parReadOnly=
 +
|parItems=
 +
}}
 +
{{Parameter|parOrder=15
 +
|parSummary=Use to set whether the language reads Left to Right or Right to Left.
 +
|parLabel=Reading Direction
 +
|opType=text
 +
|opFamily=TOP
 +
|parItems=
 
{{Menuitem
 
{{Menuitem
 
|Itemsummary=
 
|Itemsummary=
Line 463: Line 513:
 
}}
 
}}
 
 
|Parname=readingdirection
+
|parName=readingdirection
}}
+
|parType=
{{ParFloat
+
|parReadOnly=
|Parorder=16
+
}}
|Parsummary=The amount of space to add between letters in X and Y. Kerning is way of adding an arbitrary offset between letters. There already is a default offset associated with each font so the letters are flush against each other. The <span class="tipTextTOP">Kerning</span> parameter this adds to that and allows for a Y offset.
+
{{Parameter|parOrder=16
|Parlabel=Kerning
+
|parSummary=The amount of space to add between letters in X and Y. Kerning is way of adding an arbitrary offset between letters. There already is a default offset associated with each font so the letters are flush against each other. The <span class="tipTextTOP">Kerning</span> parameter this adds to that and allows for a Y offset.
|OPtype=text
+
|parLabel=Kerning
|OPfamily=TOP
+
|opType=text
|Paritems=
+
|opFamily=TOP
 +
|parItems=
 
{{floatitem
 
{{floatitem
 
|Itemsummary=
 
|Itemsummary=
Line 487: Line 538:
 
}}
 
}}
 
 
|Parname=kerning
+
|parName=kerning
}}
+
|parType=
{{ParFloat
+
|parReadOnly=
|Parorder=17
+
}}
|Parsummary=The starting position of the text in X and Y.
+
{{Parameter|parOrder=17
 +
|parSummary=The starting position of the text in X and Y.
 
 
 
<span class="tipTextTOP">TIP:</span> Inside the Text and Post Text fields the position can be overridden by using brackets.
 
<span class="tipTextTOP">TIP:</span> Inside the Text and Post Text fields the position can be overridden by using brackets.
Line 498: Line 550:
 
* '''{X,Y}''' - <code>"bleh{(+/-)x,(+/-)y}newtext"</code> will offset ''newtext'' x,y from current position.
 
* '''{X,Y}''' - <code>"bleh{(+/-)x,(+/-)y}newtext"</code> will offset ''newtext'' x,y from current position.
 
* '''\n''' - using <code>"\n"</code> causes the text to move down to the next line and reset its position. (i.e. New Line and Carriage Return)
 
* '''\n''' - using <code>"\n"</code> causes the text to move down to the next line and reset its position. (i.e. New Line and Carriage Return)
|Parlabel=Position
+
|parLabel=Position
|OPtype=text
+
|opType=text
|OPfamily=TOP
+
|opFamily=TOP
|Paritems=
+
|parItems=
 
{{joinpair floatitem
 
{{joinpair floatitem
 
|Itemsummary=
 
|Itemsummary=
Line 517: Line 569:
 
}}
 
}}
 
 
|Parname=position
+
|parName=position
}}
+
|parType=
{{ParMenu
+
|parReadOnly=}}
|Parorder=18
+
{{Parameter|parOrder=18
|Parsummary=
+
|parSummary=
|Parlabel=Position Unit
+
|parLabel=Position Unit
|OPtype=text
+
|opType=text
|OPfamily=TOP
+
|opFamily=TOP
|Paritems=
+
|parItems=
|Parname=positionunit
+
|parName=positionunit
}}
+
|parType=
{{ParFloat
+
|parReadOnly=}}
|Parorder=19
+
{{Parameter|parOrder=19
|Parsummary=Determines the amount of space between lines of text.
+
|parSummary=Determines the amount of space between lines of text.
|Parlabel=Line Spacing
+
|parLabel=Line Spacing
|OPtype=text
+
|opType=text
|OPfamily=TOP
+
|opFamily=TOP
|Parname=linespacing
+
|parName=linespacing
}}
+
|parType=
{{ParMenu
+
|parReadOnly=
|Parorder=20
+
|parItems=
|Parsummary=
+
}}
|Parlabel=Line Spacing Unit
+
{{Parameter|parOrder=20
|OPtype=text
+
|parSummary=
|OPfamily=TOP
+
|parLabel=Line Spacing Unit
|Paritems=
+
|opType=text
|Parname=linespacingunit
+
|opFamily=TOP
}}
+
|parItems=
{{ParMenu
+
|parName=linespacingunit
|Parorder=21
+
|parType=
|Parsummary=Sets the horizontal alignment.
+
|parReadOnly=}}
|Parlabel=Horizontal Align
+
{{Parameter|parOrder=21
|OPtype=text
+
|parSummary=Sets the horizontal alignment.
|OPfamily=TOP
+
|parLabel=Horizontal Align
|Paritems=
+
|opType=text
 +
|opFamily=TOP
 +
|parItems=
 
{{Menuitem
 
{{Menuitem
 
|Itemsummary=Left justifies the text.
 
|Itemsummary=Left justifies the text.
Line 574: Line 628:
 
}}
 
}}
 
 
|Parname=alignx
+
|parName=alignx
}}
+
|parType=
{{ParMenu
+
|parReadOnly=
|Parorder=22
+
}}
|Parsummary=Sets the vertical alignment.
+
{{Parameter|parOrder=22
|Parlabel=Vertical Align
+
|parSummary=Sets the vertical alignment.
|OPtype=text
+
|parLabel=Vertical Align
|OPfamily=TOP
+
|opType=text
|Paritems=
+
|opFamily=TOP
 +
|parItems=
 
{{Menuitem
 
{{Menuitem
 
|Itemsummary=Bottom justifies the text.
 
|Itemsummary=Bottom justifies the text.
Line 605: Line 660:
 
}}
 
}}
 
 
|Parname=aligny
+
|parName=aligny
}}
+
|parType=
{{ParFloat
+
|parReadOnly=
|Parorder=23
+
}}
|Parsummary=When using <span class="tipTextTOP">Auto-Size Font</span>, it will further shrink the text to give it a border.
+
{{Parameter|parOrder=23
|Parlabel=Border Space
+
|parSummary=When using <span class="tipTextTOP">Auto-Size Font</span>, it will further shrink the text to give it a border.
|OPtype=text
+
|parLabel=Border Space
|OPfamily=TOP
+
|opType=text
|Paritems=
+
|opFamily=TOP
 +
|parItems=
 
{{floatitem
 
{{floatitem
 
|Itemsummary=
 
|Itemsummary=
Line 629: Line 685:
 
}}
 
}}
 
 
|Parname=borderspace
+
|parName=borderspace
}}
+
|parType=
 +
|parReadOnly=
 +
}}
 
 
|Pagename=Font
+
|pageName=Font
|Pagesummary=
+
|pageSummary=
|OPfamily=TOP
+
|opFamily=TOP
 
}}
 
}}
 
{{ParameterPage
 
{{ParameterPage
 
|items=
 
|items=
{{ParToggle
+
{{Parameter|parOrder=0
|Parorder=0
+
|parSummary=Multiplies the RGB channels by the alpha channel.
|Parsummary=Multiplies the RGB channels by the alpha channel.
+
|parLabel=Multiply RGB by Alpha
|Parlabel=Multiply RGB by Alpha
+
|opType=text
|OPtype=text
+
|opFamily=TOP
|OPfamily=TOP
+
|parName=multrgbbyalpha
|Parname=multrgbbyalpha
+
|parType=
}}
+
|parReadOnly=
{{ParRGB
+
|parItems=
|Parorder=1
+
}}
|Parsummary=RGBA values for the text displayed. (default: white (1,1,1,1))
+
{{Parameter|parOrder=1
|Parlabel=Font Color
+
|parSummary=RGBA values for the text displayed. (default: white (1,1,1,1))
|OPtype=text
+
|parLabel=Font Color
|OPfamily=TOP
+
|opType=text
|Paritems=
+
|opFamily=TOP
 +
|parItems=
 
{{rgbitem
 
{{rgbitem
 
|Itemsummary=
 
|Itemsummary=
Line 675: Line 734:
 
}}
 
}}
 
 
|Parname=fontcolor
+
|parName=fontcolor
}}
+
|parType=
{{ParFloat
+
|parReadOnly=
|Parorder=2
+
}}
|Parsummary=
+
{{Parameter|parOrder=2
|Parlabel=Font Alpha
+
|parSummary=
|OPtype=text
+
|parLabel=Font Alpha
|OPfamily=TOP
+
|opType=text
|Parname=fontalpha
+
|opFamily=TOP
}}
+
|parName=fontalpha
{{ParRGB
+
|parType=
|Parorder=3
+
|parReadOnly=
|Parsummary=RGBA values for the background. (default: black (0,0,0,0))
+
|parItems=}}
|Parlabel=Background Color
+
{{Parameter|parOrder=3
|OPtype=text
+
|parSummary=RGBA values for the background. (default: black (0,0,0,0))
|OPfamily=TOP
+
|parLabel=Background Color
|Paritems=
+
|opType=text
 +
|opFamily=TOP
 +
|parItems=
 
{{rgbitem
 
{{rgbitem
 
|Itemsummary=
 
|Itemsummary=
Line 714: Line 775:
 
}}
 
}}
 
 
|Parname=bgcolor
+
|parName=bgcolor
}}
+
|parType=
{{ParFloat
+
|parReadOnly=
|Parorder=4
+
}}
|Parsummary=
+
{{Parameter|parOrder=4
|Parlabel=Background Alpha
+
|parSummary=
|OPtype=text
+
|parLabel=Background Alpha
|OPfamily=TOP
+
|opType=text
|Parname=bgalpha
+
|opFamily=TOP
}}
+
|parName=bgalpha
{{ParRGB
+
|parType=
|Parorder=5
+
|parReadOnly=
|Parsummary=RGBA values for border A color.
+
|parItems=}}
|Parlabel=Border A
+
{{Parameter|parOrder=5
|OPtype=text
+
|parSummary=RGBA values for border A color.
|OPfamily=TOP
+
|parLabel=Border A
|Paritems=
+
|opType=text
 +
|opFamily=TOP
 +
|parItems=
 
{{rgbitem
 
{{rgbitem
 
|Itemsummary=
 
|Itemsummary=
Line 753: Line 816:
 
}}
 
}}
 
 
|Parname=bordera
+
|parName=bordera
}}
+
|parType=
{{ParFloat
+
|parReadOnly=
|Parorder=6
+
}}
|Parsummary=
+
{{Parameter|parOrder=6
|Parlabel=Border A Alpha
+
|parSummary=
|OPtype=text
+
|parLabel=Border A Alpha
|OPfamily=TOP
+
|opType=text
|Parname=borderaalpha
+
|opFamily=TOP
}}
+
|parName=borderaalpha
{{ParRGB
+
|parType=
|Parorder=7
+
|parReadOnly=
|Parsummary=RGBA values for border B color.
+
|parItems=}}
|Parlabel=Border B
+
{{Parameter|parOrder=7
|OPtype=text
+
|parSummary=RGBA values for border B color.
|OPfamily=TOP
+
|parLabel=Border B
|Paritems=
+
|opType=text
 +
|opFamily=TOP
 +
|parItems=
 
{{rgbitem
 
{{rgbitem
 
|Itemsummary=
 
|Itemsummary=
Line 792: Line 857:
 
}}
 
}}
 
 
|Parname=borderb
+
|parName=borderb
}}
+
|parType=
{{ParFloat
+
|parReadOnly=
|Parorder=8
+
}}
|Parsummary=
+
{{Parameter|parOrder=8
|Parlabel=Border B Alpha
+
|parSummary=
|OPtype=text
+
|parLabel=Border B Alpha
|OPfamily=TOP
+
|opType=text
|Parname=borderbalpha
+
|opFamily=TOP
}}
+
|parName=borderbalpha
{{ParMenu
+
|parType=
|Parorder=9
+
|parReadOnly=
|Parsummary=What color the 2 left-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
+
|parItems=}}
|Parlabel=Left Border
+
{{Parameter|parOrder=9
|OPtype=text
+
|parSummary=What color the 2 left-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
|OPfamily=TOP
+
|parLabel=Left Border
|Paritems=
+
|opType=text
|Parname=leftborder
+
|opFamily=TOP
}}
+
|parItems=
{{ParMenu
+
|parName=leftborder
|Parorder=10
+
|parType=
|Parsummary=
+
|parReadOnly=
|Parlabel=Left Border Inside
+
}}
|OPtype=text
+
{{Parameter|parOrder=10
|OPfamily=TOP
+
|parSummary=
|Paritems=
+
|parLabel=Left Border Inside
|Parname=leftborderi
+
|opType=text
}}
+
|opFamily=TOP
{{ParMenu
+
|parItems=
|Parorder=11
+
|parName=leftborderi
|Parsummary=What color the 2 right-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
+
|parType=
|Parlabel=Right Border
+
|parReadOnly=}}
|OPtype=text
+
{{Parameter|parOrder=11
|OPfamily=TOP
+
|parSummary=What color the 2 right-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
|Paritems=
+
|parLabel=Right Border
|Parname=rightborder
+
|opType=text
}}
+
|opFamily=TOP
{{ParMenu
+
|parItems=
|Parorder=12
+
|parName=rightborder
|Parsummary=
+
|parType=
|Parlabel=Right Border Inside
+
|parReadOnly=
|OPtype=text
+
}}
|OPfamily=TOP
+
{{Parameter|parOrder=12
|Paritems=
+
|parSummary=
|Parname=rightborderi
+
|parLabel=Right Border Inside
}}
+
|opType=text
{{ParMenu
+
|opFamily=TOP
|Parorder=13
+
|parItems=
|Parsummary=What color the 2 bottom-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
+
|parName=rightborderi
|Parlabel=Bottom Border
+
|parType=
|OPtype=text
+
|parReadOnly=}}
|OPfamily=TOP
+
{{Parameter|parOrder=13
|Paritems=
+
|parSummary=What color the 2 bottom-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
|Parname=bottomborder
+
|parLabel=Bottom Border
}}
+
|opType=text
{{ParMenu
+
|opFamily=TOP
|Parorder=14
+
|parItems=
|Parsummary=
+
|parName=bottomborder
|Parlabel=Bottom Border Inside
+
|parType=
|OPtype=text
+
|parReadOnly=
|OPfamily=TOP
+
}}
|Paritems=
+
{{Parameter|parOrder=14
|Parname=bottomborderi
+
|parSummary=
}}
+
|parLabel=Bottom Border Inside
{{ParMenu
+
|opType=text
|Parorder=15
+
|opFamily=TOP
|Parsummary=What color the 2 top-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
+
|parItems=
|Parlabel=Top Border
+
|parName=bottomborderi
|OPtype=text
+
|parType=
|OPfamily=TOP
+
|parReadOnly=}}
|Paritems=
+
{{Parameter|parOrder=15
|Parname=topborder
+
|parSummary=What color the 2 top-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
}}
+
|parLabel=Top Border
{{ParMenu
+
|opType=text
|Parorder=16
+
|opFamily=TOP
|Parsummary=
+
|parItems=
|Parlabel=Top Border Inside
+
|parName=topborder
|OPtype=text
+
|parType=
|OPfamily=TOP
+
|parReadOnly=
|Paritems=
+
}}
|Parname=topborderi
+
{{Parameter|parOrder=16
}}
+
|parSummary=
 +
|parLabel=Top Border Inside
 +
|opType=text
 +
|opFamily=TOP
 +
|parItems=
 +
|parName=topborderi
 +
|parType=
 +
|parReadOnly=}}
 
 
|Pagename=Color
+
|pageName=Color
|Pagesummary=
+
|pageSummary=
|OPfamily=TOP
+
|opFamily=TOP
 
}}
 
}}
 
{{:TOP Generator Common Page
 
{{:TOP Generator Common Page
 
}}
 
}}
{{History
+
{{InputsPage
 +
|opFamily=TOP
 +
|opInputs={{OPInput
 +
|opFamily=TOP
 +
|inputIndex=0
 +
|inputName=
 +
|inputSummary=
 +
}}
 +
}}{{History
 
}}
 
}}
 
{{TOPNavBox
 
{{TOPNavBox
|OPfamily=TOP
+
|opFamily=TOP
 
}}
 
}}
 
{{#invoke:Category
 
{{#invoke:Category
 
|list|TOPs}}
 
|list|TOPs}}

Revision as of 16:37, 24 January 2019

Summary
[edit]

The Text TOP displays text strings in an image. It allows for multiple fonts, sizes, colors, borders, character separation and line separation. The text can be displayed as bit maps, anti-aliased lines, or filled polygon characters. Any TrueType font that has been loaded into Windows can be rendered by the Text TOP. Unicode is supported.

It can display simple text strings with embedded numeric values. It can also format lines of text and numbers in decimal or floating point format, reading the numbers from a CHOP, using special formatting characters.

Any TrueType or OpenType font that has been loaded into Windows can be rendered by the Text TOP. To import a new font into your Windows system, open the Fonts folder in the Control Panel, then drag and drop your font files in (.ttf/.otf file format). Fonts can also be specified as .ttf/.otf file paths in the Font File parameter.

You can render Unicode text by reading the text as a python string. See Unicode.

See also: Field COMP, Text SOP, Unicode and the Tscript text() expression.

TextTOP.jpg

PythonIcon.pngtextTOP_Class


Parameters - Text Page

Field Component field - Specifies a Field Component to use as the source of the text. The font and style of the text displayed in the Field Component are set using the parameters in the Text TOP.  

DAT dat - Specifies a DAT to use for the source of the text. Drag and Drop a DAT onto this field, or manually enter the DAT's path.  

DAT Row rowindex - The row number (starting from 0) of the cell, if the DAT is a table.  

DAT Col colindex - The column number of the cell, if the DAT is a table.  

Specification DAT specdat - A Table DAT that allows you to specify and position text by pixel, with the lower left corner being at 0, 0. Column headers must include position1 or x, position2 or y, and text. A sample table can be:

x	y	text		
0	0	lower left text		
100	100	somewhere in the middle

 

Text text - A string of text. It optionally can be followed by a numeric value and another post-string, as set with Value and Post Text below. If you want to display the characters \ [ ] { }, you must precede them with a \. If 'Legacy Parsing' is off you do not need to escape these characters.  

Legacy Parsing legacyparsing - In older builds the syntax \XXX (E.g \200 would be character 200), \t, \n as well as [] and {} (to position strings) was parsed in the string. This is now deprecated. For specifying characters codes, \t and \n Python syntax should be used instead.. The 'Specification DAT' should be used to position strings instead of [], {}. This parameter can be enabled to turn back on this legacy parsing though.  

Append Value appendvalue - Enables the Value field defined below. This value is inserted between the Text string and the Post Text string.  

Value valuetouse - The numeric value to display.  

Total Digits totaldigits - The total number of digits in the value displayed.  

Decimal Digits decimaldigits - The number of digits displayed after the decimal place.  

Post Text posttext - The text string appended after Text and Value (if present).  

CHOP Value %-Replace chopvaluereplace -  

CHOP chop - The CHOP containing all the values to insert in the Text strings. The Text TOP will repeat the Text string until all CHOP channels are displayed. They are displayed by using a special syntax in your Text string, defined as string starting with %, for example %4d:

 %[flags][width][.precision][type]

  • flags (optional) - Alignment options.
    • - : left align (text is right aligned by default)
    • 0 : pad the left side with zeros
  • width (optional) - Total number of digits in the number displayed.
  • precision (optional) - Number of digits after the decimal place.
  • type - Number format.
    • d : integer
    • f : float
    • g : double, exponential format is used only when the exponent of the value is less than ?4.

Drag and Drop a CHOP onto this field, or manually enter the CHOP's path.

TextTOPCHOPValue.jpg  

Comp Over Input compoverinput - If there is an input into the Text TOP, the text is composited over the input image using an Over operation.  

Word Wrap wordwrap - When checked text is automatically line wrapped so it doesn't extend outside the TOP's borders. When using Word Wrap and Auto-Size together, the text will first word-wrap based on the specified font size, then auto size the resulting block of text.  


Parameters - Font Page

Font font - Select the font for the text from this drop down menu. All fonts are provided by Windows, any TrueType font that is loaded into Windows can be used.  

Font File fontfile - Specify any TrueType font file (.ttf file) to use for the text. When using a font file, the Font menu above is disabled.  

Character Set charset - - Select which character set to use.

Display Method dispmethod - - The display method used.

Anti-Alias antialias - - Smoothes out the edges of the text. Not available for Texture Display Mode.

Stroke Width strokewidth - Controls the width of the outline when using Stroke Display Method.  

Bold bold - Displays the text in bold.  

Italic italic - Displays the text in Italic.  

Auto-Size Font fontautosize - - Automatically controls font size using one of the following 3 options. NOTE: Auto-Size Font only work with Polygon, Outline, and Texture Display Methods. When using this feature along with Word Wrap turned on, it will first word-wrap the text based on the specified font size, then auto size the resulting block of text.

Font Size X fontsizex - Sets the font size in X (horizontal). Note: Floating point font sizes are permissable when using Polygon and Outline Display Methods.  

Font Size X Unit fontsizexunit -  

Font Size Y fontsizey - Sets the font size in Y (vertical). Note: Floating point font sizes are permissable when using Polygon and Outline Display Methods.  

Font Size Y Unit fontsizeyunit -  

Keep Font Ratio keepfontratio - Ignores Y value in Font Size. Sets both X and Y size to Font Size X.  

Language language - Language type hint to help format the glyphs correctly. This should be a abbreviation from the Text TOP/SOP Unicode Language Abbreviations table.  

Reading Direction readingdirection - - Use to set whether the language reads Left to Right or Right to Left.

Kerning kerning - - The amount of space to add between letters in X and Y. Kerning is way of adding an arbitrary offset between letters. There already is a default offset associated with each font so the letters are flush against each other. The Kerning parameter this adds to that and allows for a Y offset.

Position position - - The starting position of the text in X and Y.

TIP: Inside the Text and Post Text fields the position can be overridden by using brackets.

  • [x,y] - "bleh[x,y]newtext" will place newtext at position (x,y) on the screen.
  • {X,Y} - "bleh{(+/-)x,(+/-)y}newtext" will offset newtext x,y from current position.
  • \n - using "\n" causes the text to move down to the next line and reset its position. (i.e. New Line and Carriage Return)

Position Unit positionunit -  

Line Spacing linespacing - Determines the amount of space between lines of text.  

Line Spacing Unit linespacingunit -  

Horizontal Align alignx - - Sets the horizontal alignment.

Vertical Align aligny - - Sets the vertical alignment.

Border Space borderspace - - When using Auto-Size Font, it will further shrink the text to give it a border.


Parameters - Color Page

Multiply RGB by Alpha multrgbbyalpha - Multiplies the RGB channels by the alpha channel.  

Font Color fontcolor - - RGBA values for the text displayed. (default: white (1,1,1,1))

Font Alpha fontalpha -  

Background Color bgcolor - - RGBA values for the background. (default: black (0,0,0,0))

Background Alpha bgalpha -  

Border A bordera - - RGBA values for border A color.

Border A Alpha borderaalpha -  

Border B borderb - - RGBA values for border B color.

Border B Alpha borderbalpha -  

Left Border leftborder - What color the 2 left-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).  

Left Border Inside leftborderi -  

Right Border rightborder - What color the 2 right-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).  

Right Border Inside rightborderi -  

Bottom Border bottomborder - What color the 2 bottom-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).  

Bottom Border Inside bottomborderi -  

Top Border topborder - What color the 2 top-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).  

Top Border Inside topborderi -  


Parameters - Common Page

Output Resolution outputresolution - - quickly change the resolution of the TOP's data.

  • Use Input useinput - Uses the input's resolution.
  • Eighth eighth - Multiply the input's resolution by that amount.
  • Quarter quarter - Multiply the input's resolution by that amount.
  • Half half - Multiply the input's resolution by that amount.
  • 2X 2x - Multiply the input's resolution by that amount.
  • 4X 4x - Multiply the input's resolution by that amount.
  • 8X 8x - Multiply the input's resolution by that amount.
  • Fit Resolution fit - Grow or shrink the input resolution to fit this resolution, while keeping the aspect ratio the same.
  • Limit Resolution limit - Limit the input resolution to be not larger than this resolution, while keeping the aspect ratio the same.
  • Custom Resolution custom - Directly control the width and height.

Resolution resolution - - Enabled only when the Resolution parameter is set to Custom Resolution. Some Generators like Constant and Ramp do not use inputs and only use this field to determine their size. The drop down menu on the right provides some commonly used resolutions.

  • W resolutionw -
  • H resolutionh -

Resolution Menu resmenu - A drop-down menu with some commonly used resolutions.  

Use Global Res Multiplier resmult - Uses the Global Resolution Multiplier found in Edit>Preferences>TOPs. This multiplies all the TOPs resolutions by the set amount. This is handy when working on computers with different hardware specifications. If a project is designed on a desktop workstation with lots of graphics memory, a user on a laptop with only 64MB VRAM can set the Global Resolution Multiplier to a value of half or quarter so it runs at an acceptable speed. By checking this checkbox on, this TOP is affected by the global multiplier.  

Output Aspect outputaspect - - Sets the image aspect ratio allowing any textures to be viewed in any size. Watch for unexpected results when compositing TOPs with different aspect ratios. (You can define images with non-square pixels using xres, yres, aspectx, aspecty where xres/yres != aspectx/aspecty.)

  • Use Input useinput - Uses the input's aspect ratio.
  • Resolution resolution - Uses the aspect of the image's defined resolution (ie 512x256 would be 2:1), whereby each pixel is square.
  • Custom Aspect custom - Lets you explicitly define a custom aspect ratio in the Aspect parameter below.

Aspect aspect - - Use when Output Aspect parameter is set to Custom Aspect.

  • Aspect1 aspect1 -
  • Aspect2 aspect2 -

Aspect Menu armenu - A drop-down menu with some commonly used aspect ratios.  

Input Smoothness inputfiltertype - - This controls pixel filtering on the input image of the TOP.

  • Nearest Pixel nearest - Uses nearest pixel or accurate image representation. Images will look jaggy when viewing at any zoom level other than Native Resolution.
  • Interpolate Pixels linear - Uses linear filtering between pixels. This is how you get TOP images in viewers to look good at various zoom levels, especially useful when using any Fill Viewer setting other than Native Resolution.
  • Mipmap Pixels mipmap - Uses mipmap filtering when scaling images. This can be used to reduce artifacts and sparkling in moving/scaling images that have lots of detail.

Fill Viewer fillmode - - Determine how the TOP image is displayed in the viewer. NOTE:To get an understanding of how TOPs work with images, you will want to set this to Native Resolution as you lay down TOPs when starting out. This will let you see what is actually happening without any automatic viewer resizing.

  • Use Input useinput - Uses the same Fill Viewer settings as it's input.
  • Fill fill - Stretches the image to fit the edges of the viewer.
  • Fit Horizontal width - Stretches image to fit viewer horizontally.
  • Fit Vertical height - Stretches image to fit viewer vertically.
  • Fit Best best - Stretches or squashes image so no part of image is cropped.
  • Fit Outside outside - Stretches or squashes image so image fills viewer while constraining it's proportions. This often leads to part of image getting cropped by viewer.
  • Native Resolution nativeres - Displays the native resolution of the image in the viewer.

Viewer Smoothness filtertype - - This controls pixel filtering in the viewers.

  • Nearest Pixel nearest - Uses nearest pixel or accurate image representation. Images will look jaggy when viewing at any zoom level other than Native Resolution.
  • Interpolate Pixels linear - Uses linear filtering between pixels. Use this to get TOP images in viewers to look good at various zoom levels, especially useful when using any Fill Viewer setting other than Native Resolution.
  • Mipmap Pixels mipmap - Uses mipmap filtering when scaling images. This can be used to reduce artifacts and sparkling in moving/scaling images that have lots of detail. When the input is 32-bit float format, only nearest filtering will be used (regardless of what is selected).

Passes npasses - Duplicates the operation of the TOP the specified number of times. For every pass after the first it takes the result of the previous pass and replaces the node's first input with the result of the previous pass. One exception to this is the GLSL TOP when using compute shaders, where the input will continue to be the connected TOP's image.  

Channel Mask chanmask - Allows you to choose which channels (R, G, B, or A) the TOP will operate on. All channels are selected by default.  

Pixel Format format - - Format used to store data for each channel in the image (ie. R, G, B, and A). Refer to Pixel Formats for more information.

  • Use Input useinput - Uses the input's pixel format.
  • 8-bit fixed (RGBA) rgba8fixed - Uses 8-bit integer values for each channel.
  • sRGB 8-bit fixed (RGBA) srgba8fixed - Uses 8-bit integer values for each channel and stores color in sRGB colorspace. Note that this does not apply an sRGB curve to the pixel values, it only stores them using an sRGB curve. This means more data is used for the darker values and less for the brighter values. When the values are read downstream they will be converted back to linear. For more information refer to sRGB.
  • 16-bit float (RGBA) rgba16float - Uses 16-bits per color channel, 64-bits per pixel.
  • 32-bit float (RGBA) rgba32float - Uses 32-bits per color channel, 128-bits per pixels.
  • 10-bit RGB, 2-bit Alpha, fixed (RGBA) rgb10a2fixed - Uses 10-bits per color channel and 2-bits for alpha, 32-bits total per pixel.
  • 16-bit fixed (RGBA) rgba16fixed - Uses 16-bits per color channel, 64-bits total per pixel.
  • 11-bit float (RGB), Positive Values Only rgba11float - A RGB floating point format that has 11 bits for the Red and Green channels, and 10-bits for the Blue Channel, 32-bits total per pixel (therefore the same memory usage as 8-bit RGBA). The Alpha channel in this format will always be 1. Values can go above one, but can't be negative. ie. the range is [0, infinite).
  • 16-bit float (RGB) rgb16float -
  • 32-bit float (RGB) rgb32float -
  • 8-bit fixed (Mono) mono8fixed - Single channel, where RGB will all have the same value, and Alpha will be 1.0. 8-bits per pixel.
  • 16-bit fixed (Mono) mono16fixed - Single channel, where RGB will all have the same value, and Alpha will be 1.0. 16-bits per pixel.
  • 16-bit float (Mono) mono16float - Single channel, where RGB will all have the same value, and Alpha will be 1.0. 16-bits per pixel.
  • 32-bit float (Mono) mono32float - Single channel, where RGB will all have the same value, and Alpha will be 1.0. 32-bits per pixel.
  • 8-bit fixed (RG) rg8fixed - A 2 channel format, R and G have values, while B is 0 always and Alpha is 1.0. 8-bits per channel, 16-bits total per pixel.
  • 16-bit fixed (RG) rg16fixed - A 2 channel format, R and G have values, while B is 0 always and Alpha is 1.0. 16-bits per channel, 32-bits total per pixel.
  • 16-bit float (RG) rg16float - A 2 channel format, R and G have values, while B is 0 always and Alpha is 1.0. 16-bits per channel, 32-bits total per pixel.
  • 32-bit float (RG) rg32float - A 2 channel format, R and G have values, while B is 0 always and Alpha is 1.0. 32-bits per channel, 64-bits total per pixel.
  • 8-bit fixed (A) a8fixed - An Alpha only format that has 8-bits per channel, 8-bits per pixel.
  • 16-bit fixed (A) a16fixed - An Alpha only format that has 16-bits per channel, 16-bits per pixel.
  • 16-bit float (A) a16float - An Alpha only format that has 16-bits per channel, 16-bits per pixel.
  • 32-bit float (A) a32float - An Alpha only format that has 32-bits per channel, 32-bits per pixel.
  • 8-bit fixed (Mono+Alpha) monoalpha8fixed - A 2 channel format, one value for RGB and one value for Alpha. 8-bits per channel, 16-bits per pixel.
  • 16-bit fixed (Mono+Alpha) monoalpha16fixed - A 2 channel format, one value for RGB and one value for Alpha. 16-bits per channel, 32-bits per pixel.
  • 16-bit float (Mono+Alpha) monoalpha16float - A 2 channel format, one value for RGB and one value for Alpha. 16-bits per channel, 32-bits per pixel.
  • 32-bit float (Mono+Alpha) monoalpha32float - A 2 channel format, one value for RGB and one value for Alpha. 32-bits per channel, 64-bits per pixel.

Operator Inputs

  • Input 0 -

TouchDesigner Build:

TOPs
Add • Anti Alias • Blob Track • Blur • Buffer Select • Cache Select • Cache • Channel Mix • CHOP to • Chroma Key • Circle • Composite • Constant • Convolve • Corner Pin • CPlusPlus • Crop • Cross • Cube Map • Depth • Difference • DirectX In • DirectX Out • Displace • Edge • Emboss • Feedback • Fit • Flip • Function • GLSL Multi • GLSL • HSV Adjust • HSV to RGB • Import Select • In • Inside • Introduction To TOPs id • Kinect Azure Select • Kinect Azure • Kinect • Layout • Leap Motion • Level • Limit • Lookup • Luma Blur • Luma Level • Math • Matte • Mirror • Monochrome • Movie File In • Movie File Out • Multiply • NDI In • NDI Out • Noise • Normal Map • Notch • Null • Nvidia Flex • Nvidia Flow • Oculus Rift • OP Viewer • OpenColorIO • OpenVR • Ouster Select • Ouster • Out • Outside • Over • Pack • Photoshop In • Point File In • Point File Select • PreFilter Map • Projection • Ramp • RealSense • Rectangle • Remap • Render Pass • Render Select • Render • Reorder • Resolution • RGB Key • RGB to HSV • Scalable Display • Screen Grab • Screen • Select • Shared Mem In • Shared Mem Out • Slope • SSAO • Stype • Substance Select • Substance • Subtract • SVG • Switch • Syphon Spout In • Syphon Spout Out • Text • Texture 3D • Texture Sampling arameters • Threshold • Tile • Time Machine • TOP • TOP iewer • Touch In • Touch Out • Transform • Under • Video Device In • Video Device Out • Video Stream In • Video Stream Out • Vioso • Web Render • ZED

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 which operate on Channels (a series of numbers) which are used for animation, audio, mathematics, simulation, logic, UI construction, and many other applications.

A custom interactive control panel built within TouchDesigner. Panels are created using Panel Components whose look is created entirely with TOPs.

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

An Operator Family that contains its own Network inside. There are twelve 3D Object Component and eight 2D Panel Component types. See also Network Path.

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.

A form of DATs (Data Operators) that is structured as rows and columns of text strings.

The width and height of an image in pixels. Most TOPs, like the Movie File In TOP can set the image resolution. See Aspect Ratio for the width/height ratio of an image, taking into account non-square pixels.

The viewer of a node can be (1) the interior of a node (the Node Viewer), (2) a floating window (RMB->View... on node), or (3) a Pane that graphically shows the results of an operator.

A CHOP outputs one or more channels, where a channel is simply a sequence of numbers, representing motion, audio, etc. Channels are passed between CHOPs in TouchDesigner networks. See also Export.