Merge pull request #2610 from EricFlorin:VizWindowNamePrepend_Contrib

* Edited Documentation

Edited the Viz "getWindowByName" documentation so it reflects the actual behaviour of getWindowByName. More specifically, that "Viz - " is not prefixed automatically to the window name given by the user if they haven't prefixed "Viz - " already.
pull/2747/head
EricFlorin 5 years ago committed by GitHub
parent a35c1e3273
commit ad756614be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 7
      modules/viz/include/opencv2/viz/vizcore.hpp

@ -92,12 +92,7 @@ namespace cv
@note If the window with that name already exists, that window is returned. Otherwise, new window is
created with the given name, and it is returned.
@note Window names are automatically prefixed by "Viz - " if it is not done by the user.
@code
/// window and window_2 are the same windows.
viz::Viz3d window = viz::getWindowByName("myWindow");
viz::Viz3d window_2 = viz::getWindowByName("Viz - myWindow");
@endcode
*/
CV_EXPORTS Viz3d getWindowByName(const String &window_name);

Loading…
Cancel
Save