potok/opencv
1
0
Fork 0
mirror of https://github.com/opencv/opencv.git synced 2026-07-30 15:53:03 +04:00
Code Packages Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Andrey Kamaev
2013-03-22 20:51:45 +04:00
parent be7bbe3aa9
commit 33ef7990b0
19 changed files with 93 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files
modules/highgui/doc/qt_new_functions.rst
+10 -10
View File
@@ -61,7 +61,7 @@ setWindowProperty
---------------------
Changes parameters of a window dynamically.
.. ocv:function:: void setWindowProperty( const string& winname, int prop_id, double prop_value )
.. ocv:function:: void setWindowProperty( const String& winname, int prop_id, double prop_value )
.. ocv:pyfunction:: cv2.setWindowProperty(winname, prop_id, prop_value) -> None
@@ -97,7 +97,7 @@ getWindowProperty
---------------------
Provides parameters of a window.
.. ocv:function:: double getWindowProperty( const string& winname, int prop_id )
.. ocv:function:: double getWindowProperty( const String& winname, int prop_id )
.. ocv:pyfunction:: cv2.getWindowProperty(winname, prop_id) -> retval
@@ -123,7 +123,7 @@ fontQt
----------
Creates the font to draw a text on an image.
.. ocv:function:: CvFont fontQt(const string& nameFont, int pointSize = -1, Scalar color = Scalar::all(0), int weight = CV_FONT_NORMAL, int style = CV_STYLE_NORMAL, int spacing = 0)
.. ocv:function:: CvFont fontQt(const String& nameFont, int pointSize = -1, Scalar color = Scalar::all(0), int weight = CV_FONT_NORMAL, int style = CV_STYLE_NORMAL, int spacing = 0)
.. ocv:cfunction:: CvFont cvFontQt(const char* nameFont, int pointSize=-1, CvScalar color=cvScalarAll(0), int weight=CV_FONT_NORMAL, int style=CV_STYLE_NORMAL, int spacing=0)
@@ -169,7 +169,7 @@ addText
-----------
Creates the font to draw a text on an image.
.. ocv:function:: void addText( const Mat& img, const string& text, Point org, CvFont font )
.. ocv:function:: void addText( const Mat& img, const String& text, Point org, CvFont font )
.. ocv:cfunction:: void cvAddText( const CvArr* img, const char* text, CvPoint org, CvFont * arg2 )
@@ -195,7 +195,7 @@ displayOverlay
------------------
Displays a text on a window image as an overlay for a specified duration.
.. ocv:function:: void displayOverlay( const string& winname, const string& text, int delayms=0 )
.. ocv:function:: void displayOverlay( const String& winname, const String& text, int delayms=0 )
.. ocv:cfunction:: void cvDisplayOverlay(const char* name, const char* text, int delayms = 0)
@@ -212,7 +212,7 @@ displayStatusBar
--------------------
Displays a text on the window statusbar during the specified period of time.
.. ocv:function:: void displayStatusBar( const string& winname, const string& text, int delayms=0 )
.. ocv:function:: void displayStatusBar( const String& winname, const String& text, int delayms=0 )
.. ocv:cfunction:: void cvDisplayStatusBar(const char* name, const char* text, int delayms = 0)
@@ -230,7 +230,7 @@ setOpenGlDrawCallback
------------------------
Sets a callback function to be called to draw on top of displayed image.
.. ocv:function:: void setOpenGlDrawCallback( const string& winname, OpenGlDrawCallback onOpenGlDraw, void* userdata=0 )
.. ocv:function:: void setOpenGlDrawCallback( const String& winname, OpenGlDrawCallback onOpenGlDraw, void* userdata=0 )
.. ocv:cfunction:: void cvSetOpenGlDrawCallback( const char* window_name, CvOpenGlDrawCallback callback, void* userdata=NULL )
@@ -276,7 +276,7 @@ saveWindowParameters
------------------------
Saves parameters of the specified window.
.. ocv:function:: void saveWindowParameters( const string& windowName )
.. ocv:function:: void saveWindowParameters( const String& windowName )
.. ocv:cfunction:: void cvSaveWindowParameters(const char* name)
@@ -289,7 +289,7 @@ loadWindowParameters
------------------------
Loads parameters of the specified window.
.. ocv:function:: void loadWindowParameters( const string& windowName )
.. ocv:function:: void loadWindowParameters( const String& windowName )
.. ocv:cfunction:: void cvLoadWindowParameters(const char* name)
@@ -302,7 +302,7 @@ createButton
----------------
Attaches a button to the control panel.
.. ocv:function:: int createButton( const string& bar_name, ButtonCallback on_change, void* userdata=NULL, int type=CV_PUSH_BUTTON, bool initial_button_state=0 )
.. ocv:function:: int createButton( const String& bar_name, ButtonCallback on_change, void* userdata=NULL, int type=CV_PUSH_BUTTON, bool initial_button_state=0 )
.. ocv:cfunction:: int cvCreateButton( const char* button_name=NULL, CvButtonCallback on_change=NULL, void* userdata=NULL, int button_type=CV_PUSH_BUTTON, int initial_button_state=0 )
modules/highgui/doc/reading_and_writing_images_and_video.rst
+7 -7
View File
@@ -35,7 +35,7 @@ imencode
--------
Encodes an image into a memory buffer.
.. ocv:function:: bool imencode( const string& ext, InputArray img, vector<uchar>& buf, const vector<int>& params=vector<int>())
.. ocv:function:: bool imencode( const String& ext, InputArray img, vector<uchar>& buf, const vector<int>& params=vector<int>())
.. ocv:cfunction:: CvMat* cvEncodeImage( const char* ext, const CvArr* image, const int* params=0 )
@@ -59,7 +59,7 @@ imread
------
Loads an image from a file.
.. ocv:function:: Mat imread( const string& filename, int flags=1 )
.. ocv:function:: Mat imread( const String& filename, int flags=1 )
.. ocv:pyfunction:: cv2.imread(filename[, flags]) -> retval
@@ -120,7 +120,7 @@ imwrite
-----------
Saves an image to a specified file.
.. ocv:function:: bool imwrite( const string& filename, InputArray img, const vector<int>& params=vector<int>() )
.. ocv:function:: bool imwrite( const String& filename, InputArray img, const vector<int>& params=vector<int>() )
.. ocv:pyfunction:: cv2.imwrite(filename, img[, params]) -> retval
@@ -236,7 +236,7 @@ VideoCapture constructors.
.. ocv:function:: VideoCapture::VideoCapture()
.. ocv:function:: VideoCapture::VideoCapture(const string& filename)
.. ocv:function:: VideoCapture::VideoCapture(const String& filename)
.. ocv:function:: VideoCapture::VideoCapture(int device)
@@ -260,7 +260,7 @@ VideoCapture::open
---------------------
Open video file or a capturing device for video capturing
.. ocv:function:: bool VideoCapture::open(const string& filename)
.. ocv:function:: bool VideoCapture::open(const String& filename)
.. ocv:function:: bool VideoCapture::open(int device)
.. ocv:pyfunction:: cv2.VideoCapture.open(filename) -> retval
@@ -479,7 +479,7 @@ VideoWriter constructors
.. ocv:function:: VideoWriter::VideoWriter()
.. ocv:function:: VideoWriter::VideoWriter(const string& filename, int fourcc, double fps, Size frameSize, bool isColor=true)
.. ocv:function:: VideoWriter::VideoWriter(const String& filename, int fourcc, double fps, Size frameSize, bool isColor=true)
.. ocv:pyfunction:: cv2.VideoWriter([filename, fourcc, fps, frameSize[, isColor]]) -> <VideoWriter object>
@@ -517,7 +517,7 @@ VideoWriter::open
-----------------
Initializes or reinitializes video writer.
.. ocv:function:: bool VideoWriter::open(const string& filename, int fourcc, double fps, Size frameSize, bool isColor=true)
.. ocv:function:: bool VideoWriter::open(const String& filename, int fourcc, double fps, Size frameSize, bool isColor=true)
.. ocv:pyfunction:: cv2.VideoWriter.open(filename, fourcc, fps, frameSize[, isColor]) -> retval
modules/highgui/doc/user_interface.rst
+9 -9
View File
@@ -7,7 +7,7 @@ createTrackbar
------------------
Creates a trackbar and attaches it to the specified window.
.. ocv:function:: int createTrackbar( const string& trackbarname, const string& winname, int* value, int count, TrackbarCallback onChange=0, void* userdata=0)
.. ocv:function:: int createTrackbar( const String& trackbarname, const String& winname, int* value, int count, TrackbarCallback onChange=0, void* userdata=0)
.. ocv:cfunction:: int cvCreateTrackbar( const char* trackbar_name, const char* window_name, int* value, int count, CvTrackbarCallback on_change=NULL )
@@ -37,7 +37,7 @@ getTrackbarPos
------------------
Returns the trackbar position.
.. ocv:function:: int getTrackbarPos( const string& trackbarname, const string& winname )
.. ocv:function:: int getTrackbarPos( const String& trackbarname, const String& winname )
.. ocv:pyfunction:: cv2.getTrackbarPos(trackbarname, winname) -> retval
@@ -59,7 +59,7 @@ imshow
----------
Displays an image in the specified window.
.. ocv:function:: void imshow( const string& winname, InputArray mat )
.. ocv:function:: void imshow( const String& winname, InputArray mat )
.. ocv:pyfunction:: cv2.imshow(winname, mat) -> None
@@ -84,7 +84,7 @@ namedWindow
---------------
Creates a window.
.. ocv:function:: void namedWindow( const string& winname, int flags=WINDOW_AUTOSIZE )
.. ocv:function:: void namedWindow( const String& winname, int flags=WINDOW_AUTOSIZE )
.. ocv:pyfunction:: cv2.namedWindow(winname[, flags]) -> None
@@ -119,7 +119,7 @@ destroyWindow
-------------
Destroys a window.
.. ocv:function:: void destroyWindow( const string& winname )
.. ocv:function:: void destroyWindow( const String& winname )
.. ocv:pyfunction:: cv2.destroyWindow(winname) -> None
@@ -151,7 +151,7 @@ MoveWindow
----------
Moves window to the specified position
.. ocv:function:: void moveWindow( const string& winname, int x, int y )
.. ocv:function:: void moveWindow( const String& winname, int x, int y )
.. ocv:pyfunction:: cv2.moveWindow(winname, x, y) -> None
@@ -170,7 +170,7 @@ ResizeWindow
------------
Resizes window to the specified size
.. ocv:function:: void resizeWindow( const string& winname, int width, int height )
.. ocv:function:: void resizeWindow( const String& winname, int width, int height )
.. ocv:pyfunction:: cv2.resizeWindow(winname, width, height) -> None
@@ -195,7 +195,7 @@ SetMouseCallback
----------------
Sets mouse handler for the specified window
.. ocv:function:: void setMouseCallback( const string& winname, MouseCallback onMouse, void* userdata=0 )
.. ocv:function:: void setMouseCallback( const String& winname, MouseCallback onMouse, void* userdata=0 )
.. ocv:cfunction:: void cvSetMouseCallback( const char* window_name, CvMouseCallback on_mouse, void* param=NULL )
@@ -212,7 +212,7 @@ setTrackbarPos
------------------
Sets the trackbar position.
.. ocv:function:: void setTrackbarPos( const string& trackbarname, const string& winname, int pos )
.. ocv:function:: void setTrackbarPos( const String& trackbarname, const String& winname, int pos )
.. ocv:pyfunction:: cv2.setTrackbarPos(trackbarname, winname, pos) -> None