amacocian/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2026-07-26 00:45:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Codechange: add missing @param and @return

Browse Source
This commit is contained in:
Rubidium
2026-02-16 17:19:09 +01:00
committed by rubidium42
parent 02438e9934
commit 7aecc268b6
18 changed files with 94 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/heightmap.cpp
+22 -1
View File
@@ -65,6 +65,10 @@ static inline bool IsValidHeightmapDimension(size_t width, size_t height)
/**
* Convert RGB colours to Greyscale using 29.9% Red, 58.7% Green, 11.4% Blue
* (average luminosity formula, NTSC Colour Space)
* @param red The red component of a colour.
* @param green The green component of a colour.
* @param blue The blue component of a colour.
* @return The greyscale conversion of a colour.
*/
static inline uint8_t RGBToGreyscale(uint8_t red, uint8_t green, uint8_t blue)
{
@@ -78,6 +82,9 @@ static inline uint8_t RGBToGreyscale(uint8_t red, uint8_t green, uint8_t blue)
/**
* The PNG Heightmap loader.
* @param map The map to write data to.
* @param png_ptr The PNG file to load.
* @param info_ptr Metadata about the loaded PNG.
*/
static void ReadHeightmapPNGImageData(std::span<uint8_t> map, png_structp png_ptr, png_infop info_ptr)
{
@@ -137,6 +144,11 @@ static void ReadHeightmapPNGImageData(std::span<uint8_t> map, png_structp png_pt
* Reads the heightmap and/or size of the heightmap from a PNG file.
* If map == nullptr only the size of the PNG is read, otherwise a map
* with greyscale pixels is allocated and assigned to *map.
* @param filename Name of the file to load.
* @param[out] x Length of the image.
* @param[out] y Height of the image.
* @param[in,out] map If not \c nullptr, destination to store the loaded block of image data.
* @return Whether loading was successful.
*/
static bool ReadHeightmapPNG(std::string_view filename, uint *x, uint *y, std::vector<uint8_t> *map)
{
@@ -203,6 +215,9 @@ static bool ReadHeightmapPNG(std::string_view filename, uint *x, uint *y, std::v
/**
* The BMP Heightmap loader.
* @param map The image to load into.
* @param info Metadata about the image.
* @param data The actual BMP data.
*/
static void ReadHeightmapBMPImageData(std::span<uint8_t> map, const BmpInfo &info, const BmpData &data)
{
@@ -258,6 +273,11 @@ static void ReadHeightmapBMPImageData(std::span<uint8_t> map, const BmpInfo &inf
* Reads the heightmap and/or size of the heightmap from a BMP file.
* If map == nullptr only the size of the BMP is read, otherwise a map
* with greyscale pixels is allocated and assigned to *map.
* @param filename Name of the file to load.
* @param[out] x Length of the image.
* @param[out] y Height of the image.
* @param[in,out] map If not \c nullptr, destination to store the loaded block of image data.
* @return Whether loading was successful.
*/
static bool ReadHeightmapBMP(std::string_view filename, uint *x, uint *y, std::vector<uint8_t> *map)
{
@@ -512,7 +532,8 @@ bool GetHeightmapDimensions(DetailedFileType dft, std::string_view filename, uin
* to a landscape representing the heightmap.
* It converts pixels to height. The brighter, the higher.
* @param dft Type of image file.
* @param filename of the heightmap file to be imported
* @param filename of the heightmap file to be imported.
* @return \c true iff the heightmap could be loaded.
*/
bool LoadHeightmap(DetailedFileType dft, std::string_view filename)
{