generic-library/opencv
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

started work on API & doc synchronization (in particular, Mat& => Input/OutputArray in the descriptions)

Browse Source
This commit is contained in:
Vadim Pisarevsky
2011-06-07 22:51:31 +00:00
parent 927b5c88ea
commit c7a42e9682
52 changed files with 1782 additions and 2048 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
modules/highgui/doc/reading_and_writing_images_and_video.rst
View File

@@ -9,7 +9,7 @@ Reading and Writing Images and Video
imdecode
------------
.. c:function:: Mat imdecode( const Mat\& buf, int flags )
.. cpp:function:: Mat imdecode( InputArray buf, int flags )
Reads an image from a buffer in memory.
@@ -29,7 +29,7 @@ See
imencode
------------
.. c:function:: bool imencode( const string\& ext, const Mat\& img, vector<uchar>\& buf, const vector<int>\& params=vector<int>())
.. cpp:function:: bool imencode( const string& ext, InputArray img, vector<uchar>& buf, const vector<int>& params=vector<int>())
Encode an image into a memory buffer.
@@ -51,7 +51,7 @@ See
imread
----------
.. c:function:: Mat imread( const string\& filename, int flags=1 )
.. cpp:function:: Mat imread( const string& filename, int flags=1 )
Loads an image from a file.
@@ -95,7 +95,7 @@ The function ``imread`` loads an image from the specified file and returns it. I
imwrite
-----------
.. c:function:: bool imwrite( const string\& filename, const Mat\& img, const vector<int>\& params=vector<int>())
.. cpp:function:: bool imwrite( const string& filename, InputArray img, const vector<int>& params=vector<int>())
Saves an image to a specified file.
@@ -208,11 +208,11 @@ The class provides C++ video capturing API. Here is how the class can be used: :
VideoCapture::VideoCapture
------------------------------
.. c:function:: VideoCapture::VideoCapture()
.. cpp:function:: VideoCapture::VideoCapture()
.. c:function:: VideoCapture::VideoCapture(const string& filename)
.. cpp:function:: VideoCapture::VideoCapture(const string& filename)
.. c:function:: VideoCapture::VideoCapture(int device)
.. cpp:function:: VideoCapture::VideoCapture(int device)
VideoCapture constructors.
@@ -226,7 +226,7 @@ VideoCapture constructors.
VideoCapture::get
---------------------
.. c:function:: double VideoCapture::get(int property_id)
.. cpp:function:: double VideoCapture::get(int property_id)
:param property_id: Property identifier. It can be one of the following:
@@ -277,7 +277,7 @@ VideoCapture::get
VideoCapture::set
---------------------
.. c:function:: bool VideoCapture::set(int property_id, double value)
.. cpp:function:: bool VideoCapture::set(int property_id, double value)
Sets a property in the VideoCapture backend.