Small imencode documentation improvement

It was previously not clear that the extension should include the period, [and I am not the only person that encountered this problem](https://stackoverflow.com/questions/4254460/opencv-could-not-find-encoder-for-the-specified-extension).

I assume that this is true for all supported extensions, but I haven't checked the source.
This commit is contained in:
Jan Polák
2022-05-06 14:41:52 +02:00
committed by Jan Polák
parent 667e5e4f89
commit dea0815199

View File

@@ -262,7 +262,7 @@ CV_EXPORTS Mat imdecode( InputArray buf, int flags, Mat* dst);
The function imencode compresses the image and stores it in the memory buffer that is resized to fit the The function imencode compresses the image and stores it in the memory buffer that is resized to fit the
result. See cv::imwrite for the list of supported formats and flags description. result. See cv::imwrite for the list of supported formats and flags description.
@param ext File extension that defines the output format. @param ext File extension that defines the output format. Must include a leading period.
@param img Image to be written. @param img Image to be written.
@param buf Output buffer resized to fit the compressed image. @param buf Output buffer resized to fit the compressed image.
@param params Format-specific parameters. See cv::imwrite and cv::ImwriteFlags. @param params Format-specific parameters. See cv::imwrite and cv::ImwriteFlags.