Merge branch 'master' into loek/audio

16 files changed, 162 insertions, 69 deletions

diff --git a/Doxyfile b/Doxyfile
index f2714cd..07c86d1 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -17,11 +17,10 @@ GENERATE_LATEX = NO
 LAYOUT_FILE = src/doc/layout.xml
 TAB_SIZE = 2
 
-HTML_INDEX_NUM_ENTRIES = 2
+HTML_INDEX_NUM_ENTRIES = 999
 HTML_EXTRA_STYLESHEET = src/doc/style.css
 SHOW_HEADERFILE = NO
 
-USE_MDFILE_AS_MAINPAGE = ./readme.md
 REPEAT_BRIEF = NO
 
 EXTRACT_STATIC = YES
@@ -29,6 +28,7 @@ HIDE_UNDOC_NAMESPACES = YES
 HIDE_UNDOC_CLASSES = YES
 
 QUIET = YES
+WARNINGS = NO
 
 # set these to NO for user-only docs
 INTERNAL_DOCS = YES
diff --git a/asset/texture/img.png b/asset/texture/img.png
index 43b1eca..649a3f1 100644
--- a/asset/texture/img.png
+++ b/asset/texture/img.png
diff --git a/contributing.md b/contributing.md
index b0f623b..7dedaa7 100644
--- a/contributing.md
+++ b/contributing.md
@@ -635,15 +635,21 @@ that you can click on to open them.
   </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
 
   ```cpp
+  void Foo::bar() { }
+
   void Foo::set_value(int value) {
     this->value = value;
+    this->bar();
   }
   ```
   </td><td>
 
   ```cpp
+  void Foo::bar() { }
+
   void Foo::set_value(int new_value) {
     value = new_value;
+    bar();
   }
   ```
   </td></tr></table></details>
@@ -868,6 +874,8 @@ that you can click on to open them.
 
 # Documentation
 
