| zongqiang.zhang | 0c6a088 | 2019-08-07 14:48:21 +0800 | [diff] [blame] | 1 | /** |
| 2 | \file glcd_graphs.h |
| 3 | \brief GLCD Library - Graph drawing functions. |
| 4 | \author Andy Gock |
| 5 | */ |
| 6 | |
| 7 | /* |
| 8 | Copyright (c) 2012, Andy Gock |
| 9 | |
| 10 | All rights reserved. |
| 11 | |
| 12 | Redistribution and use in source and binary forms, with or without |
| 13 | modification, are permitted provided that the following conditions are met: |
| 14 | * Redistributions of source code must retain the above copyright |
| 15 | notice, this list of conditions and the following disclaimer. |
| 16 | * Redistributions in binary form must reproduce the above copyright |
| 17 | notice, this list of conditions and the following disclaimer in the |
| 18 | documentation and/or other materials provided with the distribution. |
| 19 | * Neither the name of Andy Gock nor the |
| 20 | names of its contributors may be used to endorse or promote products |
| 21 | derived from this software without specific prior written permission. |
| 22 | |
| 23 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
| 24 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| 25 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| 26 | DISCLAIMED. IN NO EVENT SHALL ANDY GOCK BE LIABLE FOR ANY |
| 27 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| 28 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| 29 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| 30 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 31 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| 32 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 33 | */ |
| 34 | |
| 35 | #ifndef GLCD_GRAPHS_H |
| 36 | #define GLCD_GRAPHS_H |
| 37 | |
| 38 | /** \addtogroup Graphing |
| 39 | * Functions for graphing, e.g drawing bar graphs etc. |
| 40 | * @{ |
| 41 | */ |
| 42 | |
| 43 | /** Draw horizontal bar graph with 1 px wide border. |
| 44 | * The bar graph draws from left to right as val increases. |
| 45 | * \param x x location for top-left of border |
| 46 | * \param y y location for top-left of border |
| 47 | * \param width width of the border |
| 48 | * \param height height of the border (must be over 2) |
| 49 | * \param val value to display in graph (0-255 8 bit value). |
| 50 | */ |
| 51 | void glcd_bar_graph_horizontal(uint8_t x, uint8_t y, uint8_t width, uint8_t height, uint8_t val); |
| 52 | |
| 53 | /** Draw horizontal bar graph with no border. |
| 54 | * The bar graph draws from left to right as val increases. |
| 55 | * \param x x location for top-left of bar |
| 56 | * \param y y location for top-left of bar |
| 57 | * \param width width of the bar at full val |
| 58 | * \param height height of the bar |
| 59 | * \param val value to display in graph (0-255 8 bit value). |
| 60 | */ |
| 61 | void glcd_bar_graph_horizontal_no_border(uint8_t x, uint8_t y, uint8_t width, uint8_t height, uint8_t val); |
| 62 | |
| 63 | /** Draw vertical bar graph with 1px wide border. |
| 64 | * The bar graph draws from bottom to top as val increases. |
| 65 | * \param x x location for top-left of border |
| 66 | * \param y y location for top-left of border |
| 67 | * \param width width of the border |
| 68 | * \param height height of the border |
| 69 | * \param val value to display in graph (0-255 8 bit value). |
| 70 | */ |
| 71 | void glcd_bar_graph_vertical(uint8_t x, uint8_t y, uint8_t width, uint8_t height, uint8_t val); |
| 72 | |
| 73 | /** Draw vertical bar graph with no border. |
| 74 | * The bar graph draws from bottom to top as val increases. |
| 75 | * \param x x location for top-left of bar |
| 76 | * \param y y location for top-left of bar |
| 77 | * \param width width of the bar |
| 78 | * \param height height of the bar |
| 79 | * \param val value to display in graph (0-255 8 bit value). |
| 80 | */ |
| 81 | void glcd_bar_graph_vertical_no_border(uint8_t x, uint8_t y, uint8_t width, uint8_t height, uint8_t val); |
| 82 | |
| 83 | /** \todo write doc */ |
| 84 | void glcd_scrolling_bar_graph(uint8_t x, uint8_t y, uint8_t width, uint8_t height, uint8_t val); |
| 85 | |
| 86 | /** @}*/ |
| 87 | |
| 88 | #endif |