zui docs v0.0.5
GitHub ↗
Effects Container Native Qt

Opacity Mask

Opacity Mask is a native Zui container in the effects catalog, with 9 component-specific properties.

Usage

Ruby example

Paste this complete Builder example inside the app surface from the Quickstart. Replace illustrative asset paths with files from your project.

Ruby
opacity_mask width: 320, height: 320, mask_source: "assets/circle-mask.png", inverted: false do
  image "assets/portrait.jpg", width: 320, height: 320
end
API

Component properties

9 component-specific values, plus shared item and layout properties.

widthWidth configuration for Opacity Mask.property
heightHeight configuration for Opacity Mask.property
mask_sourceMask source configuration for Opacity Mask.property
threshold_minThreshold min configuration for Opacity Mask.property
spread_minSpread min configuration for Opacity Mask.property
threshold_maxThreshold max configuration for Opacity Mask.property
spread_maxSpread max configuration for Opacity Mask.property
invertedInverted configuration for Opacity Mask.property
visibleVisible configuration for Opacity Mask.property
Show 14 shared item properties
enabledopacityscalerotationzfill_widthfill_heightpreferred_widthpreferred_heightminimum_widthminimum_heightmaximum_widthmaximum_heightlayout_alignment
Interaction

Events

Subscribe with on widget, :event and keep behavior in Ruby.

This renderer is display-only and does not emit component-specific events.