Skip to content

Commit cc4bde5

Browse files
authored
Merge pull request #5716 from mvieth/spinonce_doc
Improve spinOnce documentation
2 parents cd86558 + ba220d9 commit cc4bde5

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

visualization/include/pcl/visualization/pcl_visualizer.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,8 @@ namespace pcl
288288
* \param[in] time - How long (in ms) should the visualization loop be allowed to run.
289289
* \param[in] force_redraw - if false it might return without doing anything if the
290290
* interactor's framerate does not require a redraw yet.
291+
* \note This function may not return immediately after the specified time has elapsed, for example if
292+
* the user continues to interact with the visualizer, meaning that there are still events to process.
291293
*/
292294
void
293295
spinOnce (int time = 1, bool force_redraw = false);

0 commit comments

Comments
 (0)