Module `MaskData-PIXI`

type displayObjectOpaque;

used to resolve dependency cycle src/C-PIXI.cmj -> src/Filter-PIXI.cmj -> src/RenderTexture-PIXI.cmj -> src/BaseRenderTexture-PIXI.cmj -> src/MaskData-PIXI.cmj -> src/C-PIXI.cmj

until this is resolved, feel free to force cast it with Obj.magic to DisplayObject.t or any structural subtype of Js.t(#C.displayObject)

class type _t = { ... }

type t = Js.t(_t);: Component for masked elements Holds mask mode and temporary data about current mask

module Impl: { ... };

include Impl;

let create: ?⁠maskObject:displayObjectOpaque => unit => t;

Create MaskData

parameter maskObject: object that describes the mask

let get_scissorRect: Js.t(_t) => Js.t(PIXI.Rectangle.#_t);: Scissor operation above the mask in stack. Null if _scissorCounter is zero, rectangle instance if positive.

let set_scissorRect: Js.t(_t) => Js.t(PIXI.Rectangle.#_t) => unit;: Scissor operation above the mask in stack. Null if _scissorCounter is zero, rectangle instance if positive.

let getAutoDetect: Js.t(_t) => bool;: Whether we know the mask type beforehand

let setAutoDetect: Js.t(_t) => bool => unit;: Whether we know the mask type beforehand

let getIsMaskData: Js.t(_t) => bool;: Indicator of the type

let setIsMaskData: Js.t(_t) => bool => unit;: Indicator of the type

let getMaskObject: Js.t(_t) => displayObjectOpaque;: Which element we use to mask

let setMaskObject: Js.t(_t) => displayObjectOpaque => unit;: Which element we use to mask

let getPooled: Js.t(_t) => bool;: Whether it belongs to MaskSystem pool

let setPooled: Js.t(_t) => bool => unit;: Whether it belongs to MaskSystem pool

let _getType: Js.t(_t) => int;

let getType: Js.t(_t) => PIXI.MASK_TYPES.t;: Mask type

let _setType: Js.t(_t) => int => unit;

let setType: Js.t(_t) => PIXI.MASK_TYPES.t => unit;: Mask type

let copyCountersOrReset: Js.t(_t) => maskAbove:Js.Nullable.t(Js.t(_t)) => unit;

copies counters from maskData above, called from pushMask()

parameter maskAbove

let reset: Js.t(_t) => unit;: resets the mask data after popMask()