Add alpha blending for wxImage::Paste
Add test cases for wxImage::Paste. Closes #12458. Co-Authored-By: Rachel Mark <kramdar@gmail.com>
@@ -1454,6 +1454,321 @@ void ImageTestCase::ScaleCompare()
|
||||
|
||||
#endif //wxUSE_IMAGE
|
||||
|
||||
TEST_CASE("wxImage::Paste", "[image][paste]")
|
||||
{
|
||||
const static char* squares_xpm[] =
|
||||
{
|
||||
"9 9 7 1",
|
||||
" c None",
|
||||
"y c #FF0000",
|
||||
"r c #FF0000",
|
||||
"g c #00FF00",
|
||||
"b c #0000FF",
|
||||
"o c #FF6600",
|
||||
"w c #FFFFFF",
|
||||
"rrrrwgggg",
|
||||
"rrrrwgggg",
|
||||
"rrrrwgggg",
|
||||
"rrrrwgggg",
|
||||
"wwwwwwwww",
|
||||
"bbbbwoooo",
|
||||
"bbbbwoooo",
|
||||
"bbbbwoooo",
|
||||
"bbbbwoooo"
|
||||
};
|
||||
|
||||
const static char* toggle_equal_size_xpm[] =
|
||||
{
|
||||
"9 9 2 1",
|
||||
" c None",
|
||||
"y c #FF0000",
|
||||
"y y y y y",
|
||||
" y y y y ",
|
||||
"y y y y y",
|
||||
" y y y y ",
|
||||
"y y y y y",
|
||||
" y y y y ",
|
||||
"y y y y y",
|
||||
" y y y y ",
|
||||
"y y y y y",
|
||||
};
|
||||
|
||||
SECTION("Paste same size image")
|
||||
{
|
||||
wxImage actual(squares_xpm);
|
||||
wxImage paste(toggle_equal_size_xpm);
|
||||
wxImage expected(toggle_equal_size_xpm);
|
||||
actual.Paste(paste, 0, 0);
|
||||
CHECK_THAT(actual, RGBSameAs(expected));
|
||||
}
|
||||
|
||||
SECTION("Paste larger image")
|
||||
{
|
||||
const static char* toggle_larger_size_xpm[] =
|
||||
{
|
||||
"13 13 2 1",
|
||||
" c None",
|
||||
"y c #FF0000",
|
||||
"y y y y y y y",
|
||||
" y y y y y y ",
|
||||
"y y y y y y y",
|
||||
" y y y y y y ",
|
||||
"y y y y y y y",
|
||||
" y y y y y y ",
|
||||
"y y y y y y y",
|
||||
" y y y y y y ",
|
||||
"y y y y y y y",
|
||||
" y y y y y y ",
|
||||
"y y y y y y y",
|
||||
" y y y y y y ",
|
||||
"y y y y y y y",
|
||||
};
|
||||
|
||||
wxImage actual(squares_xpm);
|
||||
wxImage paste(toggle_larger_size_xpm);
|
||||
wxImage expected(toggle_equal_size_xpm);
|
||||
actual.Paste(paste, -2, -2);
|
||||
CHECK_THAT(actual, RGBSameAs(expected));
|
||||
}
|
||||
|
||||
SECTION("Paste smaller image")
|
||||
{
|
||||
const static char* toggle_smaller_size_xpm[] =
|
||||
{
|
||||
"5 5 2 1",
|
||||
" c None",
|
||||
"y c #FF0000",
|
||||
"y y y",
|
||||
" y y ",
|
||||
"y y y",
|
||||
" y y ",
|
||||
"y y y",
|
||||
};
|
||||
|
||||
const static char* expected_xpm[] =
|
||||
{
|
||||
"9 9 7 1",
|
||||
" c None",
|
||||
"y c #FF0000",
|
||||
"r c #FF0000",
|
||||
"g c #00FF00",
|
||||
"b c #0000FF",
|
||||
"o c #FF6600",
|
||||
"w c #FFFFFF",
|
||||
"rrrrwgggg",
|
||||
"rrrrwgggg",
|
||||
"rry y ygg",
|
||||
"rr y y gg",
|
||||
"wwy y yww",
|
||||
"bb y y oo",
|
||||
"bby y yoo",
|
||||
"bbbbwoooo",
|
||||
"bbbbwoooo"
|
||||
};
|
||||
|
||||
wxImage actual(squares_xpm);
|
||||
wxImage paste(toggle_smaller_size_xpm);
|
||||
wxImage expected(expected_xpm);
|
||||
actual.Paste(paste, 2, 2);
|
||||
CHECK_THAT(actual, RGBSameAs(expected));
|
||||
}
|
||||
|
||||
SECTION("Paste beyond top left corner")
|
||||
{
|
||||
const static char* expected_xpm[] =
|
||||
{
|
||||
"9 9 7 1",
|
||||
" c None",
|
||||
"y c #FF0000",
|
||||
"r c #FF0000",
|
||||
"g c #00FF00",
|
||||
"b c #0000FF",
|
||||
"o c #FF6600",
|
||||
"w c #FFFFFF",
|
||||
"oooowgggg",
|
||||
"oooowgggg",
|
||||
"oooowgggg",
|
||||
"oooowgggg",
|
||||
"wwwwwwwww",
|
||||
"bbbbwoooo",
|
||||
"bbbbwoooo",
|
||||
"bbbbwoooo",
|
||||
"bbbbwoooo"
|
||||
};
|
||||
|
||||
wxImage actual(squares_xpm);
|
||||
wxImage paste(squares_xpm);
|
||||
wxImage expected(expected_xpm);
|
||||
actual.Paste(paste, -5, -5);
|
||||
CHECK_THAT(actual, RGBSameAs(expected));
|
||||
}
|
||||
|
||||
SECTION("Paste beyond top right corner")
|
||||
{
|
||||
const static char* expected_xpm[] =
|
||||
{
|
||||
"9 9 7 1",
|
||||
" c None",
|
||||
"y c #FF0000",
|
||||
"r c #FF0000",
|
||||
"g c #00FF00",
|
||||
"b c #0000FF",
|
||||
"o c #FF6600",
|
||||
"w c #FFFFFF",
|
||||
"rrrrwbbbb",
|
||||
"rrrrwbbbb",
|
||||
"rrrrwbbbb",
|
||||
"rrrrwbbbb",
|
||||
"wwwwwwwww",
|
||||
"bbbbwoooo",
|
||||
"bbbbwoooo",
|
||||
"bbbbwoooo",
|
||||
"bbbbwoooo"
|
||||
};
|
||||
wxImage actual(squares_xpm);
|
||||
wxImage paste(squares_xpm);
|
||||
wxImage expected(expected_xpm);
|
||||
actual.Paste(paste, 5, -5);
|
||||
CHECK_THAT(actual, RGBSameAs(expected));
|
||||
}
|
||||
|
||||
SECTION("Paste beyond bottom right corner")
|
||||
{
|
||||
const static char* expected_xpm[] =
|
||||
{
|
||||
"9 9 7 1",
|
||||
" c None",
|
||||
"y c #FF0000",
|
||||
"r c #FF0000",
|
||||
"g c #00FF00",
|
||||
"b c #0000FF",
|
||||
"o c #FF6600",
|
||||
"w c #FFFFFF",
|
||||
"rrrrwgggg",
|
||||
"rrrrwgggg",
|
||||
"rrrrwgggg",
|
||||
"rrrrwgggg",
|
||||
"wwwwwwwww",
|
||||
"bbbbwrrrr",
|
||||
"bbbbwrrrr",
|
||||
"bbbbwrrrr",
|
||||
"bbbbwrrrr"
|
||||
};
|
||||
wxImage actual(squares_xpm);
|
||||
wxImage paste(squares_xpm);
|
||||
wxImage expected(expected_xpm);
|
||||
actual.Paste(paste, 5, 5);
|
||||
CHECK_THAT(actual, RGBSameAs(expected));
|
||||
}
|
||||
|
||||
SECTION("Paste beyond bottom left corner")
|
||||
{
|
||||
const static char* expected_xpm[] =
|
||||
{
|
||||
"9 9 7 1",
|
||||
" c None",
|
||||
"y c #FF0000",
|
||||
"r c #FF0000",
|
||||
"g c #00FF00",
|
||||
"b c #0000FF",
|
||||
"o c #FF6600",
|
||||
"w c #FFFFFF",
|
||||
"rrrrwgggg",
|
||||
"rrrrwgggg",
|
||||
"rrrrwgggg",
|
||||
"rrrrwgggg",
|
||||
"wwwwwwwww",
|
||||
"ggggwoooo",
|
||||
"ggggwoooo",
|
||||
"ggggwoooo",
|
||||
"ggggwoooo"
|
||||
};
|
||||
wxImage actual(squares_xpm);
|
||||
wxImage paste(squares_xpm);
|
||||
wxImage expected(expected_xpm);
|
||||
actual.Paste(paste, -5, 5);
|
||||
CHECK_THAT(actual, RGBSameAs(expected));
|
||||
}
|
||||
|
||||
wxImage::AddHandler(new wxPNGHandler());
|
||||
wxImage background("image/paste_input_background.png");
|
||||
CHECK(background.IsOk());
|
||||
wxImage opaque_square("image/paste_input_overlay_transparent_border_opaque_square.png");
|
||||
CHECK(opaque_square.IsOk());
|
||||
wxImage transparent_square("image/paste_input_overlay_transparent_border_semitransparent_square.png");
|
||||
CHECK(transparent_square.IsOk());
|
||||
wxImage transparent_circle("image/paste_input_overlay_transparent_border_semitransparent_circle.png");
|
||||
CHECK(transparent_circle.IsOk());
|
||||
|
||||
SECTION("Paste fully opaque image onto blank image without alpha")
|
||||
{
|
||||
wxImage actual(background.GetSize());
|
||||
actual.Paste(background, 0, 0, wxIMAGE_ALPHA_BLEND_COMPOSE);
|
||||
CHECK_THAT(actual, RGBSameAs(background));
|
||||
CHECK(!actual.HasAlpha());
|
||||
}
|
||||
SECTION("Paste fully opaque image onto blank image with alpha")
|
||||
{
|
||||
wxImage actual(background.GetSize());
|
||||
actual.InitAlpha();
|
||||
actual.Paste(background, 0, 0, wxIMAGE_ALPHA_BLEND_COMPOSE);
|
||||
CHECK_THAT(actual, RGBSameAs(background));
|
||||
CHECK_THAT(actual, CenterAlphaPixelEquals(wxALPHA_OPAQUE));
|
||||
}
|
||||
SECTION("Paste fully transparent image")
|
||||
{
|
||||
wxImage actual = background.Copy();
|
||||
wxImage transparent(actual.GetSize());
|
||||
transparent.InitAlpha();
|
||||
memset(transparent.GetAlpha(), 0, transparent.GetWidth() * transparent.GetHeight());
|
||||
actual.Paste(transparent, 0, 0, wxIMAGE_ALPHA_BLEND_COMPOSE);
|
||||
CHECK_THAT(actual, RGBSameAs(background));
|
||||
CHECK_THAT(actual, CenterAlphaPixelEquals(wxALPHA_OPAQUE));
|
||||
}
|
||||
SECTION("Paste image with transparent region")
|
||||
{
|
||||
wxImage actual = background.Copy();
|
||||
actual.Paste(opaque_square, 0, 0, wxIMAGE_ALPHA_BLEND_COMPOSE);
|
||||
CHECK_THAT(actual, RGBSameAs(wxImage("image/paste_result_background_plus_overlay_transparent_border_opaque_square.png")));
|
||||
CHECK_THAT(actual, CenterAlphaPixelEquals(wxALPHA_OPAQUE));
|
||||
}
|
||||
SECTION("Paste image with semi transparent region")
|
||||
{
|
||||
wxImage actual = background.Copy();
|
||||
actual.Paste(transparent_square, 0, 0, wxIMAGE_ALPHA_BLEND_COMPOSE);
|
||||
CHECK_THAT(actual, RGBSameAs(wxImage("image/paste_result_background_plus_overlay_transparent_border_semitransparent_square.png")));
|
||||
CHECK_THAT(actual, CenterAlphaPixelEquals(wxALPHA_OPAQUE));
|
||||
}
|
||||
SECTION("Paste two semi transparent images on top of background")
|
||||
{
|
||||
wxImage actual = background.Copy();
|
||||
actual.Paste(transparent_circle, 0, 0, wxIMAGE_ALPHA_BLEND_COMPOSE);
|
||||
actual.Paste(transparent_square, 0, 0, wxIMAGE_ALPHA_BLEND_COMPOSE);
|
||||
CHECK_THAT(actual, RGBSimilarTo(wxImage("image/paste_result_background_plus_circle_plus_square.png"), 1));
|
||||
CHECK_THAT(actual, CenterAlphaPixelEquals(wxALPHA_OPAQUE));
|
||||
}
|
||||
SECTION("Paste two semi transparent images together first, then on top of background")
|
||||
{
|
||||
wxImage circle = transparent_circle.Copy();
|
||||
wxImage actual = background.Copy();
|
||||
circle.Paste(transparent_square, 0, 0, wxIMAGE_ALPHA_BLEND_COMPOSE);
|
||||
actual.Paste(circle, 0, 0, wxIMAGE_ALPHA_BLEND_COMPOSE);
|
||||
// When applied in this order, two times a rounding difference is triggered.
|
||||
CHECK_THAT(actual, RGBSimilarTo(wxImage("image/paste_result_background_plus_circle_plus_square.png"), 2));
|
||||
CHECK_THAT(actual, CenterAlphaPixelEquals(wxALPHA_OPAQUE));
|
||||
}
|
||||
SECTION("Paste semitransparent image over transparent image")
|
||||
{
|
||||
wxImage actual(transparent_circle.GetSize());
|
||||
actual.InitAlpha();
|
||||
memset(actual.GetAlpha(), 0, actual.GetWidth() * actual.GetHeight());
|
||||
actual.Paste(transparent_circle, 0, 0, wxIMAGE_ALPHA_BLEND_COMPOSE);
|
||||
CHECK_THAT(actual, CenterAlphaPixelEquals(192));
|
||||
actual.Paste(transparent_square, 0, 0, wxIMAGE_ALPHA_BLEND_COMPOSE);
|
||||
CHECK_THAT(actual, RGBSimilarTo(wxImage("image/paste_result_no_background_square_over_circle.png"), 1));
|
||||
CHECK_THAT(actual, CenterAlphaPixelEquals(224));
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
TODO: add lots of more tests to wxImage functions
|
||||
|
BIN
tests/image/paste_input_background.png
Normal file
After Width: | Height: | Size: 410 B |
After Width: | Height: | Size: 263 B |
After Width: | Height: | Size: 1.6 KiB |
After Width: | Height: | Size: 330 B |
BIN
tests/image/paste_result_background_plus_circle_plus_square.png
Normal file
After Width: | Height: | Size: 1.2 KiB |
After Width: | Height: | Size: 265 B |
After Width: | Height: | Size: 560 B |
BIN
tests/image/paste_result_no_background_square_over_circle.png
Normal file
After Width: | Height: | Size: 1.6 KiB |
@@ -30,8 +30,9 @@ namespace Catch
|
||||
class ImageRGBMatcher : public Catch::MatcherBase<wxImage>
|
||||
{
|
||||
public:
|
||||
ImageRGBMatcher(const wxImage& image)
|
||||
ImageRGBMatcher(const wxImage& image, int tolerance)
|
||||
: m_image(image)
|
||||
, m_tolerance(tolerance)
|
||||
{
|
||||
}
|
||||
|
||||
@@ -53,7 +54,8 @@ public:
|
||||
{
|
||||
for ( int y = 0; y < m_image.GetHeight(); ++y )
|
||||
{
|
||||
if ( *d1 != *d2 )
|
||||
const unsigned char diff = *d1 > * d2 ? *d1 - *d2 : *d2 - *d1;
|
||||
if (diff > m_tolerance)
|
||||
{
|
||||
m_diffDesc.Printf
|
||||
(
|
||||
@@ -72,11 +74,11 @@ public:
|
||||
}
|
||||
}
|
||||
|
||||
// We should never get here as we know that the images are different
|
||||
// and so should have returned from inside the loop above.
|
||||
wxFAIL_MSG("unreachable");
|
||||
// We can only get here when the images are different AND we've not exited the
|
||||
// method from the loop. That implies the tolerance must have caused this.
|
||||
wxASSERT_MSG(m_tolerance > 0, "Unreachable without tolerance");
|
||||
|
||||
return false;
|
||||
return true;
|
||||
}
|
||||
|
||||
std::string describe() const wxOVERRIDE
|
||||
@@ -92,12 +94,67 @@ public:
|
||||
|
||||
private:
|
||||
const wxImage m_image;
|
||||
const int m_tolerance;
|
||||
mutable wxString m_diffDesc;
|
||||
};
|
||||
|
||||
inline ImageRGBMatcher RGBSameAs(const wxImage& image)
|
||||
{
|
||||
return ImageRGBMatcher(image);
|
||||
return ImageRGBMatcher(image, 0);
|
||||
}
|
||||
|
||||
// Allows small differences (within given tolerance) for r, g, and b values.
|
||||
inline ImageRGBMatcher RGBSimilarTo(const wxImage& image, int tolerance)
|
||||
{
|
||||
return ImageRGBMatcher(image, tolerance);
|
||||
}
|
||||
|
||||
class ImageAlphaMatcher : public Catch::MatcherBase<wxImage>
|
||||
{
|
||||
public:
|
||||
ImageAlphaMatcher(unsigned char alpha)
|
||||
: m_alpha(alpha)
|
||||
{
|
||||
}
|
||||
|
||||
bool match(const wxImage& other) const wxOVERRIDE
|
||||
{
|
||||
if (!other.HasAlpha())
|
||||
{
|
||||
m_diffDesc = "no alpha data";
|
||||
return false;
|
||||
}
|
||||
|
||||
unsigned char center_alpha =
|
||||
*(other.GetAlpha() + (other.GetWidth() / 2) + (other.GetHeight() / 2 * other.GetWidth()));
|
||||
|
||||
if (m_alpha != center_alpha)
|
||||
{
|
||||
m_diffDesc.Printf("got alpha %u", center_alpha);
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
std::string describe() const wxOVERRIDE
|
||||
{
|
||||
std::string desc;
|
||||
|
||||
if (!m_diffDesc.empty())
|
||||
desc = m_diffDesc.ToStdString(wxConvUTF8);
|
||||
|
||||
return desc;
|
||||
}
|
||||
|
||||
private:
|
||||
const unsigned char m_alpha;
|
||||
mutable wxString m_diffDesc;
|
||||
};
|
||||
|
||||
inline ImageAlphaMatcher CenterAlphaPixelEquals(unsigned char alpha)
|
||||
{
|
||||
return ImageAlphaMatcher(alpha);
|
||||
}
|
||||
|
||||
#endif // _WX_TESTS_TESTIMAGE_H_
|
||||
|