Drawing Images

Image Drawing API. More...

Functions list
int	gl_draw_image (gl_rectangle_t *dest, gl_rectangle_t *src, const uint8_t *__generic image)
	Draw image on display. More...
uint16_t	gl_image_width (const uint8_t *__generic image)
	Calculate width of the image. More...
uint16_t	gl_image_height (const uint8_t *__generic image)
	Calculate height of the image. More...
gl_image_format_t	gl_image_format (const uint8_t *__generic image)
	Return format of the image. More...

Detailed Description

This API is used for drawing and managing images on the display.

Function Documentation

gl_draw_image()

int gl_draw_image	(	gl_rectangle_t *	dest,
		gl_rectangle_t *	src,
		const uint8_t *__generic	image
	)

This function draws an image on display. It is specialized for drawing support image formats, but may redefined by user. For that option please have a look at the Image Graphics Format Handlers.

Parameters

[in]	dest	Frame in which the image will be drawn. See gl_rectangle_t structure definition for detailed explanation.
[in]	src	Part of the original image which will be drawn into dest frame. See gl_rectangle_t structure definition for detailed explanation.
[in]	image	Pointer to an image.

Returns

Returns zero if the image is successfully drawn, otherwise returns non-zero value.

Precondition

Before using this function a driver must be set using the gl_set_driver function.

Note

Image must be generated by NECTO Studio's resource generator.

See also

gl_draw_jpeg_image, gl_draw_bitmap_16bpp, gl_draw_bitmap_8bpp, gl_draw_bitmap_4bpp, gl_draw_bitmap_1bpp

Example

 
#include "gl.h"
#include "board.h"
#include "tft8.h"
#include "resource.h"
 
static gl_driver_t driver;
static tft8_cfg_t tft_cfg;
 
void main()
{
 gl_rectangle_t dest = { {0,0}, 0, 0 };
 gl_rectangle_t src = { {0,0}, 100, 100 };
 
 // initialize driver
 TFT8_MAP_PINOUTS_16BIT(tft_cfg);
 tft_cfg.board = &TFT_BOARD_7_CAPACITIVE; 
 tft8_init(&tft_cfg, &driver);
 
 // prepare display for drawing
 gl_set_driver(&driver); // set initialized driver
 gl_clear(GL_CHARLESTON_GREEN); // clear display
 
 // display image true to its size
 // setting 0 for a source rectangle will use whole image without cropping
 dest.top_left.x = 10;
 dest.top_left.y = 70;
 dest.width = gl_image_width(mikroejpg);
 dest.height = gl_image_height(mikroejpg);
 gl_draw_image(&dest, 0, mikroejpg);
 
 // depending on the destination rectangle actual image can be stretched to fit rectangle dimensions
 
 // larger destination
 dest.top_left.x = 276;
 dest.width = gl_image_width(mikroebmp16) + 50;
 dest.height = gl_image_height(mikroebmp16) + 10;
 gl_draw_image(&dest, 0, mikroebmp16);
 
 // smaller destination
 dest.top_left.x = 600;
 dest.width = gl_image_width(mikroebmp8) / 2;
 dest.height = gl_image_height(mikroebmp8) / 2;
 gl_draw_image(&dest, 0, mikroebmp8);
 
 // and setting the soruce rectangle will crop the image
 // function will fit stretch source rect over crop rect area
 src.top_left.x = 10;
 src.top_left.y = 10;
 src.width = 40;
 src.height = 50;
 dest.top_left.x = 10;
 dest.top_left.y = 290;
 dest.width = gl_image_width(mikroebmp4);
 dest.height = gl_image_height(mikroebmp4);
 gl_draw_image(&dest, &src, mikroebmp4);
 
 // no destination giver results in an error
 if (gl_draw_image(&dest, 0, NULL) != 0)
 {
 gl_set_brush_color(GL_RED);
 gl_draw_circle(400, 340, 30);
 }
 
 // no destination giver results in an error
 if (gl_draw_image(NULL, 0, mikroebmp1) != 0)
 {
 gl_set_brush_color(GL_RED);
 gl_draw_circle(640, 340, 30);
 }
}
 

gl_image_width()

uint16_t gl_image_width

(

const uint8_t *__generic

image

)

This function returns the width of the image.

Parameters

[in]

image

Pointer to an image.

Returns

If the image is not null returns width of the image, otherwise returns zero.

Note

Image must be generated by NECTO Studio's resource generator.

Example

 
#include "gl.h"
#include "board.h"
#include "tft8.h"
#include "resource.h"
#include "conversions.h"
 
static gl_driver_t driver;
static tft8_cfg_t tft_cfg;
 
 
const code char* images[] = {
 mikroejpg,
 mikroebmp1,
 mikroebmp4,
 mikroebmp8,
 mikroebmp16
};
 
void print_num(gl_uint_t num, gl_coord_t x, gl_coord_t y){
 char str_buff[10];
 uint16_to_str(num, str_buff);
 gl_draw_text(str_buff, x, y);
}
 
