[Windows] Fixed CanvasDrawingSession Exception on Clipping Image #30028
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dotnet-policy-service
bot
added
community ✨
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a Windows-only CanvasDrawingSessionException by resetting the canvas state after each draw, and adds a full repro via HostApp and automated tests.
- Adds
_canvas.ResetState()inOnDrawto ensure the canvas is cleared after drawing. - Introduces a new UI page (
Issue18430) with clipping drawable and embeds the required image resource. - Adds shared and host-app test cases to validate that no exception is thrown.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Graphics/src/Graphics/Platforms/Windows/PlatformGraphicsView.cs | Call ResetState() after drawing to clear state |
| src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue18430.cs | New shared UI test checking that the page loads |
| src/Controls/tests/TestCases.HostApp/Issues/Issue18430.cs | HostApp page and clipping drawable for repro |
| src/Controls/tests/TestCases.HostApp/Controls.TestCases.HostApp.csproj | Embed royals.png so the drawable can load the image |
Comment on lines
88
to
92
| _canvas.Session = args.DrawingSession; | ||
| _canvas.CanvasSize = new global::Windows.Foundation.Size(_dirty.Width, _dirty.Height); | ||
| _drawable.Draw(_canvas, _dirty); | ||
| _canvas.ResetState(); | ||
| PlatformGraphicsService.ThreadLocalCreator = null; |
There was a problem hiding this comment.
Consider wrapping the draw logic (setting session, size, and calling Draw) and the ResetState call in a try/finally block so that the canvas state is always reset even if _drawable.Draw(...) throws an exception.
Suggested change
| _canvas.Session = args.DrawingSession; | |
| _canvas.CanvasSize = new global::Windows.Foundation.Size(_dirty.Width, _dirty.Height); | |
| _drawable.Draw(_canvas, _dirty); | |
| _canvas.ResetState(); | |
| PlatformGraphicsService.ThreadLocalCreator = null; | |
| try | |
| { | |
| _canvas.Session = args.DrawingSession; | |
| _canvas.CanvasSize = new global::Windows.Foundation.Size(_dirty.Width, _dirty.Height); | |
| _drawable.Draw(_canvas, _dirty); | |
| } | |
| finally | |
| { | |
| _canvas.ResetState(); | |
| PlatformGraphicsService.ThreadLocalCreator = null; | |
| } |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
I think the suggestion is correct.
sheiksyedm
added
platform/windows
area-drawing
jsuarezruiz
requested changes
Jun 18, 2025
Comment on lines
88
to
92
| _canvas.Session = args.DrawingSession; | ||
| _canvas.CanvasSize = new global::Windows.Foundation.Size(_dirty.Width, _dirty.Height); | ||
| _drawable.Draw(_canvas, _dirty); | ||
| _canvas.ResetState(); | ||
| PlatformGraphicsService.ThreadLocalCreator = null; |
There was a problem hiding this comment.
I think the suggestion is correct.
|
@jsuarezruiz I have modified the suggested changes |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
jsuarezruiz
approved these changes
Jul 3, 2025
rmarinho
pushed a commit
that referenced
this pull request
Aug 1, 2025
* Added sample for GraphicsView * Added the feature matrix code * Added the test cases for the GraphicsView * Updated the GraphicsViewFeaturetests * Updated the GraphicsViewViewModel * Addressed the feedbacks * Added the snapshots for Mac and Windows * Remove .NET 8 specific code for templates (#30342) * [Catalyst] Fix Scrollbar does not align with FlowDirection change in ScrollView (#30241) * fix added * Revert "fix added" This reverts commit 138797f. * fix added * fix updated * [Android] Fix for OnSizeAllocated is not reported for Android AppShell Flyout content. (#30069) * fix-22045 - Made changes on Android ShellFlyout sizing by adding OnDrawerOpened event and updating Content so OnSizeAllocated is called with correct values when drawer opens. * fix-22045- Set the contentview frame value when the FlyoutView layout change. * fix-22045- Changes committed. * Permissions (BT & WiFi): don't add AccessFineLocation to required permissions if NeverForLocation flag is present (#20874) * otherwise the permission-status will be 'denied' if AccessFineLocation is in the manifest, but denied at runtime (even if it is not strictly required) * Fixed the RealParent Warning shown issue (#30156) * Safe Get of RealParent to avoid warnings * Optimized the fix * Make it as default private * Optimized the fix * Modified the fix and added test * Modified the fix based on concern and added test * unwanted spacing * Replaced the Parent property directly * [iOS/MacCatalyst] Fix: Setting SelectedItem Programmatically and Then Immediately Setting ItemsSource to Null Causes a Crash (#29940) * Re-evaluate indexpaths in PerformBatchUpdates * Add UI test * update test * bring back null check * add a check to see if ItemsSource is disposed * [Windows] Fixed StackLayout crashes on Windows with HeightRequest as 0 (#29926) * Fixed StackLayout crashes on Windows with HeightRequest 0, padding, and opposing alignment. * Included test case for Vertical StackLayout * Updated label content * [Windows] Fixed CanvasDrawingSession Exception on Clipping Image (#30028) * [Windows] Fixed CanvasDrawingSession Exception * Update in description label * Updated Suggested Changes * [Testing] Feature matrix UITest Cases for ScrollView Control (#30188) * Added Feature Matrix for ScrollView * Updated changes * Changes updated * Modified the test cases * Modified UI * Added snapshots * Added images * Modified Test Case * Added images * Resaved images * [Testing] Feature Matrix UITest Cases for TimePicker Control (#30271) * modified UI and test cases * updated test cases * added new test cases * updated test cases * added android and iOS snapshots * updated format * updated flow direction code * added mac and windows snapshots * updated iOS snapshots * [Catalyst] Adding and Removing ContextMenus currently does not work - fix (#30307) * Disconnect context flyout handler * Update MenuFlyoutHandler.iOS.cs * Fix for TapGestureRecognizer ButtonMask always return 0 (#30372) * Fix for TapGesture ButtonMask * Added TestCase * Update Testcase * Modified Testcase * fix extention typo (#30461) * fix some incorrect casting using `as` (#30459) if the type is known then a direct cast should be used instead of an as. since, in the case where the assumption is wrong, then it is better to get a cast exception instead of a null ref exception. basically if code uses `as` and does not check for null when that variable is used, then it is likely problematic code. * [Testing] Feature Matrix UITest Cases for SearchBar Control (#30398) * added test cases * added snapshots * comment added * snapshot added * changed method name * [Testing] Feature Matrix UITest Cases for DatePicker Control (#30159) * added test cases * added new test cases * removed test cases * updated test cases * updated test cases * changes in test case * added new event * updated test cases * added culture test cases * added snapshots * added the failing condition * modified test case * added new test case code * added mac and windows snapshots * [create-pull-request] automated change (#30591) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> # Conflicts: # src/Compatibility/Core/src/Tizen/Forms.cs * [Testing] Add UITest for Issue30147 on iOS (#30506) * fix added * Revert "fix added" This reverts commit 138797f. * test case added * test sample modified * test sample updated * affected platform changed * sample changes added * [Android] Fix for Search Handler visual and functional bug in subtabs (#30467) * fix-21119-Made changes to ShellToolbarTracker.cs to prevent search handler stacking on Android Shell tab navigation by removing existing menu items before adding new ones. * fix-21119-Testcase and test snapshot added. * fix-21119-Updated code changes. Also added Mac and Windows snapshots. * [Windows] Fixed the Pasted Password Becomes Visible When IsPassword Is Enabled (#30353) * Fixed the masked text issue of same value pasted into the textbox field * Added the test for verifying the masked text * [create-pull-request] automated change (#30700) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False (#30755) * Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False * Updated PlatformTouchGraphicsView * Updated test sample * Fix duplicate app icon resizing (#30920) Possibly helps with #30900 * Addressed the feedbacks * Added sample for GraphicsView * Added the feature matrix code * Added the test cases for the GraphicsView * Updated the GraphicsViewFeaturetests * Updated the GraphicsViewViewModel * Addressed the feedbacks * Added the snapshots for Mac and Windows * Addressed the feedbacks --------- Co-authored-by: Gerald Versluis <gerald.versluis@microsoft.com> Co-authored-by: devanathan-vaithiyanathan <114395405+devanathan-vaithiyanathan@users.noreply.github.com> Co-authored-by: BagavathiPerumal <93652794+BagavathiPerumal@users.noreply.github.com> Co-authored-by: Janus Weil <janus@gcc.gnu.org> Co-authored-by: Ahamed-Ali <102580874+Ahamed-Ali@users.noreply.github.com> Co-authored-by: Bhavanesh N <bhavanesh001@gmail.com> Co-authored-by: Dhivya-SF4094 <127717131+Dhivya-SF4094@users.noreply.github.com> Co-authored-by: Subhiksha Chandrasekaran <subhiksha.c@syncfusion.com> Co-authored-by: NafeelaNazhir <nafeela.nazhirhussain@syncfusion.com> Co-authored-by: TamilarasanSF4853 <tamilarasan.velu@syncfusion.com> Co-authored-by: Jakub Florkowski <42434498+kubaflo@users.noreply.github.com> Co-authored-by: HarishwaranVijayakumar <harishwaran.vijayakumar@syncfusion.com> Co-authored-by: Simon Cropp <simon.cropp@gmail.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Shane Neuville <shneuvil@microsoft.com> Co-authored-by: Jeremy Powell <47993233+jeremy-visionaid@users.noreply.github.com>
PureWeen
added a commit
that referenced
this pull request
Aug 1, 2025
* Added sample for GraphicsView * Added the feature matrix code * Added the test cases for the GraphicsView * Updated the GraphicsViewFeaturetests * Updated the GraphicsViewViewModel * Addressed the feedbacks * Added the snapshots for Mac and Windows * Remove .NET 8 specific code for templates (#30342) * [Catalyst] Fix Scrollbar does not align with FlowDirection change in ScrollView (#30241) * fix added * Revert "fix added" This reverts commit 138797f. * fix added * fix updated * [Android] Fix for OnSizeAllocated is not reported for Android AppShell Flyout content. (#30069) * fix-22045 - Made changes on Android ShellFlyout sizing by adding OnDrawerOpened event and updating Content so OnSizeAllocated is called with correct values when drawer opens. * fix-22045- Set the contentview frame value when the FlyoutView layout change. * fix-22045- Changes committed. * Permissions (BT & WiFi): don't add AccessFineLocation to required permissions if NeverForLocation flag is present (#20874) * otherwise the permission-status will be 'denied' if AccessFineLocation is in the manifest, but denied at runtime (even if it is not strictly required) * Fixed the RealParent Warning shown issue (#30156) * Safe Get of RealParent to avoid warnings * Optimized the fix * Make it as default private * Optimized the fix * Modified the fix and added test * Modified the fix based on concern and added test * unwanted spacing * Replaced the Parent property directly * [iOS/MacCatalyst] Fix: Setting SelectedItem Programmatically and Then Immediately Setting ItemsSource to Null Causes a Crash (#29940) * Re-evaluate indexpaths in PerformBatchUpdates * Add UI test * update test * bring back null check * add a check to see if ItemsSource is disposed * [Windows] Fixed StackLayout crashes on Windows with HeightRequest as 0 (#29926) * Fixed StackLayout crashes on Windows with HeightRequest 0, padding, and opposing alignment. * Included test case for Vertical StackLayout * Updated label content * [Windows] Fixed CanvasDrawingSession Exception on Clipping Image (#30028) * [Windows] Fixed CanvasDrawingSession Exception * Update in description label * Updated Suggested Changes * [Testing] Feature matrix UITest Cases for ScrollView Control (#30188) * Added Feature Matrix for ScrollView * Updated changes * Changes updated * Modified the test cases * Modified UI * Added snapshots * Added images * Modified Test Case * Added images * Resaved images * [Testing] Feature Matrix UITest Cases for TimePicker Control (#30271) * modified UI and test cases * updated test cases * added new test cases * updated test cases * added android and iOS snapshots * updated format * updated flow direction code * added mac and windows snapshots * updated iOS snapshots * [Catalyst] Adding and Removing ContextMenus currently does not work - fix (#30307) * Disconnect context flyout handler * Update MenuFlyoutHandler.iOS.cs * Fix for TapGestureRecognizer ButtonMask always return 0 (#30372) * Fix for TapGesture ButtonMask * Added TestCase * Update Testcase * Modified Testcase * fix extention typo (#30461) * fix some incorrect casting using `as` (#30459) if the type is known then a direct cast should be used instead of an as. since, in the case where the assumption is wrong, then it is better to get a cast exception instead of a null ref exception. basically if code uses `as` and does not check for null when that variable is used, then it is likely problematic code. * [Testing] Feature Matrix UITest Cases for SearchBar Control (#30398) * added test cases * added snapshots * comment added * snapshot added * changed method name * [Testing] Feature Matrix UITest Cases for DatePicker Control (#30159) * added test cases * added new test cases * removed test cases * updated test cases * updated test cases * changes in test case * added new event * updated test cases * added culture test cases * added snapshots * added the failing condition * modified test case * added new test case code * added mac and windows snapshots * [create-pull-request] automated change (#30591) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> # Conflicts: # src/Compatibility/Core/src/Tizen/Forms.cs * [Testing] Add UITest for Issue30147 on iOS (#30506) * fix added * Revert "fix added" This reverts commit 138797f. * test case added * test sample modified * test sample updated * affected platform changed * sample changes added * [Android] Fix for Search Handler visual and functional bug in subtabs (#30467) * fix-21119-Made changes to ShellToolbarTracker.cs to prevent search handler stacking on Android Shell tab navigation by removing existing menu items before adding new ones. * fix-21119-Testcase and test snapshot added. * fix-21119-Updated code changes. Also added Mac and Windows snapshots. * [Windows] Fixed the Pasted Password Becomes Visible When IsPassword Is Enabled (#30353) * Fixed the masked text issue of same value pasted into the textbox field * Added the test for verifying the masked text * [create-pull-request] automated change (#30700) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False (#30755) * Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False * Updated PlatformTouchGraphicsView * Updated test sample * Fix duplicate app icon resizing (#30920) Possibly helps with #30900 * Addressed the feedbacks * Added sample for GraphicsView * Added the feature matrix code * Added the test cases for the GraphicsView * Updated the GraphicsViewFeaturetests * Updated the GraphicsViewViewModel * Addressed the feedbacks * Added the snapshots for Mac and Windows * Addressed the feedbacks --------- Co-authored-by: Gerald Versluis <gerald.versluis@microsoft.com> Co-authored-by: devanathan-vaithiyanathan <114395405+devanathan-vaithiyanathan@users.noreply.github.com> Co-authored-by: BagavathiPerumal <93652794+BagavathiPerumal@users.noreply.github.com> Co-authored-by: Janus Weil <janus@gcc.gnu.org> Co-authored-by: Ahamed-Ali <102580874+Ahamed-Ali@users.noreply.github.com> Co-authored-by: Bhavanesh N <bhavanesh001@gmail.com> Co-authored-by: Dhivya-SF4094 <127717131+Dhivya-SF4094@users.noreply.github.com> Co-authored-by: Subhiksha Chandrasekaran <subhiksha.c@syncfusion.com> Co-authored-by: NafeelaNazhir <nafeela.nazhirhussain@syncfusion.com> Co-authored-by: TamilarasanSF4853 <tamilarasan.velu@syncfusion.com> Co-authored-by: Jakub Florkowski <42434498+kubaflo@users.noreply.github.com> Co-authored-by: HarishwaranVijayakumar <harishwaran.vijayakumar@syncfusion.com> Co-authored-by: Simon Cropp <simon.cropp@gmail.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Shane Neuville <shneuvil@microsoft.com> Co-authored-by: Jeremy Powell <47993233+jeremy-visionaid@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note
Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!
Root Cause
The exception CanvasDrawingSessionException occurred because the Canvas state was not reset after drawing
Description of Change
Added a call to _canvas.ResetState() in the OnDraw method to ensure the canvas state is properly reset after drawing.
Tested the behavior in the following platforms:
Issues Fixed
Fixes #18430
Screenshot