Add Unit tests for clipping functions #148
Open
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
# Description This PR adds new unit tests for SplashKit’s clipping functionality. These tests cover creating and removing clipping rectangles, handling multiple nested clipping regions, and verifying that drawing functions only affect the expected clipped area. This work addresses the current gap in our test suite, as `sktest` performs visual tests for clipping but `skunit_tests` does not yet define test cases yet. ## Type of change - [✓] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? The new tests create an off-screen bitmap, apply clipping rectangles, draw shapes, and then use `get_pixel` to confirm that only the clipped region was modified. Tests include: - Creating and removing a single clipping rectangle - Stacking multiple clipping rectangles (nested clips) - Ensuring that drawing operations affect only the active clipped area - Resetting the clip restores full drawing range Tests were run locally to verify succesful operations ## Testing Checklist - [✓] Tested with sktest - [✓] Tested with skunit_tests ## Checklist - [✓] My code follows the style guidelines of this project - [✓] I have performed a self-review of my own code - [✓] I have made corresponding changes to the documentation - [✓] My changes generate no new warnings
rory-cd
approved these changes
Dec 20, 2025
rory-cd
left a comment
rory-cd
left a comment
There was a problem hiding this comment.
The new tests are well structured and easy to follow. I have added some inline suggestions for optional minor improvements. Another consideration is whether current_clip() be tested here too? That would complete the whole set of clipping functions.
Either way, this PR increases coverage for a previously untested set of functions - nicely done!
General Information
Type of Change:
- New unit tests
Code Quality
- Repository: Pull Request is made to the correct repository
- Readability: Code is easy to read and follow
- Maintainability: Code can be easily maintained or extended in the future
Functionality
- Correctness: Code meets the requirements of the task
- Impact on Existing Functionality: Impact on existing functionality been considered and tested
Testing
- Test Coverage: Unit tests provided for new or modified code
- Test Results: All tests passed
Documentation
- Documentation: Both inline and applicable external documentation updated and clear
Pull Request Details
- PR Description: The problem being solved is clearly described
- Checklist Completion: All relevant checklist items have been reviewed and completed
|
|
||
| using namespace splashkit_lib; | ||
|
|
||
|
|
There was a problem hiding this comment.
Minor improvement: Consider removing one of the blank lines, to follow convention from the other test files.
| fill_rectangle(COLOR_BLUE, 0, 0, 40, 40, option_draw_to(bmp)); | ||
|
|
||
| REQUIRE(pixel_is(bmp, 25, 15, COLOR_BLUE)); | ||
|
|
There was a problem hiding this comment.
Minor improvement: Consider adding REQUIRE(pixel_is(bmp, 25, 5, COLOR_WHITE));
The current assertions test samples:
- In the intersected area
- In the original area
- Outside the original area
The suggestion would test the new area where it doesn't intersect the original.
12 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Description
This PR adds new unit tests for SplashKit’s clipping functionality.
These tests cover creating and removing clipping rectangles, handling multiple nested clipping regions, and verifying that drawing functions only affect the expected clipped area.
This work addresses the current gap in our test suite, as
sktestperforms visual tests for clipping butskunit_testsdoes not yet define test cases yet.Type of change
How Has This Been Tested?
The new tests create an off-screen bitmap, apply clipping rectangles, draw shapes, and then use
get_pixelto confirm that only the clipped region was modified. Tests include:Tests were run locally to verify succesful operations
Testing Checklist
Checklist