You are here: Reference Guide > Draw Nodes > Ramp

Ramp

Generates a gradation between two defined edges. This node is included for backward compatibility - other Draw nodes, such as Rectangle, have their own Ramp controls.

Inputs and Controls

Connection Type	Connection Name	Function
Input	unnamed	The image sequence to which the ramp is added.
mask	An optional image to use as a mask. By default, the ramp is limited to the non-black areas of the mask. At first, the mask input appears as triangle on the right side of the node, but when you drag it, it turns into an arrow labeled mask. If you cannot see the mask input, ensure that the mask control is disabled or set to none.

Connection Type

Connection Name

Function

Input

unnamed

The image sequence to which the ramp is added.

mask

An optional image to use as a mask. By default, the ramp is limited to the non-black areas of the mask.

At first, the mask input appears as triangle on the right side of the node, but when you drag it, it turns into an arrow labeled mask. If you cannot see the mask input, ensure that the mask control is disabled or set to none.

Control (UI)	Knob (Scripting)	Default Value	Function
Ramp Tab
output	output	rgba	The ramp is rendered into these output channels. If you set this to something other than none, you can use the checkboxes on the right to select individual channels.
premult	premult	none	Premultiply multiplies the chosen input channels with a mask representing the ramp. For example, where there is no ramp (the matte is black or empty), the input channels are set to black. Where the ramp is opaque (the matte is white or full), the input channels keep their full value. NOTE: Selecting rgba premultiplies the alpha against itself (aa). If you don’t want this to happen, set premult* to rgb instead.
clip to	cliptype	format	Select how to restrict the output image: • no clip - use the entire image. • bbox - restrict the output image to the incoming bounding box. • format - restrict the output image to the incoming format area. • union bbox+format - restrict the output image to a combination of the incoming bounding box and format area. • intersect bbox+format - restrict the output image to an intersection of the bounding box and incoming format area.
replace	replace	disabled	When enabled, existing channels are cleared to black before drawing into them. You might find replace useful, for instance, if you’re creating a mask in the alpha channel, but the incoming image already has an alpha channel which you want to throw away.
invert	invert	disabled	When enabled, inverts the new ramp and non-ramp areas.
opacity	opacity	1	Sets the ramp opacity where 0 is equal to transparent, and 1 is equal to opaque.
mask	N/A	disabled	Enables the associated mask channel to the right. Disabling this checkbox is the same as setting the channel to none.
mask	maskChannelInput	none	The channel to use as a mask. By default, the ramp is limited to the non-black areas of this channel.
inject	inject	disabled	Copies the mask input to the predefined mask.a channel. Injecting the mask allows you to use the same mask further downstream.
invert	invert_mask	disabled	Inverts the use of the mask channel so that the ramp is limited to the non-white areas of the mask.
point 0 xy	p0	100, 100	Sets the position of point 0. This allows you to adjust the spread and angle of the ramp. This control is only available if ramp is set to anything other than none.
point 1 xy	p1	100, 400	Sets the position of point 1. This allows you to adjust the spread and angle of the ramp. This control is only available if ramp is set to anything other than none.
type	type	linear	Sets the type of ramp to apply: • linear - the ramp has a linear gradient. • plinear - the ramp appears to have more linear gradient to the naked eye. • smooth0 - the ramp gradually eases into the point 0 end. • smooth1 - the ramp eases into the point 1 end. • smooth - the ramp gradually eases into both ends.
Color Tab
color	color	1	Sets a color for the ramp.