Merge branch 'master' of github.com:jhasse/jngl

src/jngl/Achievement.hpp

@@ -1,16 +1,17 @@
-// Copyright 2023 Jan Niklas Hasse <jhasse@bixense.com>
+// Copyright 2023-2024 Jan Niklas Hasse <jhasse@bixense.com>
 // For conditions of distribution and use, see copyright notice in LICENSE.txt
 /// Contains jngl::Achievement class
 /// @file
 #pragma once
 
-#include <future>
+#include <functional>
 #include <string>
 
 namespace jngl {
 
 class Sprite;
 
+/// Unlockable Achievement (also called Trophy)
 struct Achievement {
 	Achievement(std::string id, std::string name, std::string description, std::string icon,
 	            int initialValue = 0, int maxValue = 1);

src/jngl/Channel.hpp

@@ -13,6 +13,18 @@ namespace jngl {
 struct Stream;
 
 /// An audio channel, different channels could be for example: "Music", "Speech" and "Sound Effects"
+///
+/// Example:
+/// \code
+/// struct Channels : public jngl::Singleton<Channels> {
+///     jngl::Channel& main = jngl::Channel::main();
+///     jngl::Channel music;
+///     jngl::Channel speech;
+/// };
+///
+/// // somewhere else:
+/// Channels::handle().music.loop("background_music01.ogg");
+/// \endcode
 class Channel {
 public:
 	Channel();

src/jngl/SoundFile.hpp

@@ -25,7 +25,7 @@ struct SoundParams;
 /// Sound loaded from an OGG file
 ///
 /// JNGL keeps a list of loaded sound files, so there's no need for you to use this class directly -
-/// you can just use jngl::play.
+/// you can just use jngl::play or Channel::play.
 class SoundFile {
 public:
 	/// Load an OGG file called \a filename
@@ -45,10 +45,17 @@ class SoundFile {
 
 	/// Play the sound once. If called twice the sound would also play twice
 	void play();
+
+	/// Play the sound once on the Channel
 	void play(Channel&);
 
 	/// Stop the last started sound
 	void stop();
+
+	/// Stop the last started sound of this SoundFile started on the Channel
+	///
+	/// \note If not using the main Channel (i.e. Channel::main()), this method should be used
+	///       instead of stop().
 	void stop(Channel&);
 
 	/// Whether the sound is still playing at least once

src/jngl/TextLine.cpp

@@ -1,13 +1,11 @@
-// Copyright 2020-2023 Jan Niklas Hasse <jhasse@bixense.com>
+// Copyright 2020-2024 Jan Niklas Hasse <jhasse@bixense.com>
 // For conditions of distribution and use, see copyright notice in LICENSE.txt
 
 #include "TextLine.hpp"
 
 #include "../freetype.hpp"
 #include "ScaleablePixels.hpp"
 #include "font.hpp"
-#include "matrix.hpp"
-#include "screen.hpp"
 
 namespace jngl {
 

src/jngl/font.hpp

@@ -25,8 +25,8 @@ class Font {
 	/// This can be used to draw an outlined text by e.g. first drawing with a 5% stroke and then
 	/// printing the same text with 0% (or even a negative stroke) over it.
 	///
-	/// Example: To increase the size of each character by 2px for a Font with a \a size of 20px
-	/// pixel, you would pass 10.f for \a strokePercentage.
+	/// Example: To increase the size of each character by 2px for a Font with a \a size of 20px,
+	/// you would pass 10.f for \a strokePercentage.
 	Font(const std::string& filename, unsigned int size, float strokePercentage = 0);
 
 	/// Uses the font to print something at \a x \a y. The color can be specified using setFontColor.

src/sdl/window.cpp

@@ -98,9 +98,10 @@ Window::Window(const std::string& title, int width, int height, const bool fulls
 		}
 	}
 
-#ifndef __linux__ // This code was written for UWP, Emscripten and macOS (annoying HiDPI scaling by
-                  // SDL2). On Linux (GNOME) it results in the top of the window being cut off (by
-                  // the header bar height?).
+#if !defined(__linux__) || SDL_VERSION_ATLEAST(2, 30, 0)
+	// This code was written for UWP, Emscripten and macOS (annoying HiDPI scaling by SDL2). On
+	// Linux (GNOME) it results in the top of the window being cut off (by the header bar height?).
+	// The bug seems to be fixed in newer SDL2 (or GNOME) versions.
 	{
 		assert(width_ == width);
 		assert(height_ == height);