Function opencv::highgui::wait_key[][src]

pub fn wait_key(delay: i32) -> Result<i32>

Waits for a pressed key.

The function waitKey waits for a key event infinitely (when inline formula ) or for delay milliseconds, when it is positive. Since the OS has a minimum time between switching threads, the function will not wait exactly delay ms, it will wait at least delay ms, depending on what else is running on your computer at that time. It returns the code of the pressed key or -1 if no key was pressed before the specified time had elapsed. To check for a key press but not wait for it, use #pollKey.

Note: The functions #waitKey and #pollKey are the only methods in HighGUI that can fetch and handle GUI events, so one of them needs to be called periodically for normal event processing unless HighGUI is used within an environment that takes care of event processing.

Note: The function only works if there is at least one HighGUI window created and the window is active. If there are several HighGUI windows, any of them can be active.

Parameters

  • delay: Delay in milliseconds. 0 is the special value that means “forever”.

C++ default parameters

  • delay: 0