From dab20b9eacd0f6e6752df6629bbb33718d6375f2 Mon Sep 17 00:00:00 2001
From: Pascal Engeler <engelerp@phys.ethz.ch>
Date: Fri, 27 Aug 2021 18:04:05 +0200
Subject: [PATCH] underscoring
---
README.md | 15 +++++++--------
1 file changed, 7 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index ead19f5..90ca04b 100644
--- a/README.md
+++ b/README.md
@@ -106,10 +106,10 @@ Todo
**Public Function Members**
- `void start_drawing(const float x, const float y)`:
- - *Desc*: Start drawing at coordinates (`x`, `y`) (typically fingerdown location). Doesn't draw anything.
- - *Pre*:
- - *Post*: Drawing start is set to (x, y).
- - *Notes*: Nothing is drawn by this function. (x, y) are typically the fingerdown coordinates.
+ - <ins>Desc</ins>: Start drawing at coordinates (`x`, `y`) (typically fingerdown location). Doesn't draw anything.
+ - <ins>Pre</ins>:
+ - <ins>Post</ins>: Drawing start is set to (x, y).
+ - <ins>Notes</ins>: Nothing is drawn by this function. (x, y) are typically the fingerdown coordinates.
- `bool draw(const float x, const float y, Toolbox& tb, bool drawing)`
- *Desc*: Draw a stroke from the last position to (x, y), with strokewidth controlled by `drawing` (`true`->`tb.drawing_width`, `false`->`tb.erasing_width`).
@@ -125,11 +125,10 @@ Todo
- *Post*: A drawcall `glDrawArrays` has been issued.
- *Notes*: Undefined behaviour if `draw` has never been called, or the precondition is violated.
- Issues a drawcall (`glDrawArrays`).
- The argument is unused.
- Correct usage first calls `draw`, then calls `redraw` without changing the state of `GL_ARRAY_BUFFER` in between (typically, framebuffer and texture bindings are changed in between).
-
- `void erase(const float x, const float y, Toolbox& tb)` **DEPRECATED**
+ - *Desc*:
+ - *Pre*:
+ - *Post*:
- *Notes*: Use `draw(x, y, tb, false)` instead.
- `int num_drawn()`
--
GitLab