hal.h

Go to the documentation of this file.

/**
 * @file hal.h
 * @brief Drawing to the frame buffer
 *
 * The HAL (hardware abstraction layer) generally provides a way for other parts of the
 * OS to interact with low-lever hardware functions without needing to know details
 * specific to a particular platform.
 *
 * In this case, the HAL provides a generatic way to draw pixels to the screen.
 */
#ifndef _HAL_H
#define _HAL_H
 
#include <stdint.h>
#include "color.h"
 
/**
 * @brief Initialize the frame buffer
 *
 * This should be called before any other function in this header, otherwise the behavior
 * is undefined.
 *
 * @return 0 on success, non-zero on error
 */
int hal_init(void);
 
/**
 * @brief Draw a pixel to the screen
 * @param x Pixels from left edge
 * @param y Pixels from top edge
 * @param color Color value to set the pixel to
 */
void hal_putpixel(uint32_t x, uint32_t y, color_t color);
 
/**
 * @brief Draw a rectangle to the screen
 * @param x Pixels from left edge of screen to left edge of rectangle
 * @param y Pixels from top edge of screen to top edge of rectangle
 * @param w Width of rectangle in pixels
 * @param h Height of rectangle in pixels
 * @param color Color value to set all pixels within the rectangle to
 */
void hal_fillrect(uint32_t x, uint32_t y, uint32_t w, uint32_t h, color_t color);
 
/**
 * @brief Get screen width
 * @return Width of the screen in pixels
 */
uint64_t hal_width(void);
 
/**
 * @brief Get screen height
 * @return Height of the screen in pixels
 */
uint64_t hal_height(void);
 
#endif