Fixing documentation for 2D operations

[tpg/acess2.git] / Kernel / include / tpl_drv_terminal.h

diff --git a/Kernel/include/tpl_drv_terminal.h b/Kernel/include/tpl_drv_terminal.h
index fa90c86..ee50392 100644 (file)
--- a/Kernel/include/tpl_drv_terminal.h
+++ b/Kernel/include/tpl_drv_terminal.h
@@ -59,7 +59,13 @@ enum eTplTerminal_IOCtl {
         * \note The id field of \a info is not for use with ::TERM_IOCTL_MODETYPE\r
         *       This field is just for indexing the mode to get its information.\r
         */\r
-       TERM_IOCTL_QUERYMODE\r
+       TERM_IOCTL_QUERYMODE,\r
+       \r
+       /**\r
+        * ioctl(...)\r
+        * \brief Forces the current terminal to be shown\r
+        */\r
+       TERM_IOCTL_FORCESHOW\r
 };\r
 \r
 /**\r
@@ -97,13 +103,20 @@ enum eTplTerminal_Modes {
         */\r
        TERM_MODE_FB,\r
        \r
+       /**\r
+        * \brief 32bpp 2D Accellerated mode\r
+        * Writes to the terminal file will be read as a command stream\r
+        * defined in ::eTplTerminal_2D_Commands\r
+        */\r
+       TERM_MODE_2DACCEL,\r
+       \r
        /**\r
         * \brief OpenGL 2D/3D\r
         * Writes to the terminal file will send 3D commands\r
         * Reads will return UTF-32 characters\r
         * \note May or may not stay in the spec\r
         */\r
-       TERM_MODE_OPENGL,\r
+       TERM_MODE_3D,\r
        \r
        /**\r
         * \brief Number of terminal modes\r
@@ -111,5 +124,27 @@ enum eTplTerminal_Modes {
        NUM_TERM_MODES\r
 };\r
 \r
+/**\r
+ * \brief 2D Command IDs\r
+ * \todo Complete this structure\r
+ * \r
+ * Command IDs for when the terminal type is eTplTerminal_Modes.TERM_MODE_2DACCEL\r
+ */\r
+enum eTplTerminal_2D_Commands\r
+{\r
+       /**\r
+        * \brief No Operation - Used for padding\r
+        */\r
+       TERM_2DCMD_NOP,\r
+       \r
+       /**\r
+        * (Uint16 X, Y, W, H, Uint32 Data[])\r
+        * \brief Blits a bitmap to the display\r
+        * \param X,Y   Coordinates of Top-Left corner\r
+        * \param W,H   Dimensions\r
+        * \param Data  32-bpp pixel data\r
+        */\r
+       TERM_2DCMD_PUSH\r
+};\r
 \r
 #endif\r