muteki/canvas_8h_source.html

/*

 * Copyright 2021-present dogtopus

 * SPDX-License-Identifier: MIT

 */


#ifndef __MUTEKI_UI_CANVAS_H__

#define __MUTEKI_UI_CANVAS_H__


#include <muteki/ui/common.h>


#ifdef __cplusplus

extern "C" {

#endif


extern short GetFontType(void);


extern void SetFontType(short font_type);


extern void WriteAlignString(short x, short y, const void *s, short max_length, int align, unsigned int flags);


extern void WriteChar(short x, short y, UTF16 c, unsigned int flags);


extern void WriteString(short x, short y, const void *s, unsigned int flags);


extern void Printf(const char *format, ...) SYS_IS_PRINTF(1, 2);


extern void PrintfXY(short x, short y, const char *format, ...) SYS_IS_PRINTF(3, 4);


extern int ShowGraphic(short x, short y, lcd_surface_t *surface, unsigned short flags);


extern unsigned int SetCursorSize(unsigned int new_size);


extern unsigned int GetCursorSize(void);


extern void SetCursorPosition(short x, short y);


extern void GetCursorPosition(short *x, short *y);


extern short SetCursorType(short new_type);


extern short GetCursorType(void);


extern void CursorLock(void);


extern void CursorUnlock(void);


extern int SetTransparentColor(int color);


extern int rgbSetBkColor(int color);


extern int rgbSetColor(int color);


short SetPenStyle(short dash, unsigned int *dash_pattern);


short GetPenStyle(unsigned int *dash_pattern);


short GetPenSize(void);


short SetPenSize(short size);


int GetPixel(short x, short y);


int SetPixel(short x, short y, int color);


extern size_t GetImage(short x0, short y0, short x1, short y1, lcd_surface_t *surface);


extern void PutImage(short x, short y, lcd_surface_t *surface, unsigned short flags);


extern void SetDrawArea(short x0, short y0, short x1, short y1);


extern void GetDrawArea(short *x0, short *y0, short *x1, short *y1);


extern void DrawLine(short x0, short y0, short x1, short y1, unsigned int flags);


extern void DrawRect(short x0, short y0, short x1, short y1, unsigned int flags);


extern void FillRect(short x0, short y0, short x1, short y1, unsigned int flags);


extern void DrawRoundRect(short x0, short y0, short x1, short y1, short rx, short ry, unsigned int flags);


extern void DrawCircle(short x, short y, short r, unsigned int flags);


extern void FillCircle(short x, short y, short r, unsigned int flags);


extern void DrawEllipse(short x, short y, short rx, short ry, unsigned int flags);


extern void FillEllipse(short x, short y, short rx, short ry, unsigned int flags);


extern void InverseSetArea(short x0, short y0, short x1, short y1);


extern void ClearScreen(bool fill_with_fg);


extern void ScrollDown(short x0, short y0, short x1, short y1, short amount);


extern void ScrollLeft(short x0, short y0, short x1, short y1, short amount);


extern void ScrollRight(short x0, short y0, short x1, short y1, short amount);


extern void ScrollUp(short x0, short y0, short x1, short y1, short amount);


extern lcd_t *CreateVirtualLCD(short width, short height, short width_bytes);


extern void DeleteVirtualLCD(lcd_t *lcd);


extern lcd_t *SetActiveLCD(lcd_t *new_lcd);


extern lcd_t *GetActiveLCD(void);


extern lcd_t *CreateCompatibleLCD(lcd_t *source);


extern lcd_surface_t *SetDCObject(lcd_t *lcd, lcd_surface_t *new_surface);


extern short GetMaxScrX(void);


extern short GetMaxScrY(void);


#ifdef __cplusplus

} // extern "C"

#endif


#endif // __MUTEKI_UI_CANVAS_H__

PutImage
void PutImage(short x, short y, lcd_surface_t *surface, unsigned short flags)
Copy pixels from a surface to current active LCD.

GetCursorPosition
void GetCursorPosition(short *x, short *y)
Get the cursor position on the current canvas.

DrawRect
void DrawRect(short x0, short y0, short x1, short y1, unsigned int flags)
Stroke a rectangle on the current active LCD.

SetFontType
void SetFontType(short font_type)
Set the current font type to font_type.

