Skip to content

Commit d1f1555

Browse files
authored
Add documentation for pc.Element#mask (playcanvas#2366)
1 parent 3a3d41c commit d1f1555

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

src/framework/components/element/component.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ var matD = new Mat4();
104104
* @property {boolean} enableMarkup Flag for enabling markup processing. Only works for {@link pc.ELEMENTTYPE_TEXT} types. The only supported tag is `[color]` with a hex color value. E.g `[color="#ff0000"]red text[/color]`
105105
* @property {number} rangeStart Index of the first character to render. Only works for {@link pc.ELEMENTTYPE_TEXT} types.
106106
* @property {number} rangeEnd Index of the last character to render. Only works for {@link pc.ELEMENTTYPE_TEXT} types.
107+
* @property {boolean} mask Switch Image Element into a mask. Masks do not render into the scene, but instead limit child elements to only be rendered where this element is rendered.
107108
*/
108109
function ElementComponent(system, entity) {
109110
Component.call(this, system, entity);

0 commit comments

Comments
 (0)