videoio: add note about image BGR format VideoWriter::write()
authorAlexander Alekhin <alexander.a.alekhin@gmail.com>
Sat, 28 Jul 2018 09:08:09 +0000 (09:08 +0000)
committerAlexander Alekhin <alexander.a.alekhin@gmail.com>
Sat, 28 Jul 2018 09:08:09 +0000 (09:08 +0000)
modules/videoio/include/opencv2/videoio.hpp

index eef840b..2628609 100644 (file)
@@ -905,7 +905,7 @@ public:
 
     /** @brief Writes the next video frame
 
-    @param image The written frame
+    @param image The written frame. In general, color images are expected in BGR format.
 
     The function/method writes the specified image to video file. It must have the same size as has
     been specified when opening the video writer.