Documentation Center

Viz Artist

Version 3.10 | Published May 03, 2018 ©

Image Mask

images/download/attachments/27789686/viz_icons_imagemask.png
The Image Mask plug-in applies a mask to an image using other images (e.g. an alpha image).

images/download/attachments/27789686/plugins_shader_imagemask_scene_example.png

Note: This plug-in is located in: Built Ins -> Shader -> Effects

This section contains information on the following topics:

Image Mask Properties

images/download/attachments/27789686/plugins_shader_imagemask_editor.png

  • Image: Placeholder for image.

  • Blend: Blend the image with the object.

  • Position X, Y %: Set the position of the mask in percentage for the screen or object.

  • Scale X, Y %: Set the size of the mask in percentage for the screen or object.

  • Fit: Select the size of the image mask to the screen or the object:

    • Screen: The image mask is sized to the screen. If the object is moved it will move while the image mask stays fixed.

    • Object: The image mask is sized to the object. If the object is moved the image mask will move with it.

  • Wrap:

    • Repeat: The image mask is applied multiple times on the screen or object.

    • Clamp: The image mask is applied once on the screen or object.

  • Mask Aspect: Set the aspect of the image mask to the screen or the object.

  • Invert: Inverts the image.

  • Alpha only: Enable the alpha channel for the image (for example, an RGBA image).

  • Soft Mask: Apply a soft mask (available when Fit is set to Screen).