You are here: Reference Guide > Draw Nodes > Grid

Grid

This node creates a grid of horizontal and vertical lines on top of the input image.

Inputs and Controls

Connection Type	Connection Name	Function
Input	unnamed	The image on which the grid is superimposed.
mask	An optional image to use as a mask. By default, the grid 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 on which the grid is superimposed.

mask

An optional image to use as a mask. By default, the grid 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
Grid Tab
output	output	rgba	The grid is only applied to these channels. You can use the checkboxes on the right to select the individual channels to output.
premult	premult	none	These channels are set to black outside the grid shape.
clip to	cliptype	format	Sets 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. • unionbboxandformat - restrict the output image to a combination of the incoming bounding box and format area. • intersectbboxandformat - 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 grid (that is, fills in the holes in the grid and leaves holes for the lines).
opacity	opacity	1	Adjusts the grid opacity on a sliding scale, where 0 is completely transparent and 1 is completely 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 grid 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 grid is limited to the non-white areas of the mask.
number	number	10	Sets the number of grid squares on the x and y axes.
size	size	1	Sets the grid line thickness in pixels.
translate	translate	0, 0	Translates the entire grid on the x and y axes.
Color Tab
ramp	ramp	none	Selects whether to create a color gradient across the grid: • none - don’t create a color gradient. • linear - the ramp changes linearly from one color into another. • smooth0 - the ramp color gradually eases into the point 0 end. This means colors in the point 0 end are spread wider than colors in the point 1 end. • smooth1 - the ramp color eases into the point 1 end. This means colors in the point 1 end are spread wider than at the point 0 end. • smooth - the ramp color gradually eases into both ends. This means colors in the point 0 and point 1 ends are spread wider than colors in the center of the ramp.
color	color	1	Sets a color for the grid. If ramp is set to anything other than none, this is the color for the ramp at the point 1 end (by default, the top end).
point 1	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.
color 0	color0	0	Sets the color for the ramp at the point 0 end (by default, the bottom end). This control is only available if ramp is set to anything other than none.
point 0	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.