KSM edits to RA8875
Diff: RA8875.h
- Revision:
- 147:3494792458d9
- Parent:
- 144:ba002c4b21b3
- Child:
- 149:c62c4b2d6a15
--- a/RA8875.h Thu Jun 01 11:00:40 2017 +0000 +++ b/RA8875.h Mon Jun 12 22:15:08 2017 +0000 @@ -1163,10 +1163,36 @@ /// /// @param[in] rect1 is a rectangular region. /// @param[in] rect2 is a second rectangular region. - /// @returns true if rect1 and rect2 intersect. + /// @returns true if any part of rect2 intersects rect1. /// bool Intersect(rect_t rect1, rect_t rect2); + /// Determine if a rectangle intersects another rectangle and provides + /// the area of intersection. + /// + /// @code + /// +---------------------+ + /// | rect1 | + /// | | + /// | +------------------+ + /// | | rect3 | | + /// | | | | + /// +---------------------+ | + /// | rect2 | + /// +------------------+ + /// @endcode + /// + /// @note that the first parameter is a pointer to a rect and the + /// + /// @param[inout] pRect1 is a pointer to a rectangular region, and returns + /// the area of intersection. + /// @param[in] pRect2 is a pointer to a second rectangular region. + /// @returns true if pRect1 and pRect2 intersect and pRect1 is written with + /// the rectangle describing the intersection. + /// + bool Intersect(rect_t * rect1, const rect_t * rect2); + + /// Write a command to the display with a word of data. /// /// This is a high level command, and may invoke several primitives.