alex/Adafruit-GFX-Library
1
0
Fork 0
mirror of https://github.com/adafruit/Adafruit-GFX-Library.git synced 2024-09-20 17:46:09 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add doxygen for getTextBounds()

Browse Source 
Signed-off-by: Emil Muratov <gpm@hotplug.ru>
This commit is contained in:
Emil Muratov 2018-08-09 00:06:59 +03:00
parent 05df41d963
commit 15344e4ff9
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Adafruit_GFX.cpp
View File

@ -1415,7 +1415,18 @@ void Adafruit_GFX::getTextBounds(const char *str, int16_t x, int16_t y,
}
}
// Overload for the same as above, but for String strings
/**************************************************************************/
/*!
@brief Helper to determine size of a string with current font/size. Pass string and a cursor position, returns UL corner and W,H.
@param str The ascii string to measure (as an arduino String() class)
@param x The current cursor X
@param y The current cursor Y
@param x1 The boundary X coordinate, set by function
@param y1 The boundary Y coordinate, set by function
@param w The boundary width, set by function
@param h The boundary height, set by function
*/
/**************************************************************************/
void Adafruit_GFX::getTextBounds(const String &str, int16_t x, int16_t y,
int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h) {
if (str.length() != 0) {