Go to file
2023-12-05 19:55:14 +01:00
backends backends/fb: Fix compiler warning regarding inlining 2023-10-24 06:15:12 +02:00
flanterm.c Fix -Wsign-conversion warnings 2023-11-07 18:38:27 -08:00
flanterm.h Drop in_bootloader 2023-03-30 01:15:41 +02:00
LICENSE Update LICENSE to stay within 80 col 2023-12-05 19:55:14 +01:00
README.md Add flanterm_fb_simple_init() and add basic usage to README 2023-07-07 18:25:04 +02:00

Flanterm

Flanterm is a fast and reasonably complete terminal emulator with support for multiple output backends. Included is a fast framebuffer backend.

Quick usage

To quickly set up and use a framebuffer Flanterm instance, it is possible to use the flanterm_fb_simple_init() function as such:

#include <flanterm/flanterm.h>
#include <flanterm/backends/fb.h>

struct flanterm_context *ft_ctx = flanterm_fb_simple_init(
    framebuffer_ptr, framebuffer_width, framebuffer_height, framebuffer_pitch
);

Where framebuffer_{ptr,width,height,pitch} represent the corresponding info about the framebuffer to use for this given instance.

To then print to the terminal instance, simply use the flanterm_write() function on the given instance. For example:

#include <flanterm/flanterm.h>

const char msg[] = "Hello world\n";

flanterm_write(ft_ctx, msg, sizeof(msg));