Parent Userdata
Library graphics.*
Revision Release 2023.3686
Keywords graphics, mask, image mask
See also Masking Images (guide)


Mask objects are created with graphics.newMask() and have no properties and methods. They are used with display object methods such as object:setMask().


There is a nested masking limit of 3, so care must be taken when inserting masked objects into other masked objects which act as containers, including display.newContainer, widget.newScrollView, widget.newTableView, or a masked display group. Other display objects that utilize masks include display.newText, display.newEmbossedText, and any other masked display object. For example, a text object (one mask) inside a container (one mask) inside yet another container (one mask) would reach but not exceed the limit of 3 nested masks.