Skip to content

Commit db8c70b

Browse files
committed
Update Drawing() documentation
1 parent 9bb0d6f commit db8c70b

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

include/Window.hpp

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -412,15 +412,15 @@ class Window {
412412
static void SetConfigFlags(unsigned int flags) { ::SetConfigFlags(flags); }
413413

414414
/**
415-
* Used to handle the BeginDrawing() and EndDrawing() calls.
415+
* Alternates between calling `BeginDrawing()` and `EndDrawing()`.
416416
*
417417
* @code
418418
* while (window.Drawing()) {
419419
* DrawRectangle();
420420
* }
421421
* @endcode
422422
*
423-
* @return True of false depending if we're within the BeginDrawing() / EndDrawing() scope.
423+
* @return True if we're within the `BeginDrawing()` scope.
424424
*/
425425
bool Drawing() {
426426
if (m_drawing) {
@@ -436,6 +436,11 @@ class Window {
436436
}
437437

438438
protected:
439+
/**
440+
* Handles the internal drawing state for calling either `BeginDrawing()` or `EndDrawing()` from the `Drawing()` function.
441+
*
442+
* @see Drawing()
443+
*/
439444
bool m_drawing = false;
440445
};
441446
} // namespace raylib

0 commit comments

Comments
 (0)