void main()
{
 // initialize driver
 TFT8_MAP_PINOUTS_16BIT(tft_cfg);
 tft_cfg.board = &TFT_BOARD_7_CAPACITIVE; 
 tft8_init(&tft_cfg, &driver);
 
 // prepare display for drawing
 gl_set_driver(&driver); // set initialized driver
 gl_set_font(test_font); // set font
 gl_clear(GL_CHARLESTON_GREEN); // clear display
 
 gl_rectangle_t dest = { {5,5}, 100, 100 };
 for (int i = 0; i < 5 ; i++) 
 {
 dest.width = gl_image_width(images[i]);
 dest.height = gl_image_height(images[i]);
 
 gl_draw_image(&dest, 0, images[i]);
 print_num(dest.width, dest.width , dest.top_left.y);
 
 dest.top_left.y += dest.height + 10;
 }
}
 

gl_image_height()

uint16_t gl_image_height

(

const uint8_t *__generic

image

)

This function returns the height of the image.

Parameters

[in]

image

Pointer to an image.

Returns

If the image is not null returns height of the image, otherwise returns zero.

Note

Image must be generated by NECTO Studio's resource generator.

Example

 
#include "gl.h"
#include "board.h"
#include "tft8.h"
#include "resource.h"
#include "conversions.h"
 
static gl_driver_t driver;
static tft8_cfg_t tft_cfg;
 
 
const code char* images[] = {
 mikroejpg,
 mikroebmp1,
 mikroebmp4,
 mikroebmp8,
 mikroebmp16
};
 
void print_num(gl_uint_t num, gl_coord_t x, gl_coord_t y){
 char str_buff[10];
 uint16_to_str(num, str_buff);
 gl_draw_text(str_buff, x, y);
}
 
void main()
{
 // initialize driver
 TFT8_MAP_PINOUTS_16BIT(tft_cfg);
 tft_cfg.board = &TFT_BOARD_7_CAPACITIVE; 
 tft8_init(&tft_cfg, &driver);
 
 // prepare display for drawing
 gl_set_driver(&driver); // set initialized driver
 gl_set_font(test_font); // set font
 gl_clear(GL_CHARLESTON_GREEN); // clear display
 
 gl_rectangle_t dest = { {5,5}, 100, 100 };
 for (int i = 0; i < 5 ; i++) 
 {
 dest.width = gl_image_width(images[i]);
 dest.height = gl_image_height(images[i]);
 
 gl_draw_image(&dest, 0, images[i]);
 print_num(dest.height, dest.width , dest.top_left.y);
 
 dest.top_left.y += dest.height + 10;
 }
}
 
 

gl_image_format()

gl_image_format_t gl_image_format

(

const uint8_t *__generic

image

)

This function returns the format of the image.

Parameters

[in]

image

Pointer to an image.

Returns

If the image is not null returns format of image, otherwise returns zero. See gl_image_format_t structure definition for detailed explanation.

Note

Image must be generated by NECTO Studio's resource generator.

Example

 
#include "gl.h"
#include "board.h"
#include "tft8.h"
 
static gl_driver_t driver;
static tft8_cfg_t tft_cfg;
 
extern const code char mikroejpg[2701];
extern const code char mikroebmp1[2662];
extern const code char mikroebmp4[10493];
extern const code char mikroebmp8[21428];
extern const code char mikroebmp16[41826];
 
void main()
{
 // initialize driver
 TFT8_MAP_PINOUTS_16BIT(tft_cfg);
 tft_cfg.board = &TFT_BOARD_7_CAPACITIVE; 
 tft8_init(&tft_cfg, &driver);
 
 // prepare display for drawing
 gl_set_driver(&driver); // set initialized driver
 gl_clear(GL_CHARLESTON_GREEN); // clear display
 gl_set_pen_width(0); // turn off pen
 
 // we expect every circle to be green as confirmation that image format is correctly guessed
 
 // JPEG
 if (gl_image_format(mikroejpg) == GL_IMAGE_FORMAT_JPEG)
 gl_set_brush_color(GL_GREEN);
 else
 gl_set_brush_color(GL_RED);
 gl_draw_circle(20, 20, 10);
 
 // 1 bit BMP
 if (gl_image_format(mikroebmp1) == GL_IMAGE_FORMAT_BITMAP_1BPP)
 gl_set_brush_color(GL_GREEN);
 else
 gl_set_brush_color(GL_RED);
 gl_draw_circle(40, 20, 10);
 
 // 4 bit BMP
 if(gl_image_format(mikroebmp4) == GL_IMAGE_FORMAT_BITMAP_4BPP)
 gl_set_brush_color(GL_GREEN);
 else
 gl_set_brush_color(GL_RED);
 gl_draw_circle(60, 20, 10);
 
 // 8 bit BMP
 if(gl_image_format(mikroebmp8) == GL_IMAGE_FORMAT_BITMAP_8BPP)
 gl_set_brush_color(GL_GREEN);
 else
 gl_set_brush_color(GL_RED);
 gl_draw_circle(80, 20, 10);
 
 // 16 bit BMP
 if(gl_image_format(mikroebmp16) == GL_IMAGE_FORMAT_BITMAP_16BPP)
 gl_set_brush_color(GL_GREEN);
 else
 gl_set_brush_color(GL_RED);
 gl_draw_circle(100, 20, 10);
 
}