viewbackground command

Sets various options of thew viewport background.

Replaced by: hou.GeometryViewportSettings

All Usages Options

Usages

  1. viewbackground [@options] <<viewports/view-memories

You can paste an image in the background of a viewport for rotoscoping or reference purposes. This command sets the options for the display of the background image.

Without any options, the command prints the current values for the viewport/view-memory you specify.

See how to refer to viewers and viewports .

Options

-b on|off

Display background images on/off

-q quality

Quality of the background image.

-S file|cop

source of the background image.

-t on|off

Texture mapped backgrounds on/off. Only applies to 3D viewports/view-memories.

-a on|off

Automatic position/scaling of background image on/off. If off, you must manually position and scale the image with -o and -s. Only applies to 3D viewports/view-memories.

-o x y

Offsets the image by x and y. Only applies to 3D viewports/view-memories.

-s x y

Scales the image by x and y. Only applies to 3D viewports/view-memories.

-m u v

Minimum U and V values for the image. Only applies to UV viewports/view-memories.

-M u v

Maximum U and V values for the image. Only applies to UV viewports/view-memories.

-i on|off

Filtering on/off. Only applies to UV viewports/view-memories.

-F filename

Sets the filename from which to get the image. Only applies when “-S file”.

-O on|off

(Override) If on, get resolution from -r option. If off, use the resolution stored in the file. Only applies when “-S file”.

-r xres yres

Manually set the resolution of the image. Only applies when “-S file” and “-O on”.

-C cop_path

Set the compositing operator to use for the background image. This option lets you set the operator with just a path. Use -c to set the network and COP separately. Only applies when “-S cop”.

-c ice_name cop_name

Set the compositing operator to use for the background image. This option lets you set the network and COP separately, use -C to set the operator using just a path. Only applies when “-S cop”.

-p color alpha

The color and alpha planes to use for the image. Only applies when “-S cop”.