MicrOS
micros_console.h File Reference
#include <stdint.h>
#include <stdbool.h>
#include "micros_interrupts.h"

Go to the source code of this file.

Classes

struct  micros_console_position
 Structure representing cursor position in the console. More...
 

Enumerations

enum  micros_console_color {
  micros_console_color_black = 0x00, micros_console_color_blue = 0x01, micros_console_color_green = 0x02, micros_console_color_cyan = 0x03,
  micros_console_color_red = 0x04, micros_console_color_magenta = 0x05, micros_console_color_brown = 0x06, micros_console_color_light_gray = 0x07,
  micros_console_color_dark_gray = 0x08, micros_console_color_light_blue = 0x09, micros_console_color_light_green = 0x0A, micros_console_color_light_cyan = 0x0B,
  micros_console_color_light_red = 0x0C, micros_console_color_light_magenta = 0x0D, micros_console_color_yellow = 0x0E, micros_console_color_white = 0x0F
}
 Enum representing VGA color. More...
 

Functions

void micros_console_print_char (char c)
 Prints one char. More...
 
void micros_console_print_string (const char *str)
 Prints string. More...
 
char micros_console_get_char_at_position (micros_console_position *position)
 Returns char from the specified cursor position. More...
 
void micros_console_set_foreground_color (micros_console_color color)
 Sets foreground color. More...
 
void micros_console_set_background_color (micros_console_color color)
 Sets background color. More...
 
void micros_console_set_cursor_position (micros_console_position *position)
 Sets cursor position. More...
 
void micros_console_get_cursor_position (micros_console_position *position)
 Gets cursor position. More...
 
void micros_console_clear ()
 Clears whole console. More...
 
void micros_console_set_cursor_visibility (bool visibility)
 Sets cursor visibility. More...
 
void micros_console_set_video_mode (uint8_t mode)
 
void micros_console_copy_from_buffer (uint8_t *buffer, uint32_t how_many)
 

Enumeration Type Documentation

◆ micros_console_color

Enum representing VGA color.

Enumerator
micros_console_color_black 
micros_console_color_blue 
micros_console_color_green 
micros_console_color_cyan 
micros_console_color_red 
micros_console_color_magenta 
micros_console_color_brown 
micros_console_color_light_gray 
micros_console_color_dark_gray 
micros_console_color_light_blue 
micros_console_color_light_green 
micros_console_color_light_cyan 
micros_console_color_light_red 
micros_console_color_light_magenta 
micros_console_color_yellow 
micros_console_color_white 

Function Documentation

◆ micros_console_clear()

void micros_console_clear ( )

Clears whole console.

Clears whole console and sets cursor position at the begin.

◆ micros_console_copy_from_buffer()

void micros_console_copy_from_buffer ( uint8_t *  buffer,
uint32_t  how_many 
)

◆ micros_console_get_char_at_position()

char micros_console_get_char_at_position ( micros_console_position position)

Returns char from the specified cursor position.

Returns char from the specified cursor position.

Parameters
positionChar position.
Returns
Char at the specified position

◆ micros_console_get_cursor_position()

void micros_console_get_cursor_position ( micros_console_position position)

Gets cursor position.

Gets cursor position and stores it in the structure.

Parameters
positionCursor position where data will be stored.

◆ micros_console_print_char()

void micros_console_print_char ( char  c)

Prints one char.

Prints one char at the cursor position.

Parameters
cChar to print.

◆ micros_console_print_string()

void micros_console_print_string ( const char *  str)

Prints string.

Prints string at the cursor position (must be ended with 0).

Parameters
strString to print.

◆ micros_console_set_background_color()

void micros_console_set_background_color ( micros_console_color  color)

Sets background color.

Sets background color which will be used for all next prints.

Parameters
colorBackground color.

◆ micros_console_set_cursor_position()

void micros_console_set_cursor_position ( micros_console_position position)

Sets cursor position.

Sets cursor position where the next print will be started.

Parameters
positionCursor position.

◆ micros_console_set_cursor_visibility()

void micros_console_set_cursor_visibility ( bool  visibility)

Sets cursor visibility.

Sets cursor visibility (true in parameters means it will blink at the current position, otherwise it will be hided).

Parameters
visibilityVisibility flag.

◆ micros_console_set_foreground_color()

void micros_console_set_foreground_color ( micros_console_color  color)

Sets foreground color.

Sets foreground color which will be used for all next prints.

Parameters
colorForeground color.

◆ micros_console_set_video_mode()

void micros_console_set_video_mode ( uint8_t  mode)