luke
/
klayout
mirror of https://github.com/KLayout/klayout.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed a doc typo. 

See https://www.klayout.de/forum/comments.php?DiscussionID=935&page=1#Comment_4292
This commit is contained in:
Matthias Koefferlein 2017-03-14 23:37:39 +01:00
parent 2953184b15
commit c6833b2b67
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/img/gsiDeclImg.cc
View File

@ -669,15 +669,15 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "Image",
"this method does nothing.\n"
) +
gsi::method ("get_pixel", (double (ImageRef::*)(size_t x, size_t y) const) &ImageRef::pixel,
"@brief Gets one pixel (monochrome and color)\n"
"@brief Gets one pixel (monochrome only)\n"
"@args x, y\n"
"\n"
"@param x The x coordinate of the pixel (0..width()-1)\n"
"@param y The y coordinate of the pixel (mathematical order: 0 is the lowest, 0..height()-1)\n"
"@param component 0 for red, 1 for green, 2 for blue.\n"
"\n"
"If the component index, x or y value exceeds the image bounds, this method \n"
"returns 0.0. For monochrome images, the component index is ignored.\n"
"If x or y value exceeds the image bounds, this method \n"
"returns 0.0. This method is valid for monochrome images only. For color images it will return 0.0 always.\n"
"Use \\is_color? to decide whether the image is a color image or monochrome one.\n"
) +
gsi::method ("get_pixel", (double (ImageRef::*)(size_t x, size_t y, unsigned int component) const) &ImageRef::pixel,
"@brief Gets one pixel (monochrome and color)\n"