diff --git a/README.md b/README.md index 64ad2d465ad57527ebcc087cc43e745ac5eb9fda..a10b92fe8b4a62dd0c6b154b4d86374cbfcc90db 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,13 @@ Todo Note that this class relies on the caller to its methods to take care of the Opengl state (using shaders, binding buffers, etc.). See `DrawingHandler` for more information on how this class is to be used. +**Usage** +- Construct object (e.g. when new finger goes down) +- `start_drawing` with initial position (e.g. with finger down position) +- Upon new location (e.g. finger motion to new position), setup Opengl state (use shader, bind FBO, bind VAO, **bind VBO**, set viewport, bind textures) and call `draw`. Call `redraw` with all required FBO/texture combinations. +- Destruct when drawing this line is finished (e.g. finger is lifted) + + **Constructors and Destructors** - `Drawer(Toolbox&)` @@ -157,37 +164,489 @@ N/A N/A ### DrawingHandler ([drawing_handler.hpp](include/drawing_handler.hpp), [drawing_handler.cpp](src/drawing_handler.cpp)) +**Description** + +Todo + +**Usage** + +Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + Todo + +**Private Data Members** + +Todo + +**Notes** + +Todo + ### EfficientBlock ([efficient_block.hpp](include/efficient_block.hpp), [efficient_block.cpp](src/efficient_block.cpp)) +**Description** + +Todo + +**Usage** + +Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + +Todo + +**Private Data Members** + Todo + +**Notes** + +Todo + ### EventLogger ([event_logger.hpp](include/event_logger.hpp), [event_logger.cpp](src/event_logger.cpp)) +**Description** + +Todo + +**Usage** + +Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + Todo + +**Private Data Members** + +Todo + +**Notes** + +Todo + ### GuiHandler ([gui_handler.hpp](include/gui_handler.hpp), [gui_handler.cpp](src/gui_handler.cpp)) +**Description** + +Todo + +**Usage** + Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + +Todo + +**Private Data Members** + +Todo + +**Notes** + +Todo + ### Infrastructure ([infrastructure.hpp](include/infrastructure.hpp), [infrastructure.cpp](src/infrastructure.cpp)) +**Description** + Todo + +**Usage** + +Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + +Todo + +**Private Data Members** + +Todo + +**Notes** + +Todo + ### InputHandler ([input_handler.hpp](include/input_handler.hpp), [input_handler.cpp](src/input_handler.cpp)) +**Description** + +Todo + +**Usage** + +Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + Todo + +**Private Function Members** + +Todo + +**Public Data Members** + +Todo + +**Private Data Members** + +Todo + +**Notes** + +Todo + ### Message ([message.hpp](include/message.hpp), [message.cpp](src/message.cpp)) +**Description** + +Todo + +**Usage** + +Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + +Todo + +**Private Function Members** + Todo + +**Public Data Members** + +Todo + +**Private Data Members** + +Todo + +**Notes** + +Todo + ### PatternHandler ([pattern_handler.hpp](include/pattern_handler.hpp), [pattern_handler.cpp](src/pattern_handler.cpp)) +**Description** + +Todo + +**Usage** + +Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + Todo + +**Private Data Members** + +Todo + +**Notes** + +Todo + ### Pevent ([pevent.hpp](include/pevent.hpp), [pevent.cpp](src/pevent.cpp)) +**Description** + +Todo + +**Usage** + Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + +Todo + +**Private Data Members** + +Todo + +**Notes** + +Todo + ### Shader ([shader.hpp](include/shader.hpp), [shader.cpp](src/shader.cpp)) +**Description** + Todo + +**Usage** + +Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + +Todo + +**Private Data Members** + +Todo + +**Notes** + +Todo + ### SlimBlockchainHandler ([slim_blockchain_handler.hpp](include/slim_blockchain_handler.hpp), [slim_blockchain_handler.cpp](src/slim_blockchain_handler.cpp)) +**Description** + +Todo + +**Usage** + +Todo + +**Constructors and Destructors** + Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + +Todo + +**Private Data Members** + +Todo + +**Notes** + +Todo + ### TimeoutHandler ([timeout_handler.hpp](include/timeout_handler.hpp), [timeout_handler.cpp](src/timeout_handler.cpp)) +**Description** + +Todo + +**Usage** + +Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + +Todo + +**Private Data Members** + Todo + +**Notes** + +Todo + ### Toolbox ([toolbox.hpp](include/toolbox.hpp), [toolbox.cpp](src/toolbox.cpp)) +**Description** + +Todo + +**Usage** + +Todo + +**Constructors and Destructors** + Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + +Todo + +**Private Data Members** + +Todo + +**Notes** + +Todo + ### WaveHandler ([wave_handler.hpp](include/wave_handler.hpp), [wave_handler.cpp](src/wave_handler.cpp)) +**Description** + Todo -## Enums ([enums.hpp](include/enums.hpp)) +**Usage** + +Todo + +**Constructors and Destructors** + +Todo + +**Public Function Members** + +Todo + +**Private Function Members** + +Todo + +**Public Data Members** + +Todo + +**Private Data Members** + +Todo + +**Notes** + Todo + +## Enums ([enums.hpp](include/enums.hpp)) +**`MSTATE`** + +**`SSTATE`** + +**`GSTATE`** + +**`MESSAGETARGET`** + +**`BLOCKCHAINMESSAGE`** + +**`PATTERNMESSAGE`** + +**`DRAWERMESSAGE`** + +**`GUIMESSAGE`** + +**`WAVEMESSAGE`** + +**`PEVENTTYPE`** + ## ImGui Customization The ImGui library has been customized in the following way: - **`imgui_widgets.cpp`**: @@ -204,7 +663,17 @@ The ImGui library has been customized in the following way: - To run `ImGui` demos, one must revert the change to `ImGui_ImplSDL2_NewFrame` (see comments). ## GLSL Shaders -Todo +**`combine_damping`** + +**`copy_texture`** + +**`draw`** + +**`draw_blocks`** + +**`render2d`** + +**`stepwave`** ## Workflow: Sample `main` function Todo \ No newline at end of file