* \note For AcessOS Version 1\r
* \r
* Video drivers extend the common driver interface api_drv_common.h\r
- * and must support _at least_ the IOCtl numbers defined in this file\r
- * to be compatable with Acess.\r
+ * and must support the IOCtl numbers defined in this file to be\r
+ * compatable with Acess (drivers may implement more IOCtls above\r
+ * DRV_IOCTL_USERMIN).\r
* \r
* \section IOCtls\r
* As said, a compatable driver must implement these calls correctly,\r
* framebuffer.\r
* \r
* \section Mode Support\r
- * All video drivers must support at least one text mode (Mode #0)\r
- * For each graphics mode the driver exposes, there must be a corresponding\r
- * text mode with the same resolution, this mode will be used when the\r
- * user switches to a text Virtual Terminal while in graphics mode.\r
+ * All video drivers must support text output for every resolution (hardware\r
+ * accelerated or software), and at least the _BLIT and _FILL 2D operations\r
+ * (these may be implemented specifically for text mode).\r
*/\r
#ifndef _API_DRV_VIDEO_H\r
#define _API_DRV_VIDEO_H\r
* \return 1 if a mode was found, 0 otherwise\r
* \r
* Using avaliable modes matching the \a bpp and \a flags fields\r
- * set the \a id field to the mode id of the mode with the closest\r
- * \a width and \a height.\r
+ * set the \a id, \a width and \a heights fields to the closest\r
+ * matching mode.\r
*/\r
VIDEO_IOCTL_FINDMODE,\r
\r
*/\r
VIDEO_IOCTL_SETCURSORBITMAP\r
};\r
-#define DRV_VIDEO_IOCTLNAMES "getset_mode", "find+mode", "mode_info", "set_buf_format", "set_cursor", "set_cursor_bitmap"\r
+\r
+/**\r
+ * \brief Symbolic names for Video IOCtls (#4 onwards)\r
+ */\r
+#define DRV_VIDEO_IOCTLNAMES "getset_mode", "find_mode", "mode_info", "set_buf_format", "set_cursor", "set_cursor_bitmap"\r
\r
/**\r
* \brief Mode Structure used in IOCtl Calls\r
short id; //!< Mode ID\r
Uint16 width; //!< Width\r
Uint16 height; //!< Height\r
- Uint8 bpp; //!< Bits per Unit (Character or Pixel, depending on \a flags)\r
- Uint8 flags; //!< Mode Flags\r
+ Uint8 bpp; //!< Bits per pixel\r
+ Uint8 flags; //!< Mode Flags (none defined, should be zero)\r
} tVideo_IOCtl_Mode;\r
\r
/**\r
extern int giVT_CharWidth;\r
//! \brief Defines the height of a rendered character\r
extern int giVT_CharHeight;\r
+/**\r
+ * \name Font rendering\r
+ * \{\r
+ */\r
/**\r
* \brief Driver helper that renders a character to a buffer\r
* \param Codepoint Unicode character to render\r
* The final bit of each component is used to fill the lower bits of the output.\r
*/\r
extern Uint32 VT_Colour12toN(Uint16 Col12, int Depth);\r
+/**\r
+ * \}\r
+ */\r
+\r
+/**\r
+ * \brief Maximum cursor width for using the DrvUtil software cursor\r
+ */\r
+#define DRVUTIL_MAX_CURSOR_W 32\r
+/**\r
+ * \brief Maximum cursor width for using the DrvUtil software cursor\r
+ */\r
+#define DRVUTIL_MAX_CURSOR_H 32\r
+\r
+/**\r
+ * \brief Framebuffer information used by all DrvUtil_Video functions\r
+ */\r
+typedef struct sDrvUtil_Video_BufInfo\r
+{\r
+ /**\r
+ * \name Framebuffer state\r
+ * \{\r
+ */\r
+ /**\r
+ * \brief Framebuffer virtual address\r
+ */\r
+ void *Framebuffer;\r
+ /**\r
+ * \brief Bytes between the start of each line\r
+ */\r
+ int Pitch;\r
+ /**\r
+ * \brief Number of pixels in each line\r
+ */\r
+ short Width;\r
+ /**\r
+ * \brief Total number of lines\r
+ */\r
+ short Height;\r
+ /**\r
+ * \brief Bit depth of the framebuffer\r
+ */\r
+ short Depth;\r
+ /*\r
+ * \}\r
+ */\r
+ \r
+ /**\r
+ * \brief Buffer write format\r
+ */\r
+ short BufferFormat;\r
+ \r
+ /**\r
+ * \name Software cursor controls\r
+ * \{\r
+ */\r
+ /**\r
+ * \brief X coordinate of the cursor\r
+ */\r
+ short CursorX;\r
+ /**\r
+ * \brief Y coordinate of the cursor\r
+ */\r
+ short CursorY;\r
+\r
+ /**\r
+ * \brief Cursor bitmap\r
+ */\r
+ tVideo_IOCtl_Bitmap *CursorBitmap;\r
+ /*\r
+ * \}\r
+ */\r
+\r
+ /*\r
+ * \name Internal fields\r
+ * \{\r
+ */\r
+\r
+ /**\r
+ * \brief Buffer to store the area under the cursor\r
+ */\r
+ void *CursorSaveBuf;\r
+ \r
+ int CursorReadX; //!< X offset in cursor bitmap corresponding to \a CursorDestX\r
+ int CursorReadY; //!< Same as \a CursorReadX but for Y\r
+ int CursorRenderW; //!< Width of rendered cursor\r
+ int CursorRenderH; //!< Height of rendered cursor\r
+ int CursorDestX; //!< X coordinate Destination for rendered cursor\r
+ int CursorDestY; //!< Y coordinate destination for rendered cursor\r
+\r
+ /*\r
+ * \}\r
+ */\r
+} tDrvUtil_Video_BufInfo;\r
\r
/**\r
* \brief Handlers for eTplVideo_2DCommands\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
+} tDrvUtil_Video_2DHandlers;\r
\r
/**\r
* \brief Handle a 2D operation stream for a driver\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
+extern int DrvUtil_Video_2DStream(void *Ent, void *Buffer, int Length,\r
tDrvUtil_Video_2DHandlers *Handlers, int SizeofHandlers);\r
\r
+/**\r
+ * \brief Perform write operations to a LFB\r
+ * \param FBInfo Framebuffer descriptor, see type for details\r
+ * \param Offset Offset provided by VFS call\r
+ * \param Length Length provided by VFS call\r
+ * \param Src Data from VFS call\r
+ * \return Number of bytes written\r
+ *\r
+ * Handles all write modes in software, using the VT font calls for rendering.\r
+ * \note Calls the cursor clear and redraw if the cursor area is touched\r
+ */\r
+extern int DrvUtil_Video_WriteLFB(tDrvUtil_Video_BufInfo *FBInfo, size_t Offset, size_t Length, void *Src);\r
+\r
+/**\r
+ * \name Software cursor rendering\r
+ * \{\r
+ */\r
+/**\r
+ * \brief Set the cursor bitmap for a buffer\r
+ * \param Buf Framebuffer descriptor\r
+ * \param Bitmap New cursor bitmap\r
+ */\r
+extern void DrvUtil_Video_SetCursor(tDrvUtil_Video_BufInfo *Buf, tVideo_IOCtl_Bitmap *Bitmap);\r
+/**\r
+ * \brief Render the cursor at (\a X, \a Y)\r
+ * \param Buf Framebuffer descriptor, see type for details\r
+ * \param X X coord of the cursor\r
+ * \param Y Y coord of the cursor\r
+ */\r
+extern void DrvUtil_Video_DrawCursor(tDrvUtil_Video_BufInfo *Buf, int X, int Y);\r
+/**\r
+ * \brief Removes the rendered cursor from the screen\r
+ * \param Buf Framebuffer descriptor, see type for details\r
+ */\r
+extern void DrvUtil_Video_RemoveCursor(tDrvUtil_Video_BufInfo *Buf);\r
+/**\r
+ * \}\r
+ */\r
#endif\r
git.ucc.asn.au / tpg / acess2.git / blobdiff
UCC git Repository :: git.ucc.asn.au