From aedf56404ee85fe2f0b8e34fa5e5ea7c6128a8f6 Mon Sep 17 00:00:00 2001 From: Kirill Kornyakov Date: Mon, 15 Oct 2012 15:23:38 +0400 Subject: [PATCH] made imread description slightly better #2406 --- .../introduction/windows_install/windows_install.rst | 2 +- .../highgui/doc/reading_and_writing_images_and_video.rst | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/tutorials/introduction/windows_install/windows_install.rst b/doc/tutorials/introduction/windows_install/windows_install.rst index ca089c4a57..3a73a2b635 100644 --- a/doc/tutorials/introduction/windows_install/windows_install.rst +++ b/doc/tutorials/introduction/windows_install/windows_install.rst @@ -14,7 +14,7 @@ The description here was tested on Windows 7 SP1. Nevertheless, it should also w Installation by Using the Pre-built Libraries ============================================= -#. Launch a web browser of choice and go to our `page on Sourceforge `_ +#. Launch a web browser of choice and go to our `page on Sourceforge `_. #. Choose a build you want to use and download it. diff --git a/modules/highgui/doc/reading_and_writing_images_and_video.rst b/modules/highgui/doc/reading_and_writing_images_and_video.rst index d4b2a1f739..4644796493 100644 --- a/modules/highgui/doc/reading_and_writing_images_and_video.rst +++ b/modules/highgui/doc/reading_and_writing_images_and_video.rst @@ -81,12 +81,12 @@ Loads an image from a file. CV_LOAD_IMAGE_GRAYSCALE - * **>0** Return a 3-channel color image + * **>0** Return a 3-channel color image. + .. note:: In the current implementation the alpha channel, if any, is stripped from the output image. Use negative value if you need the alpha channel. - * **=0** Return a grayscale image + * **=0** Return a grayscale image. - * **<0** Return the loaded image as is. - .. note:: In the current implementation the alpha channel, if any, is stripped from the output image. + * **<0** Return the loaded image as is (with alpha channel). The function ``imread`` loads an image from the specified file and returns it. If the image cannot be read (because of missing file, improper permissions, unsupported or invalid format), the function returns an empty matrix ( ``Mat::data==NULL`` ). Currently, the following file formats are supported: