Browse Source

Rename 'effect' sample to 'effects'

Michael Ragazzon 1 year ago
parent
commit
97df22b45c

+ 3 - 3
CMake/SampleFileList.cmake

@@ -73,11 +73,11 @@ set(drag_SRC_FILES
     ${PROJECT_SOURCE_DIR}/Samples/basic/drag/src/main.cpp
 )
 
-set(effect_HDR_FILES
+set(effects_HDR_FILES
 )
 
-set(effect_SRC_FILES
-    ${PROJECT_SOURCE_DIR}/Samples/basic/effect/src/main.cpp
+set(effects_SRC_FILES
+    ${PROJECT_SOURCE_DIR}/Samples/basic/effects/src/main.cpp
 )
 
 set(loaddocument_HDR_FILES

+ 1 - 1
CMake/gen_samplelists.sh

@@ -7,7 +7,7 @@ hdr='set(sample_HDR_FILES'
 srcdir='${PROJECT_SOURCE_DIR}'
 srcpath=Samples
 samples=( 'shell'
-	'basic/animation' 'basic/benchmark' 'basic/bitmapfont' 'basic/customlog' 'basic/databinding' 'basic/demo' 'basic/drag' 'basic/effect' 'basic/loaddocument' 'basic/treeview' 'basic/transform'
+	'basic/animation' 'basic/benchmark' 'basic/bitmapfont' 'basic/customlog' 'basic/databinding' 'basic/demo' 'basic/drag' 'basic/effects' 'basic/loaddocument' 'basic/treeview' 'basic/transform'
 	'basic/harfbuzzshaping' 'basic/lottie' 'basic/svg'
 	'tutorial/template' 'tutorial/drag'
 	'invaders' 'luainvaders'

+ 3 - 3
CMakeLists.txt

@@ -894,7 +894,7 @@ endif()
 
 
 if(BUILD_SAMPLES)
-	set(samples treeview customlog drag loaddocument transform bitmapfont animation benchmark demo databinding effect)
+	set(samples treeview customlog drag loaddocument transform bitmapfont animation benchmark demo databinding effects)
 	set(tutorials template drag)
 
 	if(ENABLE_LOTTIE_PLUGIN)
@@ -1059,8 +1059,8 @@ if(BUILD_SAMPLES)
 	install(DIRECTORY ${PROJECT_SOURCE_DIR}/Samples/basic/demo/data
 			DESTINATION ${SAMPLES_DIR}/basic/demo
 	)
-	install(DIRECTORY ${PROJECT_SOURCE_DIR}/Samples/basic/effect/data
-			DESTINATION ${SAMPLES_DIR}/basic/effect
+	install(DIRECTORY ${PROJECT_SOURCE_DIR}/Samples/basic/effects/data
+			DESTINATION ${SAMPLES_DIR}/basic/effects
 	)
 	install(DIRECTORY ${PROJECT_SOURCE_DIR}/Samples/basic/transform/data
 			DESTINATION ${SAMPLES_DIR}/basic/transform

+ 3 - 0
Include/RmlUi/Core/EffectSpecification.h

@@ -37,6 +37,9 @@ namespace Rml {
 
 class PropertyDefinition;
 
+/**
+    Specifies properties and shorthands for effects (decorators and filters).
+ */
 class RMLUICORE_API EffectSpecification {
 public:
 	EffectSpecification();

+ 4 - 4
Samples/basic/effect/data/effect.rml → Samples/basic/effects/data/effects.rml

@@ -1,10 +1,10 @@
 <rml>
 <head>
 <link type="text/rcss" href="/assets/rml.rcss"/>
-<link type="text/rcss" href="effect_style.rcss"/>
-<title>Effect Sample</title>
+<link type="text/rcss" href="effects_style.rcss"/>
+<title>Effects Sample</title>
 <style>
-@spritesheet effect-sheet
+@spritesheet effects-sheet
 {
 	src: /assets/invader.tga;
 	icon-invader: 179px 152px 51px 39px;
@@ -123,7 +123,7 @@
 	data-style-perspective-origin-x="perspective_origin_x + '%'"
 	data-style-perspective-origin-y="perspective_origin_y + '%'"
 >
-<handle move_target="#document"><h1>Effect Sample</h1></handle>
+<handle move_target="#document"><h1>Effects Sample</h1></handle>
 <handle class="size" size_target="#document"/>
 <div id="menu_button" data-class-open="show_menu" data-event-click="show_menu = !show_menu">—<br/>—<br/>—</div>
 <div id="menu" data-if="show_menu">

+ 0 - 0
Samples/basic/effect/data/effect_style.rcss → Samples/basic/effects/data/effects_style.rcss


+ 5 - 5
Samples/basic/effect/src/main.cpp → Samples/basic/effects/src/main.cpp

@@ -46,7 +46,7 @@ int main(int /*argc*/, char** /*argv*/)
 		return -1;
 
 	// Constructs the system and render interfaces, creates a window, and attaches the renderer.
-	if (!Backend::Initialize("Effect Sample", window_width, window_height, true))
+	if (!Backend::Initialize("Effects Sample", window_width, window_height, true))
 	{
 		Shell::Shutdown();
 		return -1;
@@ -74,7 +74,7 @@ int main(int /*argc*/, char** /*argv*/)
 
 	static constexpr float perspective_max = 3000.f;
 
-	struct EffectData {
+	struct EffectsData {
 		bool show_menu = false;
 		Rml::String submenu = "filter";
 
@@ -127,14 +127,14 @@ int main(int /*argc*/, char** /*argv*/)
 
 		constructor.BindEventCallback("reset", [&data](Rml::DataModelHandle handle, Rml::Event& /*ev*/, const Rml::VariantList& /*arguments*/) {
 			if (data.submenu == "transform")
-				data.transform = EffectData::Transform{};
+				data.transform = EffectsData::Transform{};
 			else if (data.submenu == "filter")
-				data.filter = EffectData::Filter{};
+				data.filter = EffectsData::Filter{};
 			handle.DirtyAllVariables();
 		});
 	}
 
-	if (Rml::ElementDocument* document = context->LoadDocument("basic/effect/data/effect.rml"))
+	if (Rml::ElementDocument* document = context->LoadDocument("basic/effects/data/effects.rml"))
 		document->Show();
 
 	bool running = true;

+ 1 - 1
Tests/Data/VisualTests/ink_overflow_bounding_box.rml

@@ -5,7 +5,7 @@
 	<meta name="Description" content="Enables testing an element's bounding box with ink overflow and transform. The bounding box should cover all of the element's box shadows and filters, even when they have transforms applied." />
 	<meta name="Instructions" content="The bounding box of an element can be seen as the white frame in the debugger, when selecting it in the element info mode." />
 	<style>
-		@spritesheet effect-sheet
+		@spritesheet effects-sheet
 		{
 			src: /assets/invader.tga;
 			icon-invader: 179px 152px 51px 39px;