Fixing documentation for 2D operations

diff --git a/Kernel/Makefile.BuildNum b/Kernel/Makefile.BuildNum
index 8a76d62..306f0f3 100644 (file)
--- a/Kernel/Makefile.BuildNum
+++ b/Kernel/Makefile.BuildNum
@@ -1 +1 @@
-BUILD_NUM = 2071
+BUILD_NUM = 2072

diff --git a/Kernel/include/tpl_drv_video.h b/Kernel/include/tpl_drv_video.h
index 89bdbfd..f3313f6 100644 (file)
--- a/Kernel/include/tpl_drv_video.h
+++ b/Kernel/include/tpl_drv_video.h
@@ -160,7 +160,9 @@ enum eTplVideo_BufFormats
 };\r
 \r
 /**\r
- * \brief \r
+ * \brief 2D Accellerated Video Commands\r
+ * \r
+ * Commands passed in the command stream for ::VIDEO_BUFFMT_2DSTREAM\r
  */\r
 enum eTplVideo_2DCommands\r
 {\r
@@ -254,17 +256,46 @@ extern void       VT_Font_Render(Uint32 Codepoint, void *Buffer, int Pitch, Uint32 BGC
 extern Uint32  VT_Colour12to24(Uint16 Col12);\r
 \r
 /**\r
- * \r
+ * \brief Handlers for eTplVideo_2DCommands\r
  */\r
 typedef struct sDrvUtil_Video_2DHandlers\r
 {\r
+       /**\r
+        * \brief No Operation, Ignored\r
+        * \see VIDEO_2DOP_NOP\r
+        */\r
        void    *Nop;\r
+       /**\r
+        * \brief Fill a buffer region\r
+        * \param X     Lefthand edge\r
+        * \param Y     Top edge\r
+        * \param W     Width\r
+        * \param H     Height\r
+        * \param Colour        Colour to fill with\r
+        * \see VIDEO_2DOP_FILL\r
+        */\r
        void    (*Fill)(void *Ent, Uint16 X, Uint16 Y, Uint16 W, Uint16 H, Uint32 Colour);\r
+       /**\r
+        * \brief Fill a buffer region\r
+        * \param DestX Lefthand edge of destination\r
+        * \param DestY Top edge of destination\r
+        * \param SrcX  Lefthand edge of source\r
+        * \param SrcY  Top edge of source\r
+        * \param W     Width\r
+        * \param H     Height\r
+        * \see VIDEO_2DOP_BLIT\r
+        */\r
        void    (*Blit)(void *Ent, Uint16 DestX, Uint16 DestY, Uint16 SrcX, Uint16 SrcY, Uint16 W, Uint16 H);\r
 }      tDrvUtil_Video_2DHandlers;\r
 \r
 /**\r
- * \brief \r
+ * \brief Handle a 2D operation stream for a driver\r
+ * \param Ent  Value to pass to handlers\r
+ * \param Buffer       Stream buffer\r
+ * \param Length       Length of stream\r
+ * \param Handlers     Handlers to use for the stream\r
+ * \param SizeofHandlers       Size of \a tDrvUtil_Video_2DHandlers according\r
+ *        to the driver. Used as version control and error avoidence.\r
  */\r
 extern Uint64  DrvUtil_Video_2DStream(void *Ent, void *Buffer, int Length,\r
        tDrvUtil_Video_2DHandlers *Handlers, int SizeofHandlers);\r