+[Doxygen commands](https://www.doxygen.nl/manual/commands.html)
+
 - All documentation is written in U.S. English
 - <details><summary>
   Doxygen commands are used with a backslash instead of an at-sign.
@@ -953,6 +961,52 @@ that you can click on to open them.
   Foo & operator=(Foo &&) = delete;
   ```
   </td></tr></table></details>
+- Do not use markdown headings in Doxygen
+
+## Documenting features
+
+Engine features are small 'building blocks' that the user (game developer) may
+reference when building a game with the engine. Features do not necessarily map
+1-1 to engine components or systems. If a component or system has a single,
+distinct feature it should be named after that feature, not the component or
+system itself.
+
+The sources for these pages are located under `src/doc/feature/`, and have the
+following format:
+
+- A feature description which explains—
+  - the purpose and function of the feature (focus on what it enables or
+    achieves for the user)
+  - additional information about when to implement the feature, such as specific
+    use cases or scenarios
+- A list of 'see also' references to relevant classes and/or types
+- A **minimal** example to demonstrate how the feature is used. The example
+  should be written such that the following is clear to the reader:
+  - Which headers need to be included to utilize the feature
+  - *Why* the example works, not what is happening in the example
+  - Where is this code supposed to be called (e.g. inside scene/script
+    functions)
+  - Which restrictions should be kept in mind (e.g. copy/move semantics, max
+    component instances, speed considerations)
+
+Features should be documented as clear and concise as possible, so the following
+points should be kept in mind:
+
+- <details><summary>
+  If a page expands on an example from another page, directly reference the
+  other page using a cross-reference (`\ref`) in a `\note` block at the top of
+  the page.
+  </summary>
+
+  ```
+  \note This page builds on top of the example shown in \ref feature_script
+  ```
+  </details>
+- When explaining the usage of specific functions, qualify them such that
+  Doxygen is able to add a cross-reference or manually add a reference using the
+  `\ref` command.
+- Users will likely copy-paste examples as-is, so do this yourself to check if
+  the example code actually works!
 
 # Libraries
 
@@ -960,4 +1014,6 @@ that you can click on to open them.
   subdirectory
 - When adding new submodules, please set the `shallow` option to `true` in the
   [.gitmodules](./.gitmodules) file
+- When adding new libraries, please update the library version table in
+  [readme\.md](./readme.md)
 
diff --git a/src/crepe/api/Sprite.cpp b/src/crepe/api/Sprite.cpp
index 8647794..0a2ad4c 100644
--- a/src/crepe/api/Sprite.cpp
+++ b/src/crepe/api/Sprite.cpp
@@ -22,8 +22,8 @@ Sprite::Sprite(game_object_id_t id, Texture & image, const Color & color,
 
 	dbg_trace();
 
-	this->mask.w = sprite_image.get_width();
-	this->mask.h = sprite_image.get_height();
+	this->mask.w = sprite_image.get_size().x;
+	this->mask.h = sprite_image.get_size().y;
 	this->aspect_ratio = static_cast<double>(this->mask.w) / this->mask.h;
 }
 
diff --git a/src/crepe/api/Texture.cpp b/src/crepe/api/Texture.cpp
index e43bdaa..2b56271 100644
--- a/src/crepe/api/Texture.cpp
+++ b/src/crepe/api/Texture.cpp
@@ -3,6 +3,7 @@
 
 #include "Asset.h"
 #include "Texture.h"
+#include "types.h"
 
 using namespace crepe;
 using namespace std;
@@ -31,11 +32,7 @@ void Texture::load(const Asset & res) {
 	this->texture = ctx.texture_from_path(res.get_path());
 }
 
-int Texture::get_width() const {
-	if (this->texture == nullptr) return 0;
-	return SDLContext::get_instance().get_width(*this);
-}
-int Texture::get_height() const {
-	if (this->texture == nullptr) return 0;
-	return SDLContext::get_instance().get_height(*this);
+ivec2 Texture::get_size() const {
+	if (this->texture == nullptr) return {};
+	return SDLContext::get_instance().get_size(*this);
 }
diff --git a/src/crepe/api/Texture.h b/src/crepe/api/Texture.h
index 7206a66..1817910 100644
--- a/src/crepe/api/Texture.h
+++ b/src/crepe/api/Texture.h
@@ -8,6 +8,7 @@
 #include <memory>
 
 #include "Asset.h"
+#include "types.h"
 
 namespace crepe {
 
@@ -42,16 +43,10 @@ public:
 	Texture & operator=(const Texture &) = delete;
 
 	/**
-	 * \brief Gets the width of the texture.
-	 * \return Width of the texture in pixels.
+	 * \brief Gets the width and height of the texture.
+	 * \return Width and height of the texture in pixels.
 	 */
-	int get_width() const;
-
-	/**
-	 * \brief Gets the height of the texture.
-	 * \return Height of the texture in pixels.
-	 */
-	int get_height() const;
+	ivec2 get_size() const;
 
 private:
 	/**
diff --git a/src/crepe/facade/SDLContext.cpp b/src/crepe/facade/SDLContext.cpp
index 9f60285..e8be7ca 100644
--- a/src/crepe/facade/SDLContext.cpp
+++ b/src/crepe/facade/SDLContext.cpp
@@ -1,4 +1,5 @@
 #include <SDL2/SDL.h>
+#include <SDL2/SDL_blendmode.h>
 #include <SDL2/SDL_image.h>
 #include <SDL2/SDL_keycode.h>
 #include <SDL2/SDL_rect.h>
@@ -7,7 +8,9 @@
 #include <SDL2/SDL_video.h>
 #include <cmath>
 #include <cstddef>
+#include <cstdint>
 #include <functional>
+#include <iostream>
 #include <memory>
 #include <stdexcept>
 
@@ -18,6 +21,7 @@
 #include "../util/Log.h"
 
 #include "SDLContext.h"
+#include "api/Color.h"
 #include "types.h"
 
 using namespace crepe;
@@ -134,6 +138,7 @@ void SDLContext::draw(const RenderContext & ctx) {
 	SDL_Rect dstrect
 		= this->get_dst_rect(ctx.sprite, ctx.pos, ctx.cam, ctx.cam_pos, ctx.scale);
 
+	this->set_color_texture(ctx.sprite.sprite_image, ctx.sprite.color);
 	SDL_RenderCopyEx(this->game_renderer.get(), ctx.sprite.sprite_image.texture.get(),
 					 &srcrect, &dstrect, ctx.angle, NULL, render_flip);
 }
@@ -207,16 +212,19 @@ SDLContext::texture_from_path(const std::string & path) {
 	std::unique_ptr<SDL_Texture, std::function<void(SDL_Texture *)>> img_texture;
 	img_texture = {tmp_texture, [](SDL_Texture * texture) { SDL_DestroyTexture(texture); }};
 
+	SDL_SetTextureBlendMode(img_texture.get(), SDL_BLENDMODE_BLEND);
 	return img_texture;
 }
-int SDLContext::get_width(const Texture & ctx) const {
-	int w;
-	SDL_QueryTexture(ctx.texture.get(), NULL, NULL, &w, NULL);
-	return w;
-}
-int SDLContext::get_height(const Texture & ctx) const {
-	int h;
-	SDL_QueryTexture(ctx.texture.get(), NULL, NULL, NULL, &h);
-	return h;
+
+ivec2 SDLContext::get_size(const Texture & ctx) {
+	ivec2 size;
+	SDL_QueryTexture(ctx.texture.get(), NULL, NULL, &size.x, &size.y);
+	return size;
 }
+
 void SDLContext::delay(int ms) const { SDL_Delay(ms); }
+
+void SDLContext::set_color_texture(const Texture & texture, const Color & color) {
+	SDL_SetTextureColorMod(texture.texture.get(), color.r, color.g, color.b);
+	SDL_SetTextureAlphaMod(texture.texture.get(), color.a);
+}
diff --git a/src/crepe/facade/SDLContext.h b/src/crepe/facade/SDLContext.h
index 6030a6e..e49ca78 100644
--- a/src/crepe/facade/SDLContext.h
+++ b/src/crepe/facade/SDLContext.h
@@ -12,6 +12,8 @@
 #include "../api/Camera.h"
 #include "../api/Sprite.h"
 
+#include "api/Color.h"
+#include "api/Texture.h"
 #include "types.h"
 
 namespace crepe {
@@ -104,18 +106,11 @@ private:
 	std::unique_ptr<SDL_Texture, std::function<void(SDL_Texture *)>>
 	texture_from_path(const std::string & path);
 	/**
-	 * \brief Gets the width of a texture.
+	 * \brief Gets the size of a texture.
 	 * \param texture Reference to the Texture object.
-	 * \return Width of the texture as an integer.
+	 * \return Width and height of the texture as an integer.
 	 */
-	int get_width(const Texture & texture) const;
-
-	/**
-	 * \brief Gets the height of a texture.
-	 * \param texture Reference to the Texture object.
-	 * \return Height of the texture as an integer.
-	 */
-	int get_height(const Texture & texture) const;
+	ivec2 get_size(const Texture & ctx);
 
 private:
 	//! Will use draw,clear_screen, present_screen, camera.
@@ -160,6 +155,13 @@ private:
 	 */
 	SDL_Rect get_dst_rect(const Sprite & sprite, const vec2 & pos, const Camera & cam,
 						  const vec2 & cam_pos, const double & img_scale) const;
+	/**
+	 * \brief Set an additional color value multiplied into render copy operations.
+	 *
+	 * \param  texture the given texture to adjust 
+	 * \param  color the color data for the texture
+	 */
+	void set_color_texture(const Texture & texture, const Color & color);
 
 private:
 	//! sdl Window
diff --git a/src/crepe/system/RenderSystem.cpp b/src/crepe/system/RenderSystem.cpp
index 0ad685c..92dba43 100644
--- a/src/crepe/system/RenderSystem.cpp
+++ b/src/crepe/system/RenderSystem.cpp
@@ -70,7 +70,7 @@ bool RenderSystem::render_particle(const Sprite & sprite, const Camera & cam,
 	bool rendering_particles = false;
 
 	for (const ParticleEmitter & em : emitters) {
-		if (!(&em.data.sprite == &sprite)) continue;
+		if (&em.data.sprite != &sprite) continue;
 		rendering_particles = true;
 		if (!em.active) continue;
 
diff --git a/src/crepe/system/RenderSystem.h b/src/crepe/system/RenderSystem.h
index e70831e..096d058 100644
--- a/src/crepe/system/RenderSystem.h
+++ b/src/crepe/system/RenderSystem.h
@@ -46,7 +46,10 @@ private:
 	 * \brief Renders all the particles on the screen from a given sprite.
 	 *
 	 * \param sprite renders the particles with given texture
-	 * \param tm the Transform component for scale
+	 * \param tm the Transform component for scale. This is not a const reference because each
+	 *  particle has a position and rotation that needs to overwrite the transform position and
+	 *  rotation without overwriting the current transform. and because the transform
+	 *  constructor is now protected i cannot make tmp inside
 	 * \return true if particles have been rendered
 	 */
 	bool render_particle(const Sprite & sprite, const Camera & cam, const double & scale);
@@ -68,13 +71,13 @@ private:
 	RefVector<Sprite> sort(RefVector<Sprite> & objs) const;
 
 	/**
-	 * \todo Include color handling for sprites.
 	 * \todo Add text rendering using SDL_ttf for text components.
 	 * \todo Implement a text component and a button component.
 	 * \todo Consider adding text input functionality.
 	 */
 
 private:
+	// FIXME: retrieve sdlcontext via mediator after #PR57
 	SDLContext & context = SDLContext::get_instance();
 
 	//! camera postion in the current scene
diff --git a/src/doc/feature/scene.dox b/src/doc/feature/scene.dox
index d81df4c..4124e37 100644
--- a/src/doc/feature/scene.dox
+++ b/src/doc/feature/scene.dox
@@ -6,10 +6,11 @@ namespace crepe {
 \ingroup feature
 \brief User-defined scenes
 
-Scenes can be used to implement game environments, and allow arbitrary game objects to be organized
-as part of the game structure. Scenes are implemented as derivative classes of Scene, which are
-added to the game using the SceneManager. Scenes describe the start of a Scene and cannot modify
-GameObjects during runtime of a Scene (use \ref feature_script "Scripting" for this purpose).
+Scenes can be used to implement game environments, and allow arbitrary game
+objects to be organized as part of the game structure. Scenes are implemented as
+derivative classes of Scene, which are added to the game using the SceneManager.
+Scenes describe the start of a Scene and cannot modify GameObjects during
+runtime of a Scene (use \ref feature_script for this purpose).
 
 \see SceneManager
 \see GameObject
@@ -18,19 +19,25 @@ GameObjects during runtime of a Scene (use \ref feature_script "Scripting" for t
 
 \par Example
 
-This example demonstrates how to define and add scenes to the loop/scene manager in the `crepe` framework.
-Each concrete scene should be derived from Scene. In the example below, the concrete scene is named MyScene.
-A concrete scene should, at least, implement (override) two methods, namely load_scene() and get_name(). The
-scene is build (using GameObjects) in the load_scene() method. GameObjects should be made using the
-component_manager::new_object(). In the example below, two GameObjects (named object1 and object2) are added
-to MyScene. object1 and object2 do not have any non-default Components attached to them, however, if needed,
-this should also be done in load_scene(). Each concrete scene must have a unique name. This unique name is
-used to load a new concrete scene (via a Script). The unique name is set using the get_name() method. In the
-example below, MyScene's unique name is my_scene.
-After setting up one or more concrete scene(s), the concrete scene(s) should be added to the loop/scene manager.
-This is done in your main(). Firstly, the LoopManager should be instantiated. Than, all the concrete scene(s)
-should be added to the loop/scene manger via loop_mgr::add_scene<>(). The templated argument should define the
-concrete scene to be added.
+This example demonstrates how to define and add scenes to the loop/scene manager
+in the `crepe` framework. Each concrete scene should be derived from Scene. In
+the example below, the concrete scene is named MyScene. A concrete scene should,
+at least, implement (override) two methods, namely load_scene() and get_name().
+The scene is build (using GameObjects) in the load_scene() method. GameObjects
+should be made using the component_manager::new_object().
+
+In the example below, two GameObjects (named object1 and object2) are added to
+MyScene. object1 and object2 do not have any non-default Components attached to
+them, however, if needed, this should also be done in load_scene(). Each
+concrete scene must have a unique name. This unique name is used to load a new
+concrete scene (via a Script). The unique name is set using the get_name()
+method. In the example below, MyScene's unique name is my_scene.
+
+After setting up one or more concrete scene(s), the concrete scene(s) should be
+added to the loop/scene manager. This is done in your main(). Firstly, the
+LoopManager should be instantiated. Than, all the concrete scene(s) should be
+added to the loop/scene manger via loop_mgr::add_scene<>(). The templated
+argument should define the concrete scene to be added.
 
 ```cpp
 #include <crepe/api/LoopManager.h>
diff --git a/src/doc/features.dox b/src/doc/features.dox
index 4786bed..21a040a 100644
--- a/src/doc/features.dox
+++ b/src/doc/features.dox
@@ -1,10 +1,28 @@
 // vim:ft=doxygen
 /**
 
+\htmlonly
+<style>
+table.memberdecls { display: none; }
+ul { margin: 1ex 0pt; }
+</style>
+\endhtmlonly
+
 \defgroup feature Features
 \brief Engine components
 
 This page lists engine features and contains usage instructions for each
 feature.
 
+\par Features
+
+- Scripting
+	- \ref feature_script \n\copybrief feature_script
+
+- Game flow management
+	- \ref feature_scene \n\copybrief feature_scene
+
+- Entity
+	- \ref feature_gameobject \n\copybrief feature_gameobject
+
 */
diff --git a/src/doc/index.dox b/src/doc/index.dox
index 5ec7889..7796f34 100644
--- a/src/doc/index.dox
+++ b/src/doc/index.dox
@@ -8,3 +8,10 @@ Welcome to the documentation for the crêpe game engine.
 \see feature
 
 */
+
+/**
+
+\namespace crepe
+\brief Engine namespace
+
+*/
diff --git a/src/doc/layout.xml b/src/doc/layout.xml
index fb4cc0c..6336655 100644
--- a/src/doc/layout.xml
+++ b/src/doc/layout.xml
@@ -11,7 +11,7 @@
 			<tab type="modulelist" visible="yes" title="" intro=""/>
 			<tab type="modulemembers" visible="yes" title="" intro=""/>
 		</tab>
-		<tab type="namespaces" visible="no" title="">
+		<tab type="namespaces" visible="yes" title="">
 			<tab type="namespacelist" visible="yes" title="" intro=""/>
 			<tab type="namespacemembers" visible="yes" title="" intro=""/>
 		</tab>
@@ -56,10 +56,10 @@
 			<interfaces title=""/>
 			<publicslots title=""/>
 			<signals title=""/>
-			<publicmethods title=""/>
-			<publicstaticmethods title=""/>
 			<publicattributes title=""/>
 			<publicstaticattributes title=""/>
+			<publicmethods title=""/>
+			<publicstaticmethods title=""/>
 			<protectedtypes title=""/>
 			<protectedslots title=""/>
 			<protectedmethods title=""/>
@@ -102,11 +102,12 @@
 	</class>
 	<namespace>
 		<briefdescription visible="yes"/>
+		<detaileddescription title=""/>
 		<memberdecl>
 			<nestednamespaces visible="yes" title=""/>
 			<constantgroups visible="yes" title=""/>
 			<interfaces visible="yes" title=""/>
-			<classes visible="yes" title=""/>
+			<classes visible="no" title=""/>
 			<concepts visible="yes" title=""/>
 			<structs visible="yes" title=""/>
 			<exceptions visible="yes" title=""/>
@@ -119,7 +120,6 @@
 			<properties title=""/>
 			<membergroups visible="yes"/>
 		</memberdecl>
-		<detaileddescription title=""/>
 		<memberdef>
 			<inlineclasses title=""/>
 			<typedefs title=""/>
diff --git a/src/doc/style.css b/src/doc/style.css
index daabd39..c12240c 100644
--- a/src/doc/style.css
+++ b/src/doc/style.css
@@ -1,6 +1,6 @@
 #titlearea,
-address {
-	display: none;
-}
+address,
+a[href="namespaces.html"]
+{ display: none; }
 
 h2.groupheader { margin-top: revert; }
diff --git a/src/example/rendering_particle.cpp b/src/example/rendering_particle.cpp
index 3a12144..349d11e 100644
--- a/src/example/rendering_particle.cpp
+++ b/src/example/rendering_particle.cpp
@@ -28,7 +28,7 @@ int main(int argc, char * argv[]) {
 	ParticleSystem psys{mgr};
 	AnimatorSystem asys{mgr};
 
-	Color color(255, 255, 255, 255);
+	Color color(255, 255, 255, 100);
 
 	auto img = Texture("asset/texture/test_ap43.png");
 	Sprite & test_sprite = game_object.add_component<Sprite>(
@@ -59,7 +59,7 @@ int main(int argc, char * argv[]) {
 	});
 	*/
 
-	auto & cam = game_object.add_component<Camera>(Color::WHITE, ivec2{1080, 720},
+	auto & cam = game_object.add_component<Camera>(Color::RED, ivec2{1080, 720},
 												   vec2{2000, 2000}, 1.0f);
 
 	/*