Replace set_clip_path with set_clips_contents method by PoignardAzur · Pull Request #1627 · linebender/xilem

PoignardAzur · 2026-01-28T10:43:56Z

This changes clipping behavior to a boolean flag, which better matches how it was used so far.

A follow-up PR will add set_clip_shape to set arbitrary (even non-Rect) shapes.

masonry_core/src/core/contexts.rs

waywardmonkeys · 2026-01-28T11:18:17Z

masonry_core/src/core/widget_state.rs

+    // pub(crate) clip_shape: Option<BezPath>,
+    //
+    /// Whether the widget and its children's scenes are clipped by the
+    /// [clip shape](crate::doc::masonry_concepts#clip-shape).


Should this say "clip shape" yet?

Yeah, the documentation link is already valid.

waywardmonkeys · 2026-01-28T11:18:58Z

masonry_core/src/doc/masonry_concepts.md

+- If the widget is set to clip its contents, pointer events outside the clip shape won't affect the children either.
+- If the widget is set to clip its contents, its scene and the children's scenes will be painted inside of the clip shape.
+
+Currently, the clip shape is hardcoded to be the layout rect.


Maybe better to say "the widgets local rect, transformed for rendering" or something since we just say that a layout rect doesn't make sense above.

True. I think I need to start a discussion about this on Zulip.

masonry_core/src/core/contexts.rs

Builds on top of linebender#1627.

This changes clipping behavior to a boolean flag, which better matches how it was used so far. A follow-up PR will add set_clip_shape to set arbitrary (even non-Rect) shapes.

PoignardAzur · 2026-02-10T16:37:59Z

I've rebased on top of the box model rework.

I'm not super happy with the result of the rebase (you can kinda tell the PR was meant for the previous coordinate system), and we need some kind of discussion about how to integrate clip shapes into the box model. We can do that before or after merging this PR.

Note that one effect of this PR is that the Label and Prose widgets were previously clipped to their border box and they're now clipped to their content box, which matches the behavior of other widgets. I think that's fine in the short term, because these two labels don't have any padding/borders by default, so both behavior are usually identical.

Whether Label and Prose should clip to their border box is another discussion, one that will be tied to how clip shapes fit in the box model.

xStrom

If you want to land this sooner than later, then I suggest making the bool mean border-box (matches the old behavior). I mention in an inline comment how to get that.

That will get the same old results for Prose and Label. It will (temporarily) regress TextInput but that would be ok.

More generally, I think we should provide easy clip support with more options. I think the three choices from CSS's overflow-clip-margin are all very useful.

content-box
padding-box
border-box

Essentially I can imagine having:

enum Clip {
    None,
    ContentBox,
    PaddingBox,
    BorderBox,
    Custom(Shape),
}

Whether you think it should happen already in this PR I'll leave for you to decide.

I am also willing to implement the various pre-defined box clips myself, given I'm very familiar with the box conversions right now.

xStrom · 2026-02-20T16:37:29Z

masonry_core/src/core/widget.rs