Printf
void Printf(const char *format,...) SYS_IS_PRINTF(1
Format and draw a string.

GetPenSize
short GetPenSize(void)
Get the stroke width.

DrawCircle
void DrawCircle(short x, short y, short r, unsigned int flags)
Stroke a circle on the current active LCD.

SetDrawArea
void SetDrawArea(short x0, short y0, short x1, short y1)
Set the drawing area of the current active LCD.

GetPenStyle
short GetPenStyle(unsigned int *dash_pattern)
Get the stroke dash pattern.

rgbSetColor
int rgbSetColor(int color)
Set display canvas foreground fill color.

WriteString
void WriteString(short x, short y, const void *s, unsigned int flags)
Draw a string s aligned to the top left corner at (x, y) px.

DrawRoundRect
void DrawRoundRect(short x0, short y0, short x1, short y1, short rx, short ry, unsigned int flags)
Stroke a rounded corner rectangle on the current active LCD.

ScrollUp
void ScrollUp(short x0, short y0, short x1, short y1, short amount)
Move a rectangle up by amount pixels.

InverseSetArea
void InverseSetArea(short x0, short y0, short x1, short y1)
Invert color within a rectangle.

GetMaxScrY
short GetMaxScrY(void)
Get Y coordinate of the bottom-most visible pixels on the current canvas.

ScrollDown
void ScrollDown(short x0, short y0, short x1, short y1, short amount)
Move a rectangle down by amount pixels.

SetPixel
int SetPixel(short x, short y, int color)
Set the pixel color on the current active surface with the given pixel.

FillCircle
void FillCircle(short x, short y, short r, unsigned int flags)
Fill a circle on the current active LCD.

FillRect
void FillRect(short x0, short y0, short x1, short y1, unsigned int flags)
Fill a rectangle on the current active LCD.

PrintfXY
void void PrintfXY(short x, short y, const char *format,...) SYS_IS_PRINTF(3
Format and draw a string aligned to the top left corner at (x, y) px.

GetCursorSize
unsigned int GetCursorSize(void)
Get the size of the cursor on the current canvas.

SetDCObject
lcd_surface_t * SetDCObject(lcd_t *lcd, lcd_surface_t *new_surface)
Link a surface (device context) to an LCD descriptor.

GetImage
size_t GetImage(short x0, short y0, short x1, short y1, lcd_surface_t *surface)
Copy a rectangle of pixels from current active LCD and save it to the specified buffer.

SetActiveLCD
lcd_t * SetActiveLCD(lcd_t *new_lcd)
Set an LCD descriptor as active.

WriteAlignString
void WriteAlignString(short x, short y, const void *s, short max_length, int align, unsigned int flags)
Draw a string s with specified alignment at (x, y) px.

rgbSetBkColor
int rgbSetBkColor(int color)
Set display canvas background fill color.

FillEllipse
void FillEllipse(short x, short y, short rx, short ry, unsigned int flags)
Fill an ellipse on the current active LCD.

WriteChar
void WriteChar(short x, short y, UTF16 c, unsigned int flags)
Draw a UTF-16 character c aligned to the top left corner at (x, y) px.

SetCursorType
short SetCursorType(short new_type)
Set the type of the cursor on the current canvas.

CursorUnlock
void CursorUnlock(void)
Unlock the cursor on the current canvas.

SetPenSize
short SetPenSize(short size)
Set the stroke width.

CreateVirtualLCD
lcd_t * CreateVirtualLCD(short width, short height, short width_bytes)
Create a virtual LCD descriptor.

CursorLock
void CursorLock(void)
Lock the cursor on the current canvas.

GetFontType
short GetFontType(void)
Get the current font type.

ClearScreen
void ClearScreen(bool fill_with_fg)
Fill the current display canvas with background color, effectively clearing it.

SetCursorPosition
void SetCursorPosition(short x, short y)
Move the cursor position on the current canvas to the specified coordinate.

GetMaxScrX
short GetMaxScrX(void)
Get X coordinate of the rightmost visible pixels on the current canvas.

SetTransparentColor
int SetTransparentColor(int color)
Set display canvas transparent color.

ShowGraphic
void void int ShowGraphic(short x, short y, lcd_surface_t *surface, unsigned short flags)
Draw a surface onto current active LCD.

ScrollLeft
void ScrollLeft(short x0, short y0, short x1, short y1, short amount)
Move a rectangle left by amount pixels.

DeleteVirtualLCD
void DeleteVirtualLCD(lcd_t *lcd)
Dispose a previously created virtual LCD descriptor.

GetActiveLCD
lcd_t * GetActiveLCD(void)
Get the current active LCD descriptor.

DrawLine
void DrawLine(short x0, short y0, short x1, short y1, unsigned int flags)
Stroke a line on the current active LCD.

GetCursorType
short GetCursorType(void)
Get the type of the cursor on the current canvas.

GetDrawArea
void GetDrawArea(short *x0, short *y0, short *x1, short *y1)
Get the drawing area of the current active LCD.

CreateCompatibleLCD
lcd_t * CreateCompatibleLCD(lcd_t *source)
Copy an LCD descriptor (excluding surface).

SetCursorSize
unsigned int SetCursorSize(unsigned int new_size)
Set the size of the cursor on the current canvas.

GetPixel
int GetPixel(short x, short y)
Get the RGB value of a pixel on the current active surface.

DrawEllipse
void DrawEllipse(short x, short y, short rx, short ry, unsigned int flags)
Stroke an ellipse on the current active LCD.

ScrollRight
void ScrollRight(short x0, short y0, short x1, short y1, short amount)
Move a rectangle right by amount pixels.

SetPenStyle
short SetPenStyle(short dash, unsigned int *dash_pattern)
Set the stroke dash pattern.

UTF16
#define UTF16
"Portable" Besta UTF-16 type used by other headers.
Definition common.h:54

SYS_IS_PRINTF
#define SYS_IS_PRINTF(arg_index_str, arg_index_fmt)
Attribute for opting a function in for printf static checking.
Definition common.h:92

lcd_base_s
The LCD descriptor.
Definition common.h:901

lcd_surface_s
Descriptor of an LCD drawing surface or hardware framebuffer.
Definition common.h:728

common.h
Common data structures and definitions for the UI subsystem.