Update_One_Display_Timed
Functions | |
HC_BOOLEAN | Update_One_Display_Timed (const char *segment, double time) |
Limit the amount of time allowed for an update. More... | |
Detailed Description
Function Documentation
◆ Update_One_Display_Timed()
HC_BOOLEAN Update_One_Display_Timed | ( | const char * | segment, |
double | time | ||
) |
Limit the amount of time allowed for an update.
- Parameters
-
segment - display driver segment to update time - maximum seconds allowed for an update to finish
- Returns
- status - Flag indicating whether or not HOOPS completed drawing the scene in the last update. A (1) indicates it did draw the complete scene, while a (0) indicates that the previous update was aborted before completion.
DETAILS
No additional details. See Update_Display_Timed().
NOTES
This function will only work when the Driver Option "update_interrupts = on" is active.
If (0) is returned, users can call the "event interrupted" query on Show_Device_Info() to find out whether a timed update was aborted due to time, or due to another interrupt method (a HOOPS event from the driver, a user-queued special event, or a call to HIC_Abort_Update() from a driver's "exit update" callback).
RESTRICTIONS
- See also