console.h

Go to the documentation of this file.

#ifndef CONSOLE_H
#define CONSOLE_H
 
#include <stdint.h>
#include "color.h"
 
/**
 * @brief Redraws a character.
 * 
 * @param row The row.
 * @param col The column.
 */
void credrawchar(uint32_t row, uint32_t col);
 
/**
 * @brief Refreshes the console's screen.
 */
void crefresh(void);
 
/**
 * @brief Clears the console's screen.
 * 
 * @param color Background color. */
void cclear(color_t color);
 
/**
 * @brief Clears a cell.
 * 
 * @param row The row.
 * @param col The column.
 * @param color Background color. */
void cclearchar(uint32_t row, uint32_t col, color_t color);
 
/**
 * @brief Clears the cell at the cursor's position.
 * 
 * @param color Background color.
 */
void cclearcurchar(color_t color);
 
/**
 * @brief Moves the cursor by an offset.
 * 
 * @param rows Number of rows.
 * @param cols Number of columns.
 */
void cmovecursor(int32_t rows, int32_t cols);
 
/**
 * @brief Prints a string to the console, without a newline.
 *
 * @param str String to be printed. Must be null-terminated.
 * @param color Foreground color.
 */
void cprint(const char *str, color_t color);
 
/**
 * @brief Prints a string to the console followed by a newline.
 *
 * @param str String to be printed. Must be null-terminated.
 * @param color Foreground color of the text.
 */
void cprintln(const char *str, color_t color);
 
/**
 * @brief Prints a character at the cursor's position in the given color.
 *
 * @param c Character to be written.
 * @param color Foreground color of the text.
 */
void cputchar(char c, color_t color);
 
/**
 * @brief Writes an integer in base 10 at the cursor's position in the given color.
 *
 * @param i Integer to be written.
 * @param color Foreground color of the text. */
void cputint(int i, color_t color);
 
/**
 * @brief Resets the cursor's position.
 */
void crcursor(void);
 
/**
 * @brief Sets the cursor's position.
 * 
 * @param row The row.
 * @param col The column.
 */
void csetcursor(uint32_t row, uint32_t col);
 
/**
 * @brief Sets the cursor's column.
 * 
 * @param col Column
 */
void csetcol(int32_t col);
 
/**
 * @brief Sets the cursor's row.
 * 
 * @param row Row.
 */
void csetrow(int32_t row);
 
/**
 * @brief Gets the cursor's column.
 * 
 * @returns Column.
 */
uint32_t cgetcol(void);
 
/**
 * @brief Gets the cursor's row.
 * 
 * @returns Row.
 */
uint32_t cgetrow(void);
 
#endif // CONSOLE_H