Merge pull request #191 from NOOBDY/aa

added anti-aliasing support and some documentation

Author: NOOBDY

include/Core/Texture.hpp

@@ -6,7 +6,7 @@
 namespace Core {
 class Texture {
 public:
-    Texture(GLint format, int width, int height, const void *data);
+    Texture(GLint format, int width, int height, const void *data, bool useAA);
     Texture(const Texture &) = delete;
     Texture(Texture &&texture);
 
@@ -21,9 +21,13 @@ class Texture {
     void Unbind() const;
 
     void UpdateData(GLint format, int width, int height, const void *data);
+    void UseAntiAliasing(bool useAA);
 
 private:
     GLuint m_TextureId;
+
+    GLenum m_MinFilter;
+    GLenum m_MagFilter;
 };
 } // namespace Core
 

include/Util/Image.hpp

@@ -12,7 +12,6 @@
 #include "Core/VertexArray.hpp"
 
 #include "Util/AssetStore.hpp"
-#include "Util/Transform.hpp"
 
 namespace Util {
 /**
@@ -29,8 +28,10 @@ class Image : public Core::Drawable {
      * @brief Constructor that takes a file path to the image.
      *
      * @param filepath The file path to the image.
+     * @param useAA Flag indicating whether anti-aliasing should be enabled
+     * (default is true).
      */
-    explicit Image(const std::string &filepath);
+    Image(const std::string &filepath, bool useAA = true);
 
     /**
      * @brief Retrieves the size of the image.
@@ -50,6 +51,20 @@ class Image : public Core::Drawable {
      */
     void SetImage(const std::string &filepath);
 
+    /**
+     * @brief Sets whether anti-aliasing (AA) should be enabled or disabled.
+     *
+     * @param useAA A boolean value indicating whether anti-aliasing should be
+     * enabled (true) or disabled (false).
+     *
+     * @note This function only sets the internal flag for anti-aliasing and
+     * does not directly affect rendering. The actual effect of anti-aliasing
+     * depends on the rendering pipeline and the graphics hardware capabilities.
+     *
+     * @sa https://en.wikipedia.org/wiki/Spatial_anti-aliasing
+     */
+    void UseAntiAliasing(bool useAA);
+
     /**
      * @brief Draws the image with a given transform and z-index.
      *

include/Util/Text.hpp

@@ -12,7 +12,6 @@
 #include "Core/VertexArray.hpp"
 
 #include "Util/Color.hpp"
-#include "Util/Transform.hpp"
 
 namespace Util {
 /**
@@ -25,8 +24,18 @@ namespace Util {
  */
 class Text : public Core::Drawable {
 public:
+    /**
+     * @brief Constructor for the Text class.
+     *
+     * @param font The font file path or name.
+     * @param size The font size.
+     * @param text The text content to render.
+     * @param color The color of the text (default is gray).
+     * @param useAA Flag indicating whether anti-aliasing should be enabled
+     * (default is true).
+     */
     Text(const std::string &font, int size, const std::string &text,
-         const Util::Color &color = Color(127, 127, 127));
+         const Util::Color &color = Color(127, 127, 127), bool useAA = true);
 
     glm::vec2 GetSize() const override { return m_Size; };
 
@@ -50,9 +59,26 @@ class Text : public Core::Drawable {
         ApplyTexture();
     };
 
+    /**
+     * @brief Sets whether anti-aliasing (AA) should be enabled or disabled.
+     *
+     * @param useAA A boolean value indicating whether anti-aliasing should be
+     * enabled (true) or disabled (false).
+     *
+     * @note This function only sets the internal flag for anti-aliasing and
+     * does not directly affect rendering. The actual effect of anti-aliasing
+     * depends on the rendering pipeline and the graphics hardware capabilities.
+     *
+     * @sa https://en.wikipedia.org/wiki/Spatial_anti-aliasing
+     */
+    void UseAntiAliasing(bool useAA);
+
     /**
      * @brief Draws the text with a given transform and z-index.
      *
+     * This function draws the image at the specified z-index and applies the
+     * given transform.
+     *
      * @param transform The transform to apply to the text.
      * @param zIndex The z-index at which to draw the text.
      */

src/Core/Texture.cpp

@@ -5,8 +5,10 @@
 #include "Util/Logger.hpp"
 
 namespace Core {
-Texture::Texture(GLint format, int width, int height, const void *data) {
+Texture::Texture(GLint format, int width, int height, const void *data,
+                 bool useAA) {
     glGenTextures(1, &m_TextureId);
+    UseAntiAliasing(useAA);
     UpdateData(format, width, height, data);
 }
 
@@ -56,7 +58,23 @@ void Texture::UpdateData(GLint format, int width, int height,
     glTexImage2D(GL_TEXTURE_2D, 0, GlFormatToGlInternalFormat(format), width,
                  height, 0, format, GL_UNSIGNED_BYTE, data);
 
-    glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
-    glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
+    glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, m_MinFilter);
+    glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, m_MagFilter);
+    glGenerateMipmap(GL_TEXTURE_2D);
+}
+
+void Texture::UseAntiAliasing(bool useAA) {
+    /**
+     * additional docs
+     * https://www.khronos.org/opengl/wiki/Texture
+     * https://www.khronos.org/opengl/wiki/Sampler_Object#Sampling_parameters
+     */
+    if (useAA) {
+        m_MinFilter = GL_LINEAR_MIPMAP_LINEAR;
+        m_MagFilter = GL_LINEAR;
+    } else {
+        m_MinFilter = GL_NEAREST_MIPMAP_NEAREST;
+        m_MagFilter = GL_NEAREST;
+    }
 }
 } // namespace Core

src/Util/Image.cpp

@@ -6,7 +6,6 @@
 #include "Core/Texture.hpp"
 #include "Core/TextureUtils.hpp"
 #include "Util/MissingTexture.hpp"
-#include "Util/TransformUtils.hpp"
 
 #include "config.hpp"
 #include <glm/fwd.hpp>
@@ -25,7 +24,7 @@ std::shared_ptr<SDL_Surface> LoadSurface(const std::string &filepath) {
 }
 
 namespace Util {
-Image::Image(const std::string &filepath)
+Image::Image(const std::string &filepath, bool useAA)
     : m_Path(filepath) {
     if (s_Program == nullptr) {
         InitProgram();
@@ -47,7 +46,7 @@ Image::Image(const std::string &filepath)
 
     m_Texture = std::make_unique<Core::Texture>(
         Core::SdlFormatToGlFormat(surface->format->format), surface->w,
-        surface->h, surface->pixels);
+        surface->h, surface->pixels, useAA);
     m_Size = {surface->w, surface->h};
 }
 
@@ -59,6 +58,10 @@ void Image::SetImage(const std::string &filepath) {
     m_Size = {surface->w, surface->h};
 }
 
+void Image::UseAntiAliasing(bool useAA) {
+    m_Texture->UseAntiAliasing(useAA);
+}
+
 void Image::Draw(const Core::Matrices &data) {
     m_UniformBuffer->SetData(0, data);
 

src/Util/Text.cpp

@@ -10,7 +10,7 @@
 
 namespace Util {
 Text::Text(const std::string &font, int fontSize, const std::string &text,
-           const Util::Color &color)
+           const Util::Color &color, bool useAA)
     : m_Text(text),
       m_Color(color) {
     if (s_Program == nullptr) {
@@ -43,10 +43,14 @@ Text::Text(const std::string &font, int fontSize, const std::string &text,
     m_Texture = std::make_unique<Core::Texture>(
         Core::SdlFormatToGlFormat(surface->format->format),
         surface->pitch / surface->format->BytesPerPixel, surface->h,
-        surface->pixels);
+        surface->pixels, useAA);
     m_Size = {surface->pitch / surface->format->BytesPerPixel, surface->h};
 }
 
+void Text::UseAntiAliasing(bool useAA) {
+    m_Texture->UseAntiAliasing(useAA);
+}
+
 void Text::Draw(const Core::Matrices &data) {
     m_UniformBuffer->SetData(0, data);