EndRefresh

End the optimized refresh state of the window.

Declaration

Source position: intuition.pas line 3863

Arguments

Description

This function gets you out of the special refresh state of your window. It is called following a call to BeginRefresh(), which routine puts you into the special refresh state. While your window is in the refresh state, the only rendering that will be wrought in your window will be to those areas which were recently revealed and need to be refreshed.

After you've done all the refreshing you want to do for this window, you should call this routine to restore the window to its non-refreshing state. Then all rendering will go to the entire window, as usual.

The Complete argument is a boolean True or False value used to describe whether or not the refreshing you've done was all the refreshing that needs to be done at this time. Most often, this argument will be True. But if, for instance, you have multiple tasks or multiple procedure calls which must run to completely refresh the window, then each can call its own BeginRefresh()/EndRefresh() pair with a Complete argument of False, and only the last calls with a Complete argument of True.

Warning: Passing this function the value of False has its pitfalls. Please see BeginRefresh().

For your information, this routine calls the Layers library function EndUpdate(), unlocks your layers (calls UnlockLayerRom()), clears the LAYERREFRESH bit in your Layer Flags, and clears the WFLG_WINDOWREFRESH bit in your window Flags.

See also