more comments for filter_by_mask() code

Author: Gin

SerialPrograms/Source/CommonFramework/ImageTools/BinaryImage_FilterRgb32.cpp

@@ -21,8 +21,8 @@ namespace PokemonAutomation{
 void filter_by_mask(
     const PackedBinaryMatrix& matrix,
     ImageRGB32& image,
-    Color replace_with,
-    bool replace_if_zero    //  If false, replace if one.
+    Color replacement_color,
+    bool replace_zero_bits
 ){
     if (matrix.width() > image.width()){
         throw InternalProgramError(nullptr, PA_CURRENT_FUNCTION, "Image width is too small.");
@@ -33,14 +33,14 @@ void filter_by_mask(
     Kernels::filter_by_mask(
         matrix,
         image.data(), image.bytes_per_row(),
-        (uint32_t)replace_with, replace_if_zero
+        (uint32_t)replacement_color, replace_zero_bits
     );
 }
 void filter_by_mask(
     const PackedBinaryMatrix& matrix,
     ImageRGB32& image, size_t offset_x, size_t offset_y,
-    Color replace_with,
-    bool replace_if_zero    //  If false, replace if one.
+    Color replacement_color,
+    bool replace_zero_bits
 ){
     if (matrix.width() > image.width()){
         throw InternalProgramError(nullptr, PA_CURRENT_FUNCTION, "Image width is too small.");
@@ -53,7 +53,7 @@ void filter_by_mask(
         matrix,
         (uint32_t*)((char*)image.data() + bytes_per_row * offset_y + offset_x * sizeof(uint32_t)),
         bytes_per_row,
-        (uint32_t)replace_with, replace_if_zero
+        (uint32_t)replacement_color, replace_zero_bits
     );
 }
 

SerialPrograms/Source/CommonFramework/ImageTools/BinaryImage_FilterRgb32.h

@@ -18,18 +18,27 @@
 namespace PokemonAutomation{
 
 
-
+//  Selectively replace pixels in `image` with the replacement color
+//  according to the respective bits in the binary matrix.
+//  If `replace_zero_bits` is true, replace pixels corresponding to the zero bits.
+//  Else, replace those with the one bits.
 void filter_by_mask(
     const PackedBinaryMatrix& matrix,
     ImageRGB32& image,
-    Color replace_with,
-    bool replace_if_zero    //  If false, replace if one.
+    Color replacement_color,
+    bool replace_zero_bits
 );
+//  Selectively replace pixels in an area of the `image` with the replacement color
+//  according to the respective bits in the binary matrix.
+//  If `replace_zero_bits` is true, replace pixels corresponding to the zero bits.
+//  Else, replace those with the one bits.
+//  The image area starts at (offset_x, offset_y) with the same (width, height) as
+//  the matrix. 
 void filter_by_mask(
     const PackedBinaryMatrix& matrix,
     ImageRGB32& image, size_t offset_x, size_t offset_y,
-    Color replace_with,
-    bool replace_if_zero    //  If false, replace if one.
+    Color replacement_color,
+    bool replace_zero_bits
 );
 
 

SerialPrograms/Source/Kernels/BinaryImageFilters/Kernels_BinaryImage_BasicFilters.h

@@ -28,13 +28,15 @@ namespace PokemonAutomation{
 namespace Kernels{
 
 
-//  Selectively replace each pixel in an image with the specified pixel
-//  according to the respective bit in the binary matrix.
+//  Selectively replace pixels in an image with the replacement color
+//  according to the respective bits in the binary matrix.
+//  If `replace_zero_bits` is true, replace pixels corresponding to the zero bits.
+//  Else, replace those with the one bits.
 void filter_by_mask(
     const PackedBinaryMatrix_IB& matrix,
     uint32_t* image, size_t bytes_per_row,
-    uint32_t replace_with,
-    bool replace_if_zero    //  If false, replace if one.
+    uint32_t replacement_color,
+    bool replace_zero_bits
 );