TFT_eSPI::drawRect, TFT_eSPI::drawRoundRect & TFT_eSPI::drawSmoothRoundRect

Description

Draw a rectangle outline or a rounded corner rectangle outline or an anti-aliased & rounded rectangle.

Signature

void TFT_eSPI::drawRect(int32_t x, int32_t y, int32_t w, int32_t h, uint32_t color)
void TFT_eSPI::drawRoundRect(int32_t x, int32_t y, int32_t w, int32_t h, int32_t r, uint32_t color)
void TFT_eSPI::drawSmoothRoundRect(int32_t x, int32_t y, int32_t r, int32_t ir, int32_t w, int32_t h, uint32_t fg_color, uint32_t bg_color = 0x00FFFFFF, uint8_t quadrants = 0xF)

Parameters

ìnt32_t x: x coord from.
ìnt32_t y: y coord from.
ìnt32_t w: rectangle width.
ìnt32_t h: rectangle height.
int32_t r: rounded radius.
uìnt32_t color: line color.
int32_t ir: inner corner radius.
uìnt32_t fg_color: line color.
uìnt32_t bg_color: background color (default to 0x00FFFFFF); If bg_color is not included the background pixel colour will be read from TFT or sprite.
uint8_t quadrants: default to 0xF.

drawSmoothRoundRect

x,y is top left corner of bounding box for a complete rounded rectangle
r = arc outer corner radius, ir = arc inner radius. Arc thickness = r-ir+1
w and h are width and height of the bounding rectangle
If w and h are < radius (e.g. 0,0) a circle will be drawn with centre at x+r,y+r
Arc foreground fg_color anti-aliased with background colour at edges
A subset of corners can be drawn by specifying a quadrants mask. A bit set in the mask means draw that quadrant (all are drawn if parameter missing):

Arc quadrant mask select bits (as in drawCircleHelper function)

left right

top 0x1 0x2

bottom 0x8 0x4

Result

None.

Example

Example 1: drawRect

#include <TFT_eSPI.h>

TFT_eSPI tft = TFT_eSPI();

void setup() {
  tft.init();
  tft.fillScreen(TFT_BLACK); // clear the screen
}

void loop() {
  // Draw a rectangle with a red border
  tft.drawRect(10, 10, 50, 30, TFT_RED);
  delay(1000);
}

In this example, we use drawRect to draw a rectangle with the following parameters:

x: 10 (the x-coordinate of the top-left corner of the rectangle)
y: 10 (the y-coordinate of the top-left corner of the rectangle)
width: 50 (the width of the rectangle)
height: 30 (the height of the rectangle)
color: TFT_RED (the color of the border)

Example 2: drawRoundRect

#include <TFT_eSPI.h>

TFT_eSPI tft = TFT_eSPI();

void setup() {
  tft.init();
  tft.fillScreen(TFT_BLACK); // clear the screen
}

void loop() {
  // Draw a rounded rectangle with a blue border
  tft.drawRoundRect(20, 20, 60, 40, 10, TFT_BLUE);
  delay(1000);
}

In this example, we use drawRoundRect to draw a rounded rectangle with the following parameters:

x: 20 (the x-coordinate of the top-left corner of the rectangle)
y: 20 (the y-coordinate of the top-left corner of the rectangle)
width: 60 (the width of the rectangle)
height: 40 (the height of the rectangle)
radius: 10 (the radius of the rounded corners)
color: TFT_BLUE (the color of the border)

Note

The radius parameter in drawRoundRect specifies the radius of the rounded corners. A larger radius will result in more rounded corners, while a smaller radius will result in sharper corners.

	left	right
top	0x1	0x2
bottom	0x8	0x4