Changeset a9bd960c in mainline for console/screenbuffer.h

Timestamp:

2006-06-02T17:46:21Z (19 years ago)

Author:

Josef Cejka <malyzelenyhnus@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

e87e18f

Parents:

f1b4e74

Message:

Added doxygen comments.
Console now supports SET_STYLE call.

File:

• console/screenbuffer.h (modified) (6 diffs)

console/screenbuffer.h

@@ -31 +31 @@
 
 
-#define DEFAULT_FOREGROUND_COLOR 0xffffff
-#define DEFAULT_BACKGROUND_COLOR 0x00003f
+#define DEFAULT_FOREGROUND_COLOR 0xffffff       /**< default console foreground color */
+#define DEFAULT_BACKGROUND_COLOR 0x00003f       /**< default console background color */
 
 typedef struct {
@@ -39 +39 @@
 } style_t;
 
-/** One field at screen. It contain one character and its attributes. */
+/** One field on screen. It contain one character and its attributes. */
 typedef struct {
         char character;                 /**< Character itself */
@@ -55 +55 @@
 } screenbuffer_t;
 
+/** Returns keyfield for position on screen. Screenbuffer->buffer is cyclic buffer so we must couted in index of the topmost line.
+ * @param scr   screenbuffer
+ * @oaram x     position on screen
+ * @param y     position on screen
+ * @return      keyfield structure with character and its attributes on x,y
+ */
 static inline keyfield_t *get_field_at(screenbuffer_t *scr, unsigned int x, unsigned int y) 
 {
@@ -60 +66 @@
 }
 
+/** Compares two styles.
+ * @param s1 first style
+ * @param s2 second style
+ * @return nonzero on equality
+ */
 static inline int style_same(style_t s1, style_t s2)
 {
@@ -66 +77 @@
 
 
-int screenbuffer_putchar(screenbuffer_t *scr, char c);
+void screenbuffer_putchar(screenbuffer_t *scr, char c);
 screenbuffer_t *screenbuffer_init(screenbuffer_t *scr, int size_x, int size_y);
 
@@ -73 +84 @@
 void screenbuffer_copy_buffer(screenbuffer_t *scr, keyfield_t *dest);
 void screenbuffer_goto(screenbuffer_t *scr, unsigned int x, unsigned int y);
+void screenbuffer_set_style(screenbuffer_t *scr, unsigned int fg_color, unsigned int bg_color);
 
 #endif