commit b1a2c69aea376eeae6854575396a35a75556c5ab · pci.express/flanterm.zig

-5

README

···

       1
       1
       -
       Flanterm

     

       2
       2
       -
       ========

     

       3
       3
       -
       

     

       4
       4
       -
       Flanterm is a fast and reasonably complete terminal emulator with support for

     

       5
       5
       -
       multiple output backends. Included is a fast framebuffer backend.

+29

README.md

···

       1
       1
       +
       # Flanterm

     

       2
       2
       +
       

     

       3
       3
       +
       Flanterm is a fast and reasonably complete terminal emulator with support for

     

       4
       4
       +
       multiple output backends. Included is a fast framebuffer backend.

     

       5
       5
       +
       

     

       6
       6
       +
       ### Quick usage

     

       7
       7
       +
       

     

       8
       8
       +
       To quickly set up and use a framebuffer Flanterm instance, it is possible to

     

       9
       9
       +
       use the `flanterm_fb_simple_init()` function as such:

     

       10
       10
       +
       ```c

     

       11
       11
       +
       #include <flanterm/flanterm.h>

     

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

     

       13
       13
       +
       

     

       14
       14
       +
       struct flanterm_context *ft_ctx = flanterm_fb_simple_init(

     

       15
       15
       +
           framebuffer_ptr, framebuffer_width, framebuffer_height, framebuffer_pitch

     

       16
       16
       +
       );

     

       17
       17
       +
       ```

     

       18
       18
       +
       Where `framebuffer_{ptr,width,height,pitch}` represent the corresponding info

     

       19
       19
       +
       about the framebuffer to use for this given instance.

     

       20
       20
       +
       

     

       21
       21
       +
       To then print to the terminal instance, simply use the `flanterm_write()`

     

       22
       22
       +
       function on the given instance. For example:

     

       23
       23
       +
       ```c

     

       24
       24
       +
       #include <flanterm/flanterm.h>

     

       25
       25
       +
       

     

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

     

       27
       27
       +
       

     

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

     

       29
       29
       +
       ```

+21

backends/fb.h

···

       123
       123
        
           size_t margin

     

       124
       124
        
       );

     

       125
       125
        
       

     

       126
       126
       +
       #ifndef FLANTERM_FB_DISABLE_BUMP_ALLOC

     

       127
       127
       +
       static inline struct flanterm_context *flanterm_fb_simple_init(

     

       128
       128
       +
           uint32_t *framebuffer, size_t width, size_t height, size_t pitch

     

       129
       129
       +
       ) {

     

       130
       130
       +
           return flanterm_fb_init(

     

       131
       131
       +
               NULL,

     

       132
       132
       +
               NULL,

     

       133
       133
       +
               framebuffer, width, height, pitch,

     

       134
       134
       +
       #ifndef FLANTERM_FB_DISABLE_CANVAS

     

       135
       135
       +
               NULL,

     

       136
       136
       +
       #endif

     

       137
       137
       +
               NULL, NULL,

     

       138
       138
       +
               NULL, NULL,

     

       139
       139
       +
               NULL, NULL,

     

       140
       140
       +
               NULL, 0, 0, 1,

     

       141
       141
       +
               1, 1,

     

       142
       142
       +
               0

     

       143
       143
       +
           );

     

       144
       144
       +
       }

     

       145
       145
       +
       #endif

     

       146
       146
       +
       

     

       126
       147
        
       #ifdef __cplusplus

     

       127
       148
        
       }

     

       128
       149
        
       #endif