Ramp TOP

Summary

The Ramp TOP allows you to interactively create vertical, horizontal, radial, and circular ramps. Using the ramp bar and the color picker, you can add as many color tabs to the ramp as you like, each with its own color and alpha values. Click on a color tab to select it and change its color. Click elsewhere on the ramp bar to add another color keyframe. Drag a color tab off the ramp bar to delete it.

The data for each color keyframe in the ramp is held in the DAT specified by the DAT parameter. Each row in this DAT (in Table Format) represents a color keyframe entry in the ramp. The first column is the color keyframe's position on the ramp, the range is 0-1. The next 4 columns are the RGBA value for the color keyframe at that position. The DAT can be edited directly and the ramp will update in real-time.

rampTOP_Class

Parameters - Ramp Page

DAT dat - Specifies the DAT which defines the entries in the ramp.

color - ⊞ - The color and alpha of each ramp keyframe can be set here. Select between an HSV or RGB colorpicker, or click the "+" button to open a color dialog box with predefined colors.

Type type - ⊞ - The type of ramp, choose between vertical, horizontal, radial, and circular.

Position position - ⊞ - Sets the center point for radial and circular ramps.

Phase phase - Offsets the beginning of the ramp.

Period period - Adjusts the length of the ramp, similar to a UV scaling.

Extend Left extendleft - ⊞ - Sets the extend (or repeat) conditions of the ramp beyond the defined range. This parameter determines what happens at the edges of the ramp.

Extend Right extendright - ⊞ - Sets the extend (or repeat) conditions of the ramp beyond the defined range. This parameter determines what happens at the edges of the ramp.

Interpolate Notches interp - ⊞ - Change type of interpolation between the color keyframes in the ramp.

Curve Tension tension - Only enabled when using Hermite interpolation. Adjusts the tension bias of the Hermite curve used for interpolation.

Anti-Alias antialias - Sets level of anti-aliasing for Radial and Circular type ramps.

Fit Aspect fitaspect - ⊞ - Adjusts the fit of Radial and Circular type ramps based on aspect ratio.

Dither dither - Dithers the ramp to help deal with banding and other artifacts created by precision limitations.

Multiply RGB by Alpha multrgbbyalpha - Premultiplies the image.

Parameters - Output Page

Comp Over Input compoverinput - Turning this On will composite the input with the image.

Operation operand - ⊞ - Choose which composite operation is performed from this menu. Search the web for 'blend modes' for more detailed information on the effects of each type.

Swap Order swaporder - Swaps the order of the composite with the input.

Parameters - Common Page

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

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.

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.)

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

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.

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.

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

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.

Operator Inputs

• Input 0: Composite Input - Control the Composite operation via the parameters on the Output Page of this operator.

Info CHOP Channels

Extra Information for the Ramp TOP can be accessed via an Info CHOP.

Common TOP Info Channels

• resx - Horizontal resolution of the TOP in pixels.

• resy - Vertical resolution of the TOP in pixels.

• aspectx - Horizontal aspect of the TOP.

• aspecty - Vertical aspect of the TOP.

• depth - Depth of 2D or 3D array if this TOP contains a 2D or 3D texture array.

• gpu_memory_used - Total amount of texture memory used by this TOP.

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.

TouchDesigner Build: Latest\nmw-rollback2021.100002018.28070before 2018.28070