Skip to content

Commit

Permalink
More accurate XCBFlush() description (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
DerjenigeUberMensch authored May 27, 2024
1 parent d6618db commit 822e5c9
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions xcb_trl.h
Original file line number Diff line number Diff line change
Expand Up @@ -1958,17 +1958,10 @@ XCBFreeTextProperty(
* Flushes buffered output to XServer.
* Blocks Until buffer is fully flushed.
*
* !!!!!!IMPORTANT!!!!!!
* This function should not be called often and should be called on important things that cant wait for XCBSync();
*
* NOTE: Flushing small buffers, e.g. requests_pending < 100 is slightly faster than calling XCBSync.
* however due to the nature of flushing this case rarely if ever occurs.
* NOTE: Flushing large buffers e.g., requests_pending > 200-1000 is considerably slower than calling XCBSync.
* however yields faster results then calling neither.
*
* CONCLUSION: Use XCBSync() when ever possible, and after every ~1000 requests_pending due to the Display buffer filling up.
* Though depending on use case XCBSync may never need to be called, if there arent enough requests_pending to fill up Display buffer.
*
* NOTE: >> This is how you send requests to the server after doing buffering requests <<.
* >> AKA you wont get responses back from non XCBGetCookie/XCBGetReply type functions <<.
* >> Remember to Flush! Or Sync (slower) <<.
*
* RETURN: 1 on Success.
* RETURN: 0 on Failure.
*/
Expand Down

0 comments on commit 822e5c9

Please sign in to comment.