Merge pull request #7928 from ChillerDragon/pr_doc_draw

Add doc comment for CUIRect::Draw()
This commit is contained in:
Dennis Felsing 2024-02-05 10:19:18 +00:00 committed by GitHub
commit 37b5040c43
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -120,6 +120,19 @@ public:
*/ */
bool Inside(float PointX, float PointY) const; bool Inside(float PointX, float PointY) const;
/**
* Fill background of *this* CUIRect.
*
* @note Example of filling a black half transparent background with 5px rounded edges on all sides
* @note ```MyCuiRect.Draw(ColorRGBA(0.0f, 0.0f, 0.0f, 0.5f), IGraphics::CORNER_ALL, 5.0f);```
*
* @note Example of filling a red background with sharp edges
* @note ```MyCuiRect.Draw(ColorRGBA(1.0f, 0.0f, 0.0f), IGraphics::CORNER_NONE, 0.0f);```
*
* @param Color
* @param Corners
* @param Rounding
*/
void Draw(ColorRGBA Color, int Corners, float Rounding) const; void Draw(ColorRGBA Color, int Corners, float Rounding) const;
void Draw4(ColorRGBA ColorTopLeft, ColorRGBA ColorTopRight, ColorRGBA ColorBottomLeft, ColorRGBA ColorBottomRight, int Corners, float Rounding) const; void Draw4(ColorRGBA ColorTopLeft, ColorRGBA ColorTopRight, ColorRGBA ColorBottomLeft, ColorRGBA ColorBottomRight, int Corners, float Rounding) const;