Usermode - AxWin2 notes, and a write support test app

[tpg/acess2.git] / Usermode / Applications / axwin3_src / WM / include / wm_renderer.h

diff --git a/Usermode/Applications/axwin3_src/WM/include/wm_renderer.h b/Usermode/Applications/axwin3_src/WM/include/wm_renderer.h
index f870290..ba8ce04 100644 (file)
--- a/Usermode/Applications/axwin3_src/WM/include/wm_renderer.h
+++ b/Usermode/Applications/axwin3_src/WM/include/wm_renderer.h
@@ -8,10 +8,47 @@
 #ifndef _WM_RENDERER_H_
 #define _WM_RENDERER_H_
 
-typedef struct
+typedef struct sWMRenderer
 {
+       /**
+        * \brief Internal pointer to next loaded renderer
+        */
+       struct sWMRenderer      *Next;
+
+       /**
+        * \brief Renderer name / identifier
+        */
+       const char      *Name;
+
+       /**
+        * \brief Initialise a window structure for the renderer
+        * \param W     Width of the new window
+        * \param H     Height of the new window
+        * \param Flags Flags for the window
+        * \return malloc()'d window structure, or NULL on error
+        * \note Only the fields \a W and \a H need be filled in the window
+        *       structure, the rest will be filled by the caller.
+        */
        tWindow (*InitWindow)(int W, int H, int Flags);
+
+       /**
+        * \brief Redraw a window on the screen
+        * \param Window        Window to render
+        * 
+        * Called when a window needs to be re-rendered, e.g. when it is uncovered or
+        * repositioned.
+        *
+        * \todo List all conditions for Redraw
+        */
        void    (*Redraw)(tWindow *Window);
+       
+       /**
+        * \brief Handle a message sent to the window using WM_SendMessage
+        * \param Window        Target window
+        * \param MessageID     Implementation defined message ID (usually the command)
+        * \param Length        Length of the buffer \a Data
+        * \param Data          Implementation defined data buffer
+        */
         int    (*SendMessage)(tWindow *Window, int MessageID, int Length, void *Data);
 }      tWMRenderer;