HSV Adjust TOP and Movie File In TOP: Difference between pages

From Derivative
(Difference between pages)
Jump to navigation Jump to search
(TD Editor)
 
(TD Editor)
 
Line 1: Line 1:
{{Summary
{{Summary
|OPclass=hsvadjustTOP_Class
|OPclass=moviefileinTOP_Class
|OPlabel=HSV Adjust
|OPlabel=Movie File In
|OPfamily=TOP
|OPfamily=TOP
|OPlicense=Non-Commercial
|OPlicense=Non-Commercial
|OPtype=hsvadj
|OPtype=moviefilein
|OPfilter=True
|OPfilter=False
|long=The HSV Adjust TOP adjust color values using hue, saturation, and value controls. If you change the Hue Offset, Saturation Multiplier and Value Multiplier without changing any of the other parameters then you will modify the color of all pixels in the image. The other parameters are used to narrow the range of pixels you want to modify based on their hue, saturation and value. For example if you leave the Hue Range untouched but reduce the saturation range, you will cause the TOP to modify only pixels who fall into the new saturation range. The range is the Start Color's saturation + the Range + the Falloff, in this example.
|long=The Movie File In TOP loads movies, still images, or a sequence of still images into TOPs. It will read images in <code>.jpg</code>, <code>.gif</code>, <code>.tif</code>, or <code>.bmp</code> format. It will read movies in QuickTime's <code>.mov</code> format, <code>.mp4</code>, <code>.mpg</code>, <code>.mpeg</code>, <code>.avi</code>, <code>.wmv</code>, <code>.dpx</code>, [[Cineform]] and [[Hap]] Q formats (including Hap Q with Alpha).  It also supports some <code>.swf</code> and <code>.flv</code> Flash files as well as DXT1, 3, and 5 compressed <code>.DDS</code> files. Images and movies can also be fetched from the web by using <code>http://</code> to specify a URL.
|short=The HSV Adjust TOP adjust color values using hue, saturation, and value controls.
For a complete list, see [[File Types]].
Examine the state of a Movie File In TOP by attaching an [[Info CHOP]] to it (see below on Info CHOP). This will show static info like movie length, resolution, frames per second, and whether there is audio in the file.  It also shows dynamic information like movie open status, current frame, readahead frames and queue size, dropped frame count, CPU decode time and GPU upload time.
See also [[Cineform]], [[Hap]], [[Movie File Out TOP]], [[Movie Playback]]
|short=The Movie File In TOP loads movies, still images, or a sequence of still images into TOPs.
}}
{{ParameterPage
|Pagesummary=
|Pagename=Play
|OPfamily=TOP
|items=
{{ParFilePath
|Parsummary=The path and name of the image or movie file to load. Image and movie formats are those found in [[File Types]].
To treat a folder of images as if they are one movie, specify the folder containing the images instead of a filename. All the files be the same resolution. It will treat all stills/movies in that folder as if each is a frame in one movie. The order of the images is the alphanumeric. By default the first image has an index of 0, second is 1, etc, regardless of their file names. Overriding the sample rate on the Trim parameter page will let you playback the image sequence at any frame rate. 
Using an <code>info.xml</code> file in the directory containing a sequence of images allows you to specify the frames per second and an audio file to be used with the sequence of images. Example xml file:
  <?xml version="1.0" encoding="ISO-8859-1" standalone="yes" ?>
  <Settings>
      <attributes fps="30.0" />
      <audio filename="audio.wav" />
  </Settings>
URLs can be used to fetch images and movies. The image or movie is downloaded to the user's Derivative temp directory and is read into the Movie File In TOP.
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=0
|Parlabel=File
|Parname=file
}}
{{ParToggle
|Parsummary=Change from 0 to 1 to force the image to reload, useful when the file changes or did not exist at first.
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=1
|Parlabel=Reload
|Parname=reload
}}
{{ParButton
|Parsummary=
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=2
|Parlabel=Reload Pulse
|Parname=reloadpulse
}}
{{ParMenu
|Parorder=3
|OPfamily=TOP
|Paritems=
{{Menuitem
|OPfamily=TOP
|Parname=playmode
|Itemname=locked
|Itemsummary=This mode locks the movie position to the timeline. Scrubbing or jumping in the timeline will change the movie position accordingly. The parameters Play, Reset, Speed, and Index are disabled in this mode since the timeline is directly tied to movie position.
|Itemlabel=Locked to Timeline
}}
{{Menuitem
|OPfamily=TOP
|Parname=playmode
|Itemname=specify
|Itemsummary=This mode allows the user to specify a particular position in the movie using the Index parameter below. Use this mode for random access to any location in the movie.
|Itemlabel=Specify Index
}}
{{Menuitem
|OPfamily=TOP
|Parname=playmode
|Itemname=sequential
|Itemsummary=This mode continually plays regardless of the timeline position (the Index parameter is disabled). Reset and Speed parameters below are enabled to allow some control.
|Itemlabel=Sequential
}}
|Parname=playmode
|OPtype=moviefilein
|Parlabel=Play Mode
|Parsummary=Specifies the method used to play the movie, there are 3 options.
}}
{{ParToggle
|Parsummary=Movie plays when 1, movie stops when 0.
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=4
|Parlabel=Play
|Parname=play
}}
{{ParFloat
|Parsummary=This is a speed multiplier which only works when Play Mode is ''Sequential''. A value of 1 is the default playback speed. A value of 2 is double speed, 0.5 is half speed and so on. Negative values will play the movie backwards.
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=5
|Parlabel=Speed
|Parname=speed
}}
{{ParToggle
|Parsummary=Jumps to Cue Point when set to 1. Only available when Play Mode is Sequential.
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=6
|Parlabel=Cue
|Parname=cue
}}
{{ParButton
|Parsummary=
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=7
|Parlabel=Cue Pulse
|Parname=cuepulse
}}
{{ParFloat
|Parsummary=Set any index in the movie as a point to jump to.
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=8
|Parlabel=Cue Point
|Parname=cuepoint
}}
{{ParMenu
|Parorder=9
|OPfamily=TOP
|Paritems=
|Parname=cuepointunit
|OPtype=moviefilein
|Parlabel=Cue Point Unit
|Parsummary=
}}
{{ParMenu
|Parorder=10
|OPfamily=TOP
|Paritems=
{{Menuitem
|OPfamily=TOP
|Parname=cuebehavior
|Itemname=repeat
|Itemsummary=When releasing the Cue parameter, immediately play the next frame.
|Itemlabel=On Release, Repeat Cued Frame
}}
{{Menuitem
|OPfamily=TOP
|Parname=cuebehavior
|Itemname=play
|Itemsummary=When releasing the Cue parameter, first play the cued frame before continuing to play the next frame.
|Itemlabel=On Release, Play Next Frame
}}
|Parname=cuebehavior
|OPtype=moviefilein
|Parlabel=Cue Behavior
|Parsummary=Customize the Cue parameter's behavior.
}}
{{ParFloat
|Parsummary=This parameter explicitly sets the movie position when Play Mode is set to Specify Index. The units menu on the right lets you specify the index in the following units: Index, Frames, Seconds, and Fraction (percentage). For example, assume you have a movie that internally is 25 fps, and the timeline that is 60 fps. If you set Units to Index and the parameter value to 25, you get the image that is 1 second into the movie. If you set the Units to Frames and set the value to 60 you get the same image at 1 second into the movie.
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=11
|Parlabel=Index
|Parname=index
}}
{{ParMenu
|Parorder=12
|OPfamily=TOP
|Paritems=
|Parname=indexunit
|OPtype=moviefilein
|Parlabel=Index Unit
|Parsummary=
}}
{{ParFloat
|Parsummary=Crossfades the beginning and end of the movie together to create a smooth transition when looping. If the movie uses Trim options, it will crossfade Trim Start with Trim End positions.
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=13
|Parlabel=Loop Crossfade
|Parname=loopcrossfade
}}
{{ParMenu
|Parorder=14
|OPfamily=TOP
|Paritems=
|Parname=loopcrossfadeunit
|OPtype=moviefilein
|Parlabel=Loop Crossfade Unit
|Parsummary=
}}
{{ParInteger
|Parsummary=Sets how many frames to skip before displaying next frame. For example, a StepSize of 30 will display every 30th frame. This timing of movie playback does not change, so with a Step Size of 30 and a sample rate of 30, a new frame will be displayed every second.
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=15
|Parlabel=Step Size
|Parname=stepsize
}}
{{ParMenu
|Parorder=16
|OPfamily=TOP
|Paritems=
{{Menuitem
|OPfamily=TOP
|Parname=audioloop
|Itemname=silence
|Itemsummary=Audio will go silent when movie ends.
|Itemlabel=Silence
}}
{{Menuitem
|OPfamily=TOP
|Parname=audioloop
|Itemname=fade
|Itemsummary=Audio will fade out when movie ends.
|Itemlabel=Fade
}}
{{Menuitem
|OPfamily=TOP
|Parname=audioloop
|Itemname=match
|Itemsummary=
|Itemlabel=Match Start to End
}}
|Parname=audioloop
|OPtype=moviefilein
|Parlabel=Audio Loop
|Parsummary=This menu helps you determine how to treat the audio as the end of a movie approaches. This is needed because of all the cases of playing a movie, like when driving with an index, the TOP will not know if you intend to loop it or not.
}}
{{ParMenu
|Parorder=17
|OPfamily=TOP
|Paritems=
{{Menuitem
|OPfamily=TOP
|Parname=imageindexing
|Itemname=zero
|Itemsummary=Index the sequence of images starting at 0, after sorting them alphanumerically.
|Itemlabel=Zero Based
}}
{{Menuitem
|OPfamily=TOP
|Parname=imageindexing
|Itemname=filename
|Itemsummary= Index the sequence of images using the numbers on the end of the filenames. I.e a file named flower400.tiff will be frame index 400, regardless of if there are other files in the directory before it.
|Itemlabel=Filename Based
}}
|Parname=imageindexing
|OPtype=moviefilein
|Parlabel=Image Sequence Indexing
|Parsummary=Determines how an image sequence is ordered.
}}
}}
}}
{{ParameterPage
{{ParameterPage
|Pagesummary=[[image:HSVadjust.jpg]
|Pagesummary=
|Pagename=HSV Tweak
|Pagename=Image
|OPfamily=TOP
|OPfamily=TOP
|items=
|items=
{{ParRGB
{{ParToggle
|Parsummary=Interpolates between frames based based on exact time. For example, if the index (in frames) is 1.5, then frames 1 and 2 will be blended 50-50. If the index is 1.7 then 30% of frame 1 is blended with 70% of frame 2 and so on.
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=0
|Parorder=0
|Parlabel=Interpolate Frames
|Parname=interp
}}
{{ParMenu
|Parorder=1
|OPfamily=TOP
|Paritems=
{{Menuitem
|OPfamily=TOP
|Parname=deinterlace
|Itemname=off
|Itemsummary=Output the movie images unchanged.
|Itemlabel=Off
}}
{{Menuitem
|OPfamily=TOP
|Parname=deinterlace
|Itemname=even
|Itemsummary=Take only the even scanlines of the file's images and create the odd scanlines by interpolating between the even scanlines. (For historic reasons, scanline 0 is at the top of the images for the purpose of the deinterlacing.)
|Itemlabel=Even
}}
{{Menuitem
|OPfamily=TOP
|Parname=deinterlace
|Itemname=odd
|Itemsummary=
|Itemlabel=Odd
}}
{{Menuitem
|OPfamily=TOP
|Parname=deinterlace
|Itemname=bob
|Itemsummary=
|Itemlabel=Bob (Split)
}}
|Parname=deinterlace
|OPtype=moviefilein
|Parlabel=Deinterlace
|Parsummary=For movies that are stored as fields, where each image is made of two images interleaved together. A 30-frame per second movie would contain 60 fields per second. For each image, the even scanlines of the first field are interleaved with the odd scanlines of the second field. The Movie File In TOP has several ways of dealing with this:
}}
{{ParMenu
|Parorder=2
|OPfamily=TOP
|Paritems=
{{Menuitem
|OPfamily=TOP
|Parname=precedence
|Itemname=even
|Itemsummary=When the disk files are fragmented. The Movie File In TOP will read frames of the movie into memory before they are used, this can eliminate pops or stutters in playback that occur from fragmented files, other resources accessing the hard drive, or movie looping.
|Itemlabel=Even
}}
{{Menuitem
|OPfamily=TOP
|Parname=precedence
|Itemname=odd
|Itemsummary=
|Itemlabel=Odd
}}
|Parname=precedence
|OPtype=moviefilein
|Parlabel=Field Precedence
|Parsummary=Where fields are extracted one field at a time, this will extract the Even field first by default, otehrwise it will extract the odd field first. The video industry has not standardized on one or the other.
}}
{{ParToggle
|Parsummary=
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=3
|Parlabel=Bottom Half is Alpha (AAA)
|Parname=bottomhalfalpha
}}
{{ParMenu
|Parorder=4
|OPfamily=TOP
|OPfamily=TOP
|Paritems=
|Paritems=
{{rgbitem
{{Menuitem
|OPfamily=TOP
|OPfamily=TOP
|Parname=startcolor
|Parname=multalpha
|Itemname=startcolorr
|Itemname=off
|Itemsummary=
|Itemsummary=
|Itemlabel=Red
|Itemlabel=Off
}}
}}
{{rgbitem
{{Menuitem
|OPfamily=TOP
|OPfamily=TOP
|Parname=startcolor
|Parname=multalpha
|Itemname=startcolorg
|Itemname=on
|Itemsummary=
|Itemsummary=
|Itemlabel=Green
|Itemlabel=On
}}
}}
{{rgbitem
{{Menuitem
|OPfamily=TOP
|OPfamily=TOP
|Parname=startcolor
|Parname=multalpha
|Itemname=startcolorb
|Itemname=automatic
|Itemsummary=
|Itemsummary=
|Itemlabel=Blue
|Itemlabel=Automatic
}}
}}
|Parname=startcolor
|Parname=multalpha
|OPtype=hsvadj
|OPtype=moviefilein
|Parlabel=Start Color
|Parlabel=Multiply RGB by Alpha
|Parsummary=The start color is the hue that the HSV adjustment is centered around. When adjusting a small hue range, this is the color that will be altered. In the example image above, the Start Color color is cyan with a hue value of 180.
|Parsummary=Premultiplies the image.
}}
{{ParToggle
|Parsummary=
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=5
|Parlabel=Input is sRGB
|Parname=inputsrgb
}}
{{ParMenu
|Parorder=6
|OPfamily=TOP
|Paritems=
{{Menuitem
|OPfamily=TOP
|Parname=loadingerrorimage
|Itemname=coloredbottomright
|Itemsummary=
|Itemlabel=Colored Bottom Right Square
}}
{{Menuitem
|OPfamily=TOP
|Parname=loadingerrorimage
|Itemname=zero
|Itemsummary=
|Itemlabel=Zero
}}
|Parname=loadingerrorimage
|OPtype=moviefilein
|Parlabel=Loading/Error Image
|Parsummary=
}}
}}
{{ParameterPage
|Pagesummary=
|Pagename=Trim
|OPfamily=TOP
|items=
{{ParToggle
|Parsummary=
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=0
|Parlabel=Trim
|Parname=trim
}}
}}
{{ParFloat
{{ParFloat
|Parsummary=This is the range of color from the Start Color that will be adjusted. A range of 1 will only adjust the colors that are the same as the start color. A range of 360 will adjust all colors. For example, a range of 20 and a Start Color of 180 will adjust colors in the hue range of 170-190.
|Parsummary=
|OPfamily=TOP
|OPfamily=TOP
|OPtype=hsvadj
|OPtype=moviefilein
|Parorder=1
|Parorder=1
|Parlabel=Hue Range
|Parlabel=Trim Start
|Parname=huerange
|Parname=tstart
}}
{{ParMenu
|Parorder=2
|OPfamily=TOP
|Paritems=
|Parname=tstartunit
|OPtype=moviefilein
|Parlabel=Trim Start Unit
|Parsummary=
}}
{{ParFloat
|Parsummary=
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=3
|Parlabel=Trim End
|Parname=tend
}}
{{ParMenu
|Parorder=4
|OPfamily=TOP
|Paritems=
|Parname=tendunit
|OPtype=moviefilein
|Parlabel=Trim End Unit
|Parsummary=
}}
{{ParMenu
|Parorder=5
|OPfamily=TOP
|Paritems=
{{Menuitem
|OPfamily=TOP
|Parname=textendleft
|Itemname=hold
|Itemsummary=
|Itemlabel=Hold
}}
{{Menuitem
|OPfamily=TOP
|Parname=textendleft
|Itemname=cycle
|Itemsummary=
|Itemlabel=Cycle
}}
{{Menuitem
|OPfamily=TOP
|Parname=textendleft
|Itemname=mirror
|Itemsummary=
|Itemlabel=Mirror
}}
{{Menuitem
|OPfamily=TOP
|Parname=textendleft
|Itemname=black
|Itemsummary=
|Itemlabel=Black
}}
{{Menuitem
|OPfamily=TOP
|Parname=textendleft
|Itemname=zero
|Itemsummary=
|Itemlabel=Zero
}}
|Parname=textendleft
|OPtype=moviefilein
|Parlabel=Extend Left
|Parsummary=Determines how the Movie File In TOP handles movie positions that lie before the Trim Start position. For example, if Trim Start is set to 1, and the movie's current index is -10, the Extend Left menu determines how the movie position is calculated.
}}
{{ParMenu
|Parorder=6
|OPfamily=TOP
|Paritems=
{{Menuitem
|OPfamily=TOP
|Parname=textendright
|Itemname=hold
|Itemsummary=
|Itemlabel=Hold
}}
{{Menuitem
|OPfamily=TOP
|Parname=textendright
|Itemname=cycle
|Itemsummary=
|Itemlabel=Cycle
}}
{{Menuitem
|OPfamily=TOP
|Parname=textendright
|Itemname=mirror
|Itemsummary=
|Itemlabel=Mirror
}}
{{Menuitem
|OPfamily=TOP
|Parname=textendright
|Itemname=black
|Itemsummary=
|Itemlabel=Black
}}
{{Menuitem
|OPfamily=TOP
|Parname=textendright
|Itemname=zero
|Itemsummary=
|Itemlabel=Zero
}}
|Parname=textendright
|OPtype=moviefilein
|Parlabel=Extend Right
|Parsummary=
}}
{{ParToggle
|Parsummary=
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=7
|Parlabel=Override Sample Rate
|Parname=overridesample
}}
}}
{{ParFloat
{{ParFloat
|Parsummary=
|Parsummary=
|OPfamily=TOP
|OPfamily=TOP
|OPtype=hsvadj
|OPtype=moviefilein
|Parorder=8
|Parlabel=Sample Rate
|Parname=samplerate
}}
}}
{{ParameterPage
|Pagesummary=
|Pagename=Tune
|OPfamily=TOP
|items=
{{ParInteger
|Parsummary=
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=0
|Parlabel=Pre-Read Frames
|Parname=prereadframes
}}
{{ParInteger
|Parsummary=
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=1
|Parlabel=Frame Read Timeout
|Parname=frametimeout
}}
{{ParToggle
|Parsummary=
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=2
|Parorder=2
|Parlabel=Hue Falloff
|Parlabel=Always Load Initial Frame
|Parname=huefalloff
|Parname=alwaysloadinitial
}}
}}
{{ParFloat
{{ParInteger
|Parsummary=
|Parsummary=
|OPfamily=TOP
|OPfamily=TOP
|OPtype=hsvadj
|OPtype=moviefilein
|Parorder=3
|Parorder=3
|Parlabel=Saturation Range
|Parlabel=File Open Timeout
|Parname=saturationrange
|Parname=opentimeout
}}
}}
{{ParFloat
{{ParToggle
|Parsummary=
|Parsummary=
|OPfamily=TOP
|OPfamily=TOP
|OPtype=hsvadj
|OPtype=moviefilein
|Parorder=4
|Parorder=4
|Parlabel=Saturation Falloff
|Parlabel=On Timeout, use Latest Avail
|Parname=saturationfalloff
|Parname=uselatestontimeout
}}
}}
{{ParFloat
{{ParToggle
|Parsummary=
|Parsummary=
|OPfamily=TOP
|OPfamily=TOP
|OPtype=hsvadj
|OPtype=moviefilein
|Parorder=5
|Parorder=5
|Parlabel=Value Range
|Parlabel=Use Global CPU Cache
|Parname=valuerange
|Parname=usecpucache
}}
}}
{{ParFloat
{{ParToggle
|Parsummary=
|Parsummary=
|OPfamily=TOP
|OPfamily=TOP
|OPtype=hsvadj
|OPtype=moviefilein
|Parorder=6
|Parorder=6
|Parlabel=Value Falloff
|Parlabel=Async Upload to GPU
|Parname=valuefalloff
|Parname=asyncupload
}}
}}
{{ParFloat
{{ParToggle
|Parsummary=
|Parsummary=
|OPfamily=TOP
|OPfamily=TOP
|OPtype=hsvadj
|OPtype=moviefilein
|Parorder=7
|Parorder=7
|Parlabel=Hue Offset
|Parlabel=Update Image
|Parname=hueoffset
|Parname=updateimage
}}
}}
{{ParFloat
{{ParInteger
|Parsummary=
|Parsummary=
|OPfamily=TOP
|OPfamily=TOP
|OPtype=hsvadj
|OPtype=moviefilein
|Parorder=8
|Parorder=8
|Parlabel=Saturation Multiplier
|Parlabel=Max Decode CPUs
|Parname=saturationmult
|Parname=maxdecodecpus
}}
{{ParToggle
|Parsummary=
|OPfamily=TOP
|OPtype=moviefilein
|Parorder=9
|Parlabel=High Performance Read
|Parname=highperfread
}}
}}
{{ParFloat
{{ParFloat
|Parsummary=
|Parsummary=
|OPfamily=TOP
|OPfamily=TOP
|OPtype=hsvadj
|OPtype=moviefilein
|Parorder=9
|Parorder=10
|Parlabel=Value Multiplier
|Parlabel=High Performance Read Factor
|Parname=valuemult
|Parname=highperfreadfactor
}}
}}
}}
}}
{{:TOP Filter Common Page
{{:TOP Generator Common Page
}}
}}
{{History
{{History

Revision as of 14:03, 29 August 2017

  • Invalid title: ""

Summary
[edit]

The Movie File In TOP loads movies, still images, or a sequence of still images into TOPs. It will read images in .jpg, .gif, .tif, or .bmp format. It will read movies in QuickTime's .mov format, .mp4, .mpg, .mpeg, .avi, .wmv, .dpx, Cineform and Hap Q formats (including Hap Q with Alpha). It also supports some .swf and .flv Flash files as well as DXT1, 3, and 5 compressed .DDS files. Images and movies can also be fetched from the web by using http:// to specify a URL.

For a complete list, see File Types.

Examine the state of a Movie File In TOP by attaching an Info CHOP to it (see below on Info CHOP). This will show static info like movie length, resolution, frames per second, and whether there is audio in the file. It also shows dynamic information like movie open status, current frame, readahead frames and queue size, dropped frame count, CPU decode time and GPU upload time.

See also Cineform, Hap, Movie File Out TOP, Movie Playback

PythonIcon.png[[{{{opClass}}}]]


Parameters - Page

Template:ParFilePath Template:ParToggle Template:ParButton Template:ParMenu Template:ParToggle Template:ParFloat Template:ParToggle Template:ParButton Template:ParFloat Template:ParMenu Template:ParMenu Template:ParFloat Template:ParMenu Template:ParFloat Template:ParMenu Template:ParInteger Template:ParMenu Template:ParMenu


Parameters - Page

Template:ParToggle Template:ParMenu Template:ParMenu Template:ParToggle Template:ParMenu Template:ParToggle Template:ParMenu


Parameters - Page

Template:ParToggle Template:ParFloat Template:ParMenu Template:ParFloat Template:ParMenu Template:ParMenu Template:ParMenu Template:ParToggle Template:ParFloat


Parameters - Page

Template:ParInteger Template:ParInteger Template:ParToggle Template:ParInteger Template:ParToggle Template:ParToggle Template:ParToggle Template:ParToggle Template:ParInteger Template:ParToggle Template:ParFloat


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.


TouchDesigner Build:

TOPs
Add • Analyze • Anti Alias • Blob Track • Bloom • Blur • 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 s Vid • Kinect Azure Select • Kinect Azure • Kinect • Layout • Leap Motion • Lens Distort • Level • Limit • Lookup • Luma Blur • Luma Level • Math • Matte • Mirror • Monochrome • MoSys • Movie File In • Movie File Out • MPCDI • Multiply • Ncam • NDI In • NDI Out • Noise • Normal Map • Notch • Null • Nvidia Background • Nvidia Denoise • Nvidia Flex • Nvidia Flow • Nvidia Upscaler • OAK Select • Oculus Rift • OP Viewer • OpenColorIO • OpenVR • Optical Flow • Orbbec Select • Orbbec • Ouster Select • Ouster • Out • Outside • Over • Pack • Photoshop In • Point File In • Point File Select • Point Transform • PreFilter Map • Projection • Ramp • RealSense • Rectangle • Remap • Render Pass • Render Select • Render • RenderStream In • RenderStream Out • Reorder • Resolution • RGB Key • RGB to HSV • Scalable Display • Screen Grab • Screen • Script • Select • Shared Mem In • Shared Mem Out • SICK • Slope • Spectrum • SSAO • Stype • Substance Select • Substance • Subtract • SVG • Switch • Syphon Spout In • Syphon Spout Out • Text • Texture 3D • Texture Sampling Parameters • Threshold • Tile • Time Machine • TOP • TOP Viewer • Touch In • Touch Out • Transform • Under • Video Device In • Video Device Out • Video Stream In • Video Stream Out • Vioso • Web Render • ZED