+    let is_inside_clip_shape = ctx.content_box().contains(local_pos);
+
+    if ctx.clips_contents() && !is_inside_clip_shape {


A lot of widgets won't have ctx.clips_contents() as true, right? So we could avoid doing the content box fetching and position checking.

Suggested change

let is_inside_clip_shape = ctx.content_box().contains(local_pos);

if ctx.clips_contents() && !is_inside_clip_shape {

if ctx.clips_contents() && !ctx.content_box().contains(local_pos) {

xStrom · 2026-02-20T16:45:08Z

masonry_core/src/core/widget_state.rs

+    ///   only the painting done in `Widget::paint` by this widget itself will be clipped.
+    ///   The remaining painting done in `Widget::pre_paint` and `Widget::post_paint` will not be clipped.
+    /// - Pointer events must be inside that shape to reach the widget's children.
+    ///
+    /// This currently returns the border-box rect if `clips_contents` is true and `None` otherwise, but in the future we may want to support more complex clip shapes, in which case this method would need to be updated.
+    ///


I would prefer to keep these paint methods short and clickable links. Shortness also helps keep the line length under a 100 and links help keep docs fresh.

Similarly, let's break the long sentence into multiple lines so it's below 100.

Suggested change

/// only the painting done in `Widget::paint` by this widget itself will be clipped.

/// The remaining painting done in `Widget::pre_paint` and `Widget::post_paint` will not be clipped.

/// - Pointer events must be inside that shape to reach the widget's children.

///

/// This currently returns the border-box rect if `clips_contents` is true and `None` otherwise, but in the future we may want to support more complex clip shapes, in which case this method would need to be updated.

///

/// only the painting done in [`paint`] by this widget itself will be clipped.

/// The remaining painting done in [`pre_paint`] and [`post_paint`] will not be clipped.

/// - Pointer events must be inside that shape to reach the widget's children.

///

/// This currently returns the border-box rect if `clips_contents` is true and `None` otherwise,

/// but in the future we may want to support more complex clip shapes,

/// in which case this method would need to be updated.

///

/// [`paint`]: crate::core::Widget::paint

/// [`pre_paint`]: crate::core::Widget::pre_paint

/// [`post_paint`]: crate::core::Widget::post_paint

xStrom · 2026-02-20T17:01:23Z

masonry_core/src/core/widget_state.rs

+    ///
+    /// [clip shape]: crate::doc::masonry_concepts#clip-shape.
+    pub(crate) fn clip_shape(&self) -> Rect {
+        self.border_box_size().to_rect() - self.border_box_translation()


This is wrong, that translation means that it returns the border box rect in content-box coordinate space.

To return the border box rect in border-box coordinate space, you just do this:

Suggested change

self.border_box_size().to_rect() - self.border_box_translation()

self.border_box_size().to_rect()

If instead you wanted to actually clip to the content-box rect, then it would be:

Suggested change

self.border_box_size().to_rect() - self.border_box_translation()

self.border_box_size().to_rect() - self.border_box_insets

However, then a bunch of comments would need updating as well.

waywardmonkeys reviewed Jan 28, 2026

View reviewed changes

PoignardAzur added a commit to PoignardAzur/xilem that referenced this pull request Jan 28, 2026

Implement set_clip_shape method

e356460

Builds on top of linebender#1627.

PoignardAzur mentioned this pull request Jan 28, 2026

Set clip shape #1629

Draft

PoignardAzur force-pushed the set_clips_content branch from 14c2596 to 3623059 Compare January 29, 2026 12:29

PoignardAzur requested a review from waywardmonkeys January 29, 2026 12:30

PoignardAzur added 3 commits February 10, 2026 17:29

Replace set_clip_path with set_clips_contents method

29ff678

This changes clipping behavior to a boolean flag, which better matches how it was used so far. A follow-up PR will add set_clip_shape to set arbitrary (even non-Rect) shapes.

Fix doc

89d3404

Address code review

b8b49d7

PoignardAzur force-pushed the set_clips_content branch from 3623059 to b8b49d7 Compare February 10, 2026 16:30

Fix compile error

d244536

PoignardAzur added 3 commits February 10, 2026 17:49

Add clip_shape method and fix paint clipping

a01c659

Update label screenshot

00e961e

Fix doc error

ea6697c

PoignardAzur requested a review from xStrom February 17, 2026 11:08

xStrom reviewed Feb 20, 2026

View reviewed changes

xStrom added masonry Issues relating to the Masonry widget layer waiting on author Needs author input before proceeding. labels Feb 20, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Replace set_clip_path with set_clips_contents method#1627

Replace set_clip_path with set_clips_contents method#1627
PoignardAzur wants to merge 7 commits intolinebender:mainfrom
PoignardAzur:set_clips_content

PoignardAzur commented Jan 28, 2026

Uh oh!

Uh oh!

waywardmonkeys Jan 28, 2026

Uh oh!

PoignardAzur Jan 28, 2026 •

edited

Loading

Uh oh!

waywardmonkeys Jan 28, 2026

Uh oh!

PoignardAzur Jan 28, 2026

Uh oh!

Uh oh!

PoignardAzur commented Feb 10, 2026 •

edited

Loading

Uh oh!

xStrom left a comment

Uh oh!

xStrom Feb 20, 2026

Uh oh!

xStrom Feb 20, 2026

Uh oh!

xStrom Feb 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		let is_inside_clip_shape = ctx.content_box().contains(local_pos);

		if ctx.clips_contents() && !is_inside_clip_shape {

-    ///   only the painting done in `Widget::paint` by this widget itself will be clipped.
-    ///   The remaining painting done in `Widget::pre_paint` and `Widget::post_paint` will not be clipped.
-    /// - Pointer events must be inside that shape to reach the widget's children.
-    ///
-    /// This currently returns the border-box rect if `clips_contents` is true and `None` otherwise, but in the future we may want to support more complex clip shapes, in which case this method would need to be updated.
-    ///
+    ///   only the painting done in [`paint`] by this widget itself will be clipped.
+    ///   The remaining painting done in [`pre_paint`] and [`post_paint`] will not be clipped.
+    /// - Pointer events must be inside that shape to reach the widget's children.
+    ///
+    /// This currently returns the border-box rect if `clips_contents` is true and `None` otherwise,
+    /// but in the future we may want to support more complex clip shapes,
+    /// in which case this method would need to be updated.
+    ///
+    /// [`paint`]: crate::core::Widget::paint
+    /// [`pre_paint`]: crate::core::Widget::pre_paint
+    /// [`post_paint`]: crate::core::Widget::post_paint

	self.border_box_size().to_rect() - self.border_box_translation()
	self.border_box_size().to_rect()

Comments

Conversation

PoignardAzur commented Jan 28, 2026

Uh oh!

Uh oh!

waywardmonkeys Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

PoignardAzur Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

waywardmonkeys Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

PoignardAzur Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

PoignardAzur commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xStrom left a comment

Choose a reason for hiding this comment

Uh oh!

xStrom Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

xStrom Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

xStrom Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

PoignardAzur Jan 28, 2026 •

edited

Loading

PoignardAzur commented Feb 10, 2026 •

edited

Loading