2c8f92039d
Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
1357 lines
66 KiB
HTML
Executable file
1357 lines
66 KiB
HTML
Executable file
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
xosd.c File Reference
|
|
</title>
|
|
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
|
|
</head>
|
|
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
|
|
<hl>Software Drivers</hl>
|
|
<hr class="whs1">
|
|
<!-- Generated by Doxygen 1.4.5 -->
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li id="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul></div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul></div>
|
|
<h1>xosd.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
This is main code of Xilinx MVI Video On-Screen-Display (OSD) device driver. Please see xosd.h for more details of the driver.<p>
|
|
<pre>
|
|
MODIFICATION HISTORY:</pre><p>
|
|
<pre> Ver Who Date Changes
|
|
----- ---- -------- -------------------------------------------------------
|
|
1.00a xd 08/18/08 First release
|
|
1.02a xd 12/21/10 Removed endian conversion for text bank loading
|
|
1.03a cm 09/07/11 Updated <a class="el" href="xosd_8c.html#418c2aee59e346663d5c67b000abb291">XOSD_GetLayerAlpha()</a>, <a class="el" href="xosd_8c.html#e46a6c3c128211c916a2be00c24b047d">XOSD_SetLayerAlpha()</a>,
|
|
<a class="el" href="xosd_8c.html#9645592b9797b8e4272c9c4f05ec36a9">XOSD_SetBackgroundColor()</a> and <a class="el" href="xosd_8c.html#104eb9a1d064275f031a6a4dde38228a">XOSD_GetBackgroundColor()</a>
|
|
to allow 10 and 12 bit alpha and background colors.
|
|
2.00a cjm 12/18/12 Converted from xio.h to xil_io.h, translating
|
|
basic types, MB cache functions, exceptions and
|
|
assertions to xil_io format.
|
|
</pre>
|
|
<p>
|
|
<code>#include "xosd.h"</code><br>
|
|
<code>#include "xenv.h"</code><br>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#1d42b019d7a221d78ecc01ac778165e6">XOSD_CfgInitialize</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, <a class="el" href="struct_x_o_s_d___config.html">XOSD_Config</a> *CfgPtr, u32 EffectiveAddr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#a7c5b41c84807c410394844fa3ff00c4">XOSD_SetBlankPolarity</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, int VerticalBlankPolarity, int HorizontalBlankPolarity)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#37592dd54ac5803c672677ebd7653427">XOSD_SetScreenSize</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u32 Width, u32 Height)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#b1c58105a8eeb504c704778c0591f8cf">XOSD_GetScreenSize</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u32 *WidthPtr, u32 *HeightPtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#9645592b9797b8e4272c9c4f05ec36a9">XOSD_SetBackgroundColor</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u16 Red, u16 Blue, u16 Green)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#104eb9a1d064275f031a6a4dde38228a">XOSD_GetBackgroundColor</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u16 *RedPtr, u16 *BluePtr, u16 *GreenPtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#6024c5d98d951324afb09d51d918d375">XOSD_SetLayerDimension</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 LayerIndex, u16 XStart, u16 YStart, u16 XSize, u16 YSize)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#888198ee553d726cf0a9600dff9243ec">XOSD_GetLayerDimension</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 LayerIndex, u16 *XStartPtr, u16 *YStartPtr, u16 *XSizePtr, u16 *YSizePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#e46a6c3c128211c916a2be00c24b047d">XOSD_SetLayerAlpha</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 LayerIndex, u16 GlobalAlphaEnble, u16 GlobalAlphaValue)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#418c2aee59e346663d5c67b000abb291">XOSD_GetLayerAlpha</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 LayerIndex, u16 *GlobalAlphaEnblePtr, u16 *GlobalAlphaValuePtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#c4aedd48172b4b1263733dd43a75f693">XOSD_SetLayerPriority</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 LayerIndex, u8 Priority)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#b21a487755348d5b066786d9cefe08d7">XOSD_GetLayerPriority</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 LayerIndex, u8 *PriorityPtr)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#4e4e1a1ce5dd4cb27fe123c3798fb74e">XOSD_EnableLayer</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 LayerIndex)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#4e0393255a40c2e824ecda4680a91bf2">XOSD_DisableLayer</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 LayerIndex)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#048d390e0186ae6e457cf01910937ee6">XOSD_LoadColorLUTBank</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 GcIndex, u8 BankIndex, u32 *ColorData)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#1105c4e907463503f66a164e997f964a">XOSD_LoadCharacterSetBank</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 GcIndex, u8 BankIndex, u32 *CharSetData)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#500884fcb64a18dbd1805abcd0ef847e">XOSD_LoadTextBank</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 GcIndex, u8 BankIndex, u32 *TextData)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#0aa62e27f95144f3267b54a30bded73c">XOSD_SetActiveBank</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 GcIndex, u8 ColorBankIndex, u8 CharBankIndex, u8 TextBankIndex, u8 InstructionBankIndex)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#a608cb7116651228e727931056ccb1bc">XOSD_CreateInstruction</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u32 *InstructionPtr, u8 GcIndex, u16 ObjType, u8 ObjSize, u16 XStart, u16 YStart, u16 XEnd, u16 YEnd, u8 TextIndex, u8 ColorIndex)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#4508305376e6966b4a297a6105ba4a37">XOSD_LoadInstructionList</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u8 GcIndex, u8 BankIndex, u32 *InstSetPtr, u32 InstNum)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xosd_8c.html#d64c0312373982bf774f29c32ecd7344">XOSD_GetVersion</a> (<a class="el" href="struct_x_o_s_d.html">XOSD</a> *InstancePtr, u16 *Major, u16 *Minor, u16 *Revision)</td></tr>
|
|
|
|
</table>
|
|
<hr><h2>Function Documentation</h2>
|
|
<a class="anchor" name="1d42b019d7a221d78ecc01ac778165e6"></a><!-- doxytag: member="xosd.c::XOSD_CfgInitialize" ref="1d42b019d7a221d78ecc01ac778165e6" args="(XOSD *InstancePtr, XOSD_Config *CfgPtr, u32 EffectiveAddr)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int XOSD_CfgInitialize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="struct_x_o_s_d___config.html">XOSD_Config</a> * </td>
|
|
<td class="mdname" nowrap> <em>CfgPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u32 </td>
|
|
<td class="mdname" nowrap> <em>EffectiveAddr</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function initializes an OSD device. This function must be called prior to using an OSD device. Initialization of an OSD includes setting up the instance data, and ensuring the hardware is in a quiescent state.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CfgPtr</em> </td><td>points to the configuration structure associated with the OSD device. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddr</em> </td><td>is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>XST_SUCCESS </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a608cb7116651228e727931056ccb1bc"></a><!-- doxytag: member="xosd.c::XOSD_CreateInstruction" ref="a608cb7116651228e727931056ccb1bc" args="(XOSD *InstancePtr, u32 *InstructionPtr, u8 GcIndex, u16 ObjType, u8 ObjSize, u16 XStart, u16 YStart, u16 XEnd, u16 YEnd, u8 TextIndex, u8 ColorIndex)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_CreateInstruction </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u32 * </td>
|
|
<td class="mdname" nowrap> <em>InstructionPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>GcIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>ObjType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>ObjSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>XStart</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>YStart</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>XEnd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>YEnd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>TextIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>ColorIndex</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function creates an instruction for an OSD.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>InstructionPtr</em> </td><td>is a pointer to the instruction buffer to be populated with the instruction to be created. The upper level application is responsible for allocating this instruction buffer. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GcIndex</em> </td><td>indicates the Graphics Controller that will consume the instruction. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ObjType</em> </td><td>indicates the type of object to draw. Use one of XOSD_INS_OPCODE_... constants defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ObjSize</em> </td><td>indicates line width of boxes and lines and the text scale factor for text boxes. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XStart</em> </td><td>indicates the horizontal start pixel of the Object. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>YStart</em> </td><td>indicates the vertical start line of the Object. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XEnd</em> </td><td>indicates the horizontal end pixel of the Object. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>YEnd</em> </td><td>indicates the vertical end line of the Object. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>TextIndex</em> </td><td>indicates the string index. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ColorIndex</em> </td><td>indicates the color index. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="4e0393255a40c2e824ecda4680a91bf2"></a><!-- doxytag: member="xosd.c::XOSD_DisableLayer" ref="4e0393255a40c2e824ecda4680a91bf2" args="(XOSD *InstancePtr, u8 LayerIndex)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_DisableLayer </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>LayerIndex</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function disables an OSD layer.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LayerIndex</em> </td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the device - 1). </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="4e4e1a1ce5dd4cb27fe123c3798fb74e"></a><!-- doxytag: member="xosd.c::XOSD_EnableLayer" ref="4e4e1a1ce5dd4cb27fe123c3798fb74e" args="(XOSD *InstancePtr, u8 LayerIndex)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_EnableLayer </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>LayerIndex</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function enables an OSD layer.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LayerIndex</em> </td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the device - 1). </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="104eb9a1d064275f031a6a4dde38228a"></a><!-- doxytag: member="xosd.c::XOSD_GetBackgroundColor" ref="104eb9a1d064275f031a6a4dde38228a" args="(XOSD *InstancePtr, u16 *RedPtr, u16 *BluePtr, u16 *GreenPtr)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_GetBackgroundColor </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>RedPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>BluePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>GreenPtr</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function gets the Background color used by the OSD output.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>RedPtr</em> </td><td>will point to the red value used in the background color after this function returns. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>BluePtr</em> </td><td>will point to the blue value used in the background color after this function returns. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GreenPtr</em> </td><td>will point to the green value used in the background color after this function returns. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="418c2aee59e346663d5c67b000abb291"></a><!-- doxytag: member="xosd.c::XOSD_GetLayerAlpha" ref="418c2aee59e346663d5c67b000abb291" args="(XOSD *InstancePtr, u8 LayerIndex, u16 *GlobalAlphaEnblePtr, u16 *GlobalAlphaValuePtr)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_GetLayerAlpha </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>LayerIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>GlobalAlphaEnblePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>GlobalAlphaValuePtr</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function gets the Alpha value and mode of an OSD layer.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LayerIndex</em> </td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the device - 1). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GlobalAlphaEnblePtr</em> </td><td>will point to a flag indicating whether the global Alpha is enabled on a layer after this function returns. Flag 1 indicates that the global Alpha is enabled, 0 indicates that it is not. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GlobalAlphaValuePtr</em> </td><td>will point to the transparent level after this function returns. 0 for 100% transparent, 255 (8bit) for 0% transparent (100% opaque). </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="888198ee553d726cf0a9600dff9243ec"></a><!-- doxytag: member="xosd.c::XOSD_GetLayerDimension" ref="888198ee553d726cf0a9600dff9243ec" args="(XOSD *InstancePtr, u8 LayerIndex, u16 *XStartPtr, u16 *YStartPtr, u16 *XSizePtr, u16 *YSizePtr)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_GetLayerDimension </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>LayerIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>XStartPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>YStartPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>XSizePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>YSizePtr</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function gets the start position and size of an OSD layer.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LayerIndex</em> </td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the device - 1). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XStartPtr</em> </td><td>will point to the Horizontal start pixel value of origin of the layer after this function returns. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>YStartPtr</em> </td><td>will point to the Vertical start line of origin of the layer after this function returns. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XSizePtr</em> </td><td>will point to the Horizontal Size value of the layer after this function returns. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>YSizePtr</em> </td><td>will point to the Vertical Size value of the layer after this function returns. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="b21a487755348d5b066786d9cefe08d7"></a><!-- doxytag: member="xosd.c::XOSD_GetLayerPriority" ref="b21a487755348d5b066786d9cefe08d7" args="(XOSD *InstancePtr, u8 LayerIndex, u8 *PriorityPtr)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_GetLayerPriority </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>LayerIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 * </td>
|
|
<td class="mdname" nowrap> <em>PriorityPtr</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function gets the priority of an OSD layer.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LayerIndex</em> </td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the device - 1). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>PriorityPtr</em> </td><td>will point to the priority used on the layer after this function returns. Use XOSD_LAYER_PRIORITY_... defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a> to interpret the value. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="b1c58105a8eeb504c704778c0591f8cf"></a><!-- doxytag: member="xosd.c::XOSD_GetScreenSize" ref="b1c58105a8eeb504c704778c0591f8cf" args="(XOSD *InstancePtr, u32 *WidthPtr, u32 *HeightPtr)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_GetScreenSize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u32 * </td>
|
|
<td class="mdname" nowrap> <em>WidthPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u32 * </td>
|
|
<td class="mdname" nowrap> <em>HeightPtr</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function gets the screen size of the OSD Output.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>WidthPtr</em> </td><td>will point to the width of the OSD output after this function returns. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>HeightPtr</em> </td><td>will point to the height of the OSD output after this function returns. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="d64c0312373982bf774f29c32ecd7344"></a><!-- doxytag: member="xosd.c::XOSD_GetVersion" ref="d64c0312373982bf774f29c32ecd7344" args="(XOSD *InstancePtr, u16 *Major, u16 *Minor, u16 *Revision)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_GetVersion </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>Major</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>Minor</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 * </td>
|
|
<td class="mdname" nowrap> <em>Revision</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function returns the version of an OSD device.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Major</em> </td><td>points to an unsigned 16-bit variable that will be assigned with the major version number after this function returns. Value range is from 0x0 to 0xF. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Minor</em> </td><td>points to an unsigned 16-bit variable that will be assigned with the minor version number after this function returns. Value range is from 0x00 to 0xFF. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Revision</em> </td><td>points to an unsigned 16-bit variable that will be assigned with the revision version number after this function returns. Value range is from 0xA to 0xF. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>None. </dd></dl>
|
|
<dl compact><dt><b>Note:</b></dt><dd>Example: Device version should read v2.01.c if major version number is 0x2, minor version number is 0x1, and revision version number is 0xC. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="1105c4e907463503f66a164e997f964a"></a><!-- doxytag: member="xosd.c::XOSD_LoadCharacterSetBank" ref="1105c4e907463503f66a164e997f964a" args="(XOSD *InstancePtr, u8 GcIndex, u8 BankIndex, u32 *CharSetData)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_LoadCharacterSetBank </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>GcIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>BankIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u32 * </td>
|
|
<td class="mdname" nowrap> <em>CharSetData</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function loads Character Set data (font) into an OSD Graphics Controller Bank.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GcIndex</em> </td><td>indicates which Graphics Controller to work on. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>BankIndex</em> </td><td>indicates which GC Bank to be worked on. Valid value range is from 0 to XOSD_GC_BANK_NUM - 1. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CharSetData</em> </td><td>points to the Character Set data to be loaded. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="048d390e0186ae6e457cf01910937ee6"></a><!-- doxytag: member="xosd.c::XOSD_LoadColorLUTBank" ref="048d390e0186ae6e457cf01910937ee6" args="(XOSD *InstancePtr, u8 GcIndex, u8 BankIndex, u32 *ColorData)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_LoadColorLUTBank </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>GcIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>BankIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u32 * </td>
|
|
<td class="mdname" nowrap> <em>ColorData</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function loads color LUT data into an OSD Graphics Controller Bank.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GcIndex</em> </td><td>indicates which Graphics Controller to work on. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>BankIndex</em> </td><td>indicates which GC Bank to be worked on. Valid value range is from 0 to XOSD_GC_BANK_NUM - 1. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ColorData</em> </td><td>points to the color LUT data to be loaded. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="4508305376e6966b4a297a6105ba4a37"></a><!-- doxytag: member="xosd.c::XOSD_LoadInstructionList" ref="4508305376e6966b4a297a6105ba4a37" args="(XOSD *InstancePtr, u8 GcIndex, u8 BankIndex, u32 *InstSetPtr, u32 InstNum)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_LoadInstructionList </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>GcIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>BankIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u32 * </td>
|
|
<td class="mdname" nowrap> <em>InstSetPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u32 </td>
|
|
<td class="mdname" nowrap> <em>InstNum</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function load an instruction list to be used by an Graphic Controller in an OSD device.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GcIndex</em> </td><td>indicates which Graphics Controller to work on. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>BankIndex</em> </td><td>indicates which GC Bank to be worked on. Valid value range is from 0 to XOSD_GC_BANK_NUM. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>InstSetPtr</em> </td><td>is a pointer to the start of the instruction list to load into the OSD device. The last instruction in the list must has XOSD_INS_OPCODE_END type. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>InstNum</em> </td><td>indicates the number of the instructions in the list to load. Valid value range is from 1 to the half of the size of the instruction memory created for the Graphic Controller </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="500884fcb64a18dbd1805abcd0ef847e"></a><!-- doxytag: member="xosd.c::XOSD_LoadTextBank" ref="500884fcb64a18dbd1805abcd0ef847e" args="(XOSD *InstancePtr, u8 GcIndex, u8 BankIndex, u32 *TextData)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_LoadTextBank </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>GcIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>BankIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u32 * </td>
|
|
<td class="mdname" nowrap> <em>TextData</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function loads Text data into an OSD Graphics Controller Bank.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GcIndex</em> </td><td>indicates which Graphics Controller to work on. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>BankIndex</em> </td><td>indicates which GC Bank to be worked on. Valid value range is from 0 to XOSD_GC_BANK_NUM - 1. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>TextData</em> </td><td>points to the Text data to be loaded. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="0aa62e27f95144f3267b54a30bded73c"></a><!-- doxytag: member="xosd.c::XOSD_SetActiveBank" ref="0aa62e27f95144f3267b54a30bded73c" args="(XOSD *InstancePtr, u8 GcIndex, u8 ColorBankIndex, u8 CharBankIndex, u8 TextBankIndex, u8 InstructionBankIndex)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_SetActiveBank </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>GcIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>ColorBankIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>CharBankIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>TextBankIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>InstructionBankIndex</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function chooses active banks for a GC in an OSD device.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GcIndex</em> </td><td>indicates which Graphics Controller to work on. Valid value range is from 0 to (The Number of Layers) - 1. The layer's type must be set to XOSD_LAYER_TYPE_GPU (defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a>) for this function to work properly. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>ColorBankIndex</em> </td><td>indicates the Color LUT bank to be choose as active. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>CharBankIndex</em> </td><td>indicates the Character Set bank to be choose as active. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>TextBankIndex</em> </td><td>indicates the Text Data bank to be choose as active. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>InstructionBankIndex</em> </td><td>indicates the Instruction bank to be choose as active. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="9645592b9797b8e4272c9c4f05ec36a9"></a><!-- doxytag: member="xosd.c::XOSD_SetBackgroundColor" ref="9645592b9797b8e4272c9c4f05ec36a9" args="(XOSD *InstancePtr, u16 Red, u16 Blue, u16 Green)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_SetBackgroundColor </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>Red</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>Blue</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>Green</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function sets the Background color used by the OSD output.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Red</em> </td><td>indicates the red value used in the background color. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Blue</em> </td><td>indicates the blue value used in the background color. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Green</em> </td><td>indicates the green value used in the background color. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a7c5b41c84807c410394844fa3ff00c4"></a><!-- doxytag: member="xosd.c::XOSD_SetBlankPolarity" ref="a7c5b41c84807c410394844fa3ff00c4" args="(XOSD *InstancePtr, int VerticalBlankPolarity, int HorizontalBlankPolarity)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_SetBlankPolarity </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>VerticalBlankPolarity</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>HorizontalBlankPolarity</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function chooses the type of Vertical and Horizontal Blank Input Polarities.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>VerticalBlankPolarity</em> </td><td>indicates the type of vertical blank input polarity. Use any non-0 value for Active High and 0 for Active Low. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>HorizontalBlankPolarity</em> </td><td>indicates the type of horizontal blank input polarity. Use any non-0 value for Active High and 0 for Active Low. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="e46a6c3c128211c916a2be00c24b047d"></a><!-- doxytag: member="xosd.c::XOSD_SetLayerAlpha" ref="e46a6c3c128211c916a2be00c24b047d" args="(XOSD *InstancePtr, u8 LayerIndex, u16 GlobalAlphaEnble, u16 GlobalAlphaValue)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_SetLayerAlpha </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>LayerIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>GlobalAlphaEnble</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>GlobalAlphaValue</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function sets the Alpha value and mode of an OSD layer.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LayerIndex</em> </td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the device - 1). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GlobalAlphaEnble</em> </td><td>indicates whether to enable the global Alpha. Use any non-0 value to enable the global Alpha, and 0 to disable it. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>GlobalAlphaValue</em> </td><td>indicates the transparent level. 0 for 100% transparent, 255 (8bit) for 0% transparent (100% opaque). This argument will be ignored if parameter GlobalAlphaEnble has value 0. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="6024c5d98d951324afb09d51d918d375"></a><!-- doxytag: member="xosd.c::XOSD_SetLayerDimension" ref="6024c5d98d951324afb09d51d918d375" args="(XOSD *InstancePtr, u8 LayerIndex, u16 XStart, u16 YStart, u16 XSize, u16 YSize)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_SetLayerDimension </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>LayerIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>XStart</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>YStart</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>XSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u16 </td>
|
|
<td class="mdname" nowrap> <em>YSize</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function sets the start position and size of an OSD layer.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LayerIndex</em> </td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the device - 1). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XStart</em> </td><td>indicates the Horizontal start pixel of origin of the layer. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>YStart</em> </td><td>indicates the Vertical start line of origin of the layer. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>XSize</em> </td><td>indicates the Horizontal Size of the layer. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>YSize</em> </td><td>indicates the Vertical Size of the layer. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="c4aedd48172b4b1263733dd43a75f693"></a><!-- doxytag: member="xosd.c::XOSD_SetLayerPriority" ref="c4aedd48172b4b1263733dd43a75f693" args="(XOSD *InstancePtr, u8 LayerIndex, u8 Priority)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_SetLayerPriority </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>LayerIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u8 </td>
|
|
<td class="mdname" nowrap> <em>Priority</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function sets the priority of an OSD layer.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>LayerIndex</em> </td><td>indicates which layer to be worked on. Valid value range is from 0 to (the number of layers implemented in the device - 1). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Priority</em> </td><td>indicates the priority to be applied on the layer. Use one of XOSD_LAYER_PRIORITY_0 (the lowest priority) through XOSD_LAYER_PRIORITY_7 (the highest priority) defined in <a class="el" href="xosd__hw_8h.html">xosd_hw.h</a> </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="37592dd54ac5803c672677ebd7653427"></a><!-- doxytag: member="xosd.c::XOSD_SetScreenSize" ref="37592dd54ac5803c672677ebd7653427" args="(XOSD *InstancePtr, u32 Width, u32 Height)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void XOSD_SetScreenSize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="struct_x_o_s_d.html">XOSD</a> * </td>
|
|
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u32 </td>
|
|
<td class="mdname" nowrap> <em>Width</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>u32 </td>
|
|
<td class="mdname" nowrap> <em>Height</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function sets the screen size of the OSD Output.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the OSD device instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Width</em> </td><td>defines the width of the OSD output </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Height</em> </td><td>defines the height of the OSD output </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>NONE. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
|