REFACTOR: Expanded many parameter names for functions.

DOCS: Corrected comments to match new parameters.
CHORE: Moved some variable definition to top of function call.
This commit is contained in:
2026-09-12 05:15:16 -04:00
parent 81c228beb8
commit 54a2d44a53
9 changed files with 181 additions and 184 deletions
+5 -5
View File
@@ -107,11 +107,11 @@ u32_mask(const unsigned int clr, const char keep);
* it is just rotated back to original position. Cannot be greater than 8
* because the calculations would result in a negative.
* @param[in] clr Packed Pixel
* @param[in] n Amount of times to move bits to left.
* @param[in] dist Distance from original position to move each bit to the left.
* @return unsigned int Packed Pixel with newly moved bits
*/
unsigned int
u32_rotl(const unsigned int clr, const int n);
u32_rotl(const unsigned int clr, const int dist);
/**
* @brief Raises Color Vibrance
@@ -139,13 +139,13 @@ u32_avg_gb(const unsigned int clr);
* them. Then it moves to the next pixel doing the same. Then it does the second
* loop from top to bottom doing the same principle. This can take some time
* depending on hardware, image size, radius, etc.
* @param[in] src_buf The image buffer to be blurred
* @param[in] img the PPM image container
* @param[in] buf The image buffer to be blurred
* @param[in] metadata the PPM image container
* @param[in] radius The amount of pixels around the left and right, then top
* and bottom to mix with the currently selected pixel
* @return unsigned int Pointer to new created image buffer.
*/
unsigned int*
u32_box_blur(const unsigned int* src_buf, const PPM* img, const int radius);
u32_box_blur(const unsigned int* buf, const PPM* metadata, const int radius);
#endif