Browse Source

Image elements: Fix wrong dp-scaling being applied when an image is cloned through a parent element, see #310

Michael Ragazzon 3 years ago
parent
commit
6ebaa76960
2 changed files with 113 additions and 3 deletions
  1. 5 3
      Source/Core/Elements/ElementImage.cpp
  2. 108 0
      Tests/Source/UnitTests/ElementImage.cpp

+ 5 - 3
Source/Core/Elements/ElementImage.cpp

@@ -91,7 +91,7 @@ void ElementImage::OnRender()
 		GenerateGeometry();
 
 	// Render the geometry beginning at this element's content region.
-	geometry.Render(GetAbsoluteOffset(Box::CONTENT).Round());
+	geometry.Render(GetAbsoluteOffset(Box::CONTENT));
 }
 
 // Called when attributes on the element are changed.
@@ -145,9 +145,11 @@ void ElementImage::OnPropertyChange(const PropertyIdSet& changed_properties)
 
 void ElementImage::OnChildAdd(Element* child)
 {
-	if (child == this && texture_dirty)
+	// Load the texture once we have attached to the document so that it can immediately be found during the call to `Rml::GetTextureSourceList`. The
+	// texture won't actually be loaded from the backend before it is shown. However, only do this if we have an active context so that the dp-ratio
+	// can be retrieved. If there is no context now the texture loading will be deferred until the next layout update.
+	if (child == this && texture_dirty && GetContext())
 	{
-		// Load the texture once we have attached to the document
 		LoadTexture();
 	}
 }

+ 108 - 0
Tests/Source/UnitTests/ElementImage.cpp

@@ -0,0 +1,108 @@
+/*
+ * This source file is part of RmlUi, the HTML/CSS Interface Middleware
+ *
+ * For the latest information, see http://github.com/mikke89/RmlUi
+ *
+ * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
+ * Copyright (c) 2019 The RmlUi Team, and contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+#include "../Common/TestsShell.h"
+#include <RmlUi/Core/Context.h>
+#include <RmlUi/Core/Element.h>
+#include <RmlUi/Core/ElementDocument.h>
+#include <doctest.h>
+
+using namespace Rml;
+
+static const String document_wrapped_image_rml = R"(
+<rml>
+<head>
+	<title>Test</title>
+	<link type="text/rcss" href="/assets/rml.rcss"/>
+	<style>
+		body {
+			left: 0;
+			top: 0;
+			right: 0;
+			bottom: 0;
+		}
+	</style>
+</head>
+
+<body>
+<div>
+	<img src="/assets/high_scores_alien_1.tga"/>
+</div>
+</body>
+</rml>
+)";
+
+TEST_CASE("elementimage.dp_ratio")
+{
+	Context* context = TestsShell::GetContext();
+	ElementDocument* document = context->LoadDocumentFromMemory(document_wrapped_image_rml, "assets/");
+
+	Element* div = document->GetChild(0);
+	Element* img = div->GetChild(0);
+
+	document->Show();
+	const float img_width = img->GetClientWidth();
+
+	SUBCASE("basic")
+	{
+		context->SetDensityIndependentPixelRatio(2.0f);
+		context->Update();
+		CHECK(img->GetClientWidth() == 2.f * img_width);
+	}
+
+	SUBCASE("clone")
+	{
+		context->SetDensityIndependentPixelRatio(2.0f);
+		auto clone_ptr = div->Clone();
+
+		context->SetDensityIndependentPixelRatio(4.f);
+		Element* clone_div = document->AppendChild(std::move(clone_ptr));
+		Element* clone_img = clone_div->GetChild(0);
+		context->Update();
+
+		CHECK(clone_img->GetClientWidth() == 4.f * img_width);
+	}
+
+	SUBCASE("create_image")
+	{
+		context->SetDensityIndependentPixelRatio(2.0f);
+		ElementPtr new_img_ptr = document->CreateElement("img");
+		new_img_ptr->SetAttribute("src", "high_scores_alien_1.tga");
+
+		context->SetDensityIndependentPixelRatio(4.0f);
+		Element* new_img = document->AppendChild(std::move(new_img_ptr));
+		context->Update();
+
+		CHECK(new_img->GetClientWidth() == 4.f * img_width);
+	}
+
+	TestsShell::RenderLoop();
+
+	document->Close();
+	TestsShell::ShutdownShell();
+}