embeddedsw/XilinxProcessorIPLib/drivers/rgb2ycrcb/doc/html/api/xrgb2ycrcb_8c.html
Durga challa 7921deaf6c rgb2ycrcb: Changed enum names.
Removed Haddress in TCL file under config structure and
Modified doxygen report, modified enum names in xrgb2ycrcb.c and xrgb2ycrcb.c files.

Signed-off-by: Durga challa <vnsldurg@xilinx.com>
Acked-by: Srikanth Vemula <svemula@xilinx.com>
2014-09-02 11:21:16 +05:30

1449 lines
76 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
xrgb2ycrcb.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.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;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&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<h1>xrgb2ycrcb.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
This file contains the implementation of the interface functions for RGB2YCRCB driver. Refer to the header file <a class="el" href="xrgb2ycrcb_8h.html">xrgb2ycrcb.h</a> for more detailed information.<p>
<pre>
MODIFICATION HISTORY:</pre><p>
<pre> Ver Who Date Changes
----- ------ -------- -------------------------------------------------------
5.00a tb 02/27/12 Updated for RGB2YCRCB v5.00.a.
7.0 adk 01/07/14 Changed the file name from "rgb2ycrcb.c" to
"xrgb2ycrcb.c".</pre><p>
<pre> Implemented the following functions:
XRgb2YCrCb_CfgInitialize, XRgb2YCrCb_EnableDbgByPass,
XRgb2YCrCb_IsDbgByPassEnabled,
XRgb2YCrCb_DisableDbgBypass,
XRgb2YCrCb_EnableDbgTestPattern,
XRgb2YCrCb_IsDbgTestPatternEnabled,
XRgb2YCrCb_DisableDbgTestPattern,
XRgb2YCrCb_GetVersion, XRgb2YCrCb_GetDbgFrameCount,
XRgb2YCrCb_GetDbgLineCount,
XRgb2YCrCb_GetDbgPixelCount, XRgb2YCrCb_Setup,
XRgb2YCrCb_SetActiveSize, XRgb2YCrCb_GetActiveSize,
XRgb2YCrCb_SetYMax, XRgb2YCrCb_GetYMax,
XRgb2YCrCb_SetYMin, XRgb2YCrCb_GetYMin,
XRgb2YCrCb_SetCbMax, XRgb2YCrCb_GetCbMax,
XRgb2YCrCb_SetCbMin, XRgb2YCrCb_GetCbMin,
XRgb2YCrCb_SetCrMax, XRgb2YCrCb_GetCrMax,
XRgb2YCrCb_SetCrMin, XRgb2YCrCb_GetCrMin,
XRgb2YCrCb_SetYOffset, XRgb2YCrCb_GetYOffset,
XRgb2YCrCb_SetCbOffset, XRgb2YCrCb_GetCbOffset,
XRgb2YCrCb_SetCrOffset, XRgb2YCrCb_GetCrOffset,
XRgb2YCrCb_SetCoefs, XRgb2YCrCb_GetCoefs,
XRgb2YCrCb_Select_Standard,
XRgb2YCrCb_Coefficient_Translation,
XRgb2YCrCb_Select_OutputRange.
</pre>
<p>
<code>#include &quot;<a class="el" href="xrgb2ycrcb_8h.html">xrgb2ycrcb.h</a>&quot;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#584a818bca95b80de513294519c54ee2">XRgb2YCrCb_CfgInitialize</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, <a class="el" href="struct_x_rgb2_y_cr_cb___config.html">XRgb2YCrCb_Config</a> *CfgPtr, u32 EffectiveAddr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#c742cc05360bb180cc57cc8fd6a7605f">XRgb2YCrCb_EnableDbgByPass</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#3d35a1adbadf61ad019954a5f4587b75">XRgb2YCrCb_IsDbgByPassEnabled</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#bdcafa368136089da5d5206220f3c52c">XRgb2YCrCb_DisableDbgBypass</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#5ec42003828e3e835f09ef7be76e4876">XRgb2YCrCb_EnableDbgTestPattern</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#f6f98177fb8bded5d21fc68257a49064">XRgb2YCrCb_IsDbgTestPatternEnabled</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#96e9ad14631f0d111e13370d6de8687d">XRgb2YCrCb_DisableDbgTestPattern</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#4d33f70be0091a541f59ccc2fae8b321">XRgb2YCrCb_GetVersion</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#05165c0c1bf1f8cd5e9db2651dc0390c">XRgb2YCrCb_GetDbgFrameCount</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#6ea399e3c37faccfc3664e632f08e853">XRgb2YCrCb_GetDbgLineCount</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#fa055f6e4fccf13e41fde0d51f196177">XRgb2YCrCb_GetDbgPixelCount</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#c99d692e475eb69dc95a666e58d06c7b">XRgb2YCrCb_Setup</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#068788cac52a17d49848da6443235ea1">XRgb2YCrCb_SetActiveSize</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, u16 HSize, u16 VSize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#7d3723e8bae174fd28b4cc3f6e022cac">XRgb2YCrCb_GetActiveSize</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, u16 *HSize, u16 *VSize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#fd685f798f6c43ce121eec09d3f5fe7f">XRgb2YCrCb_SetYMax</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, u32 YMax)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#2b42bd16e5b9525bff94f9eabe19df1e">XRgb2YCrCb_GetYMax</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#8cfcf42b1428ad80a23abd74c8d4ca6b">XRgb2YCrCb_SetYMin</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, u32 YMin)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#c15c6a85e4604f4c7716ebe69093917a">XRgb2YCrCb_GetYMin</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#a8918c65e3bd52acd1d0923a16a255eb">XRgb2YCrCb_SetCbMax</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, u32 CbMax)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#16a2ff2bbf296128593c05bf6208c35b">XRgb2YCrCb_GetCbMax</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#af72e639f6ec9a424f316360852fbe61">XRgb2YCrCb_SetCbMin</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, u32 CbMin)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#2fc6ca7fef260e69514ff025e25e5fc3">XRgb2YCrCb_GetCbMin</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#09cb057bdb4c96b8a3d1ed2411fba8ff">XRgb2YCrCb_SetCrMax</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, u32 CrMax)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#6e2b3f03de46204316376fb6b70efe15">XRgb2YCrCb_GetCrMax</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#7097a7fffb31f244f3d8b8980a41d7ed">XRgb2YCrCb_SetCrMin</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, u32 CrMin)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#ee524e16f2ee827ad923f3c5919871e7">XRgb2YCrCb_GetCrMin</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#b4c03e136fcf6039a16ac5e6a2422921">XRgb2YCrCb_SetYOffset</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, u32 YOffset)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#c17bd369ba0e788e5dcbca27fb2c7940">XRgb2YCrCb_GetYOffset</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#216aa5281d270baf69de79daf425a465">XRgb2YCrCb_SetCbOffset</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, u32 CbOffset)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#a1d2a2bf12afc210fa1ac924a7ba7fff">XRgb2YCrCb_GetCbOffset</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#3a4c66f6336a4ee35d36d0f95941f3af">XRgb2YCrCb_SetCrOffset</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, u32 CrOffset)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#83eca3ac96dba90cf821ac8bac3234bd">XRgb2YCrCb_GetCrOffset</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#2bb93dbcbf42c736cdcf61e9c75c93ce">XRgb2YCrCb_SetCoefs</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, double ACoef, double BCoef, double CCoef, double DCoef)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#31708314941fd9212af057734436adb7">XRgb2YCrCb_GetCoefs</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, double *ACoef, double *BCoef, double *CCoef, double *DCoef)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#055a02edae1cc77605e360b675c56d80">XRgb2YCrCb_Select_Standard</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, enum <a class="el" href="xrgb2ycrcb_8h.html#0af3ea67f07c56f3bf624202c229595b">XRgb_Standards</a> StandardSel, enum <a class="el" href="xrgb2ycrcb_8h.html#9fced2690ef18942e406ab9145f75de1">XRgb_OutputRanges</a> InputRange, u32 DataWidth, struct <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> *CoefIn)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#548d29660d89f7e169bfec07d38a690e">XRgb2YCrCb_Coefficient_Translation</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, struct <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> *CoefIn, struct <a class="el" href="struct_x_rgb2_y_cr_cb___coef___outputs.html">XRgb2YCrCb_Coef_Outputs</a> *CoefOut, u32 DataWidth)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrgb2ycrcb_8c.html#d6a59676f9a37cb776215e22449f89ea">XRgb2YCrCb_Select_OutputRange</a> (<a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *InstancePtr, enum <a class="el" href="xrgb2ycrcb_8h.html#9fced2690ef18942e406ab9145f75de1">XRgb_OutputRanges</a> Range)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="584a818bca95b80de513294519c54ee2"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_CfgInitialize" ref="584a818bca95b80de513294519c54ee2" args="(XRgb2YCrCb *InstancePtr, XRgb2YCrCb_Config *CfgPtr, u32 EffectiveAddr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XRgb2YCrCb_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb___config.html">XRgb2YCrCb_Config</a> *&nbsp;</td>
<td class="paramname"> <em>CfgPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>EffectiveAddr</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function initializes the Rgb2YCrCb core. This function must be called prior to using the Rgb2YCrCb core. Initialization of the Rgb2YCrCb 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CfgPtr</em>&nbsp;</td><td>is a reference to a structure containing information about a specific <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> driver. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddr</em>&nbsp;</td><td>is the core base address in the virtual memory address space. The caller is responsible for keeping the address mapping from EffectiveAddr to the core physical base address unchanged once this function is invoked. Unexpected errors may occur if the address mapping changes after this function is called. If address translation is not used, pass in the physical address instead.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>- XST_SUCCESS if initialization was successful.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="548d29660d89f7e169bfec07d38a690e"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_Coefficient_Translation" ref="548d29660d89f7e169bfec07d38a690e" args="(XRgb2YCrCb *InstancePtr, struct XRgb2YCrCb_Coef_Inputs *CoefIn, struct XRgb2YCrCb_Coef_Outputs *CoefOut, u32 DataWidth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_Coefficient_Translation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> *&nbsp;</td>
<td class="paramname"> <em>CoefIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="struct_x_rgb2_y_cr_cb___coef___outputs.html">XRgb2YCrCb_Coef_Outputs</a> *&nbsp;</td>
<td class="paramname"> <em>CoefOut</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>DataWidth</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function translates the <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> structure into the <a class="el" href="struct_x_rgb2_y_cr_cb___coef___outputs.html">XRgb2YCrCb_Coef_Outputs</a> structure that can be used to program the core's registers. The <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> structure uses the same values as the core's GUIs. The <a class="el" href="struct_x_rgb2_y_cr_cb___coef___outputs.html">XRgb2YCrCb_Coef_Outputs</a> structure uses the values that can be programmed into the core's registers.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CoefIn</em>&nbsp;</td><td>specifies a pointer to a <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> structure to be translated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CoefOut</em>&nbsp;</td><td>specifies a pointer to a <a class="el" href="struct_x_rgb2_y_cr_cb___coef___outputs.html">XRgb2YCrCb_Coef_Outputs</a> structure with translated values. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DataWidth</em>&nbsp;</td><td>specifies a valid range of [8,10,12,16] that needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>RetVal, returns the 32-bit value with following bit information:<ul>
<li>bit(0)= ACoef + BCoef &gt; 1.0.</li><li>bit(1)= Y Offset outside data width range as [-2^Data_Width, (2^Data_Width)-1].</li><li>bit(2)= Cb Offset outside data width range as [-2^Data_Width, (2^Data_Width)-1].</li><li>bit(3)= Cr Offset outside data width range as [-2^Data_Width, (2^Data_Width)-1].</li><li>bit(4)= Y Max outside data width range as [0, (2^Data_Width)-1].</li><li>bit(5)= Y Min outside data width range as [0, (2^Data_Width)-1].</li><li>bit(6)= Cb Max outside data width range as [0, (2^Data_Width)-1].</li><li>bit(7)= Cb Min outside data width range as [0, (2^Data_Width)-1].</li><li>bit(8)= Cr Max outside data width range as [0, (2^Data_Width)-1].</li><li>bit(9)= Cr Min outside data width range as [0, (2^Data_Width)-1].</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="bdcafa368136089da5d5206220f3c52c"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_DisableDbgBypass" ref="bdcafa368136089da5d5206220f3c52c" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_DisableDbgBypass </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function disables Bypass mode.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> core instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="96e9ad14631f0d111e13370d6de8687d"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_DisableDbgTestPattern" ref="96e9ad14631f0d111e13370d6de8687d" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_DisableDbgTestPattern </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function disables debug test pattern mode.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> core instance to be worked on.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c742cc05360bb180cc57cc8fd6a7605f"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_EnableDbgByPass" ref="c742cc05360bb180cc57cc8fd6a7605f" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_EnableDbgByPass </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the bypass bit of control register to switch the core to bypass mode if debug is enabled in the IP.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5ec42003828e3e835f09ef7be76e4876"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_EnableDbgTestPattern" ref="5ec42003828e3e835f09ef7be76e4876" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_EnableDbgTestPattern </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function switches the core to test-pattern generator mode if debug feature is enabled.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="7d3723e8bae174fd28b4cc3f6e022cac"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetActiveSize" ref="7d3723e8bae174fd28b4cc3f6e022cac" args="(XRgb2YCrCb *InstancePtr, u16 *HSize, u16 *VSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_GetActiveSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16 *&nbsp;</td>
<td class="paramname"> <em>HSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16 *&nbsp;</td>
<td class="paramname"> <em>VSize</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function gets the active H/V sizes of the Rgb2YCrCb core from active size register.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>HSize</em>&nbsp;</td><td>is a pointer to 16-bit variable in which the number of Active Pixels per scanline is returned within the range [32, 7680]. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>VSize</em>&nbsp;</td><td>is a pointer to 16-bit variable in which the number of Active Lines per frame is returned within the range [32, 7680].</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="16a2ff2bbf296128593c05bf6208c35b"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetCbMax" ref="16a2ff2bbf296128593c05bf6208c35b" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetCbMax </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the maximum value on the Cb Chroma channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>CbMax, maximum value within range [0, 255] of the Cb Chroma Channel.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2fc6ca7fef260e69514ff025e25e5fc3"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetCbMin" ref="2fc6ca7fef260e69514ff025e25e5fc3" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetCbMin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the minimum value on the Cb Chroma channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>CbMin, minimum value within range [0, 255] on the Cb Chroma Channel.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a1d2a2bf12afc210fa1ac924a7ba7fff"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetCbOffset" ref="a1d2a2bf12afc210fa1ac924a7ba7fff" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetCbOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the offset compensation value for the Cb Chroma channel.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>CbOffset is the compensation value within range [0, 255] for the Cb Chroma channel.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="31708314941fd9212af057734436adb7"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetCoefs" ref="31708314941fd9212af057734436adb7" args="(XRgb2YCrCb *InstancePtr, double *ACoef, double *BCoef, double *CCoef, double *DCoef)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_GetCoefs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double *&nbsp;</td>
<td class="paramname"> <em>ACoef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double *&nbsp;</td>
<td class="paramname"> <em>BCoef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double *&nbsp;</td>
<td class="paramname"> <em>CCoef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double *&nbsp;</td>
<td class="paramname"> <em>DCoef</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns A, B, C and D coefficients.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ACoef</em>&nbsp;</td><td>is a pointer to double variable in which A coefficient is returned within the range [0.0 to 1.0]. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>BCoef</em>&nbsp;</td><td>is a pointer to double variable in which B coefficient is returned within the range [0.0 to 1.0]. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CCoef</em>&nbsp;</td><td>is a pointer to double variable in which C coefficient is returned within the range [0.0 to 1.0]. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DCoef</em>&nbsp;</td><td>is a pointer to double variable in which D coefficient is returned within the range [0.0 to 1.0].</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6e2b3f03de46204316376fb6b70efe15"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetCrMax" ref="6e2b3f03de46204316376fb6b70efe15" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetCrMax </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the maximum value on the Cr Chroma channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>CrMax, maximum value within range [0, 255] on the Cr Chroma Channel.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ee524e16f2ee827ad923f3c5919871e7"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetCrMin" ref="ee524e16f2ee827ad923f3c5919871e7" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetCrMin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the minimum value on the Cr Chroma channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>CrMin, minimum value within range [0, 255] on the Cr Chroma Channel.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="83eca3ac96dba90cf821ac8bac3234bd"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetCrOffset" ref="83eca3ac96dba90cf821ac8bac3234bd" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetCrOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the offset compensation value of the Cr Chroma channel.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>CrOffset is the compensation value within range [0, 255] of the Cr Chroma channel.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="05165c0c1bf1f8cd5e9db2651dc0390c"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetDbgFrameCount" ref="05165c0c1bf1f8cd5e9db2651dc0390c" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetDbgFrameCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the frame count, the number of frames processed since power-up. This is available only if the debugging feature is enabled.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>DbgFrameCount, number of frames processed since power-up.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>The SYSDEBUG0, or Frame Throughput Monitor register indicates the number of frames processed since power-up or the last time the core was reset. The SYSDEBUG registers can be useful to identify external memory / frame buffer/ throughput bottlenecks in a video system. Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6ea399e3c37faccfc3664e632f08e853"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetDbgLineCount" ref="6ea399e3c37faccfc3664e632f08e853" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetDbgLineCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns Line count, the number of lines processed since power-up. This is available only if the debugging feature is enabled.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>DbgLineCount, number of lines processed since power-up.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>The SYSDEBUG1 or Line Throughput Monitor register indicates the number of lines processed since power-up or the last time the core was reset. The SYSDEBUG registers can be useful to identify external memory / Frame buffer / throughput bottlenecks in a video system. Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="fa055f6e4fccf13e41fde0d51f196177"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetDbgPixelCount" ref="fa055f6e4fccf13e41fde0d51f196177" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetDbgPixelCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the pixel count, the number of pixels processed since power up. This is available only if the debugging feature is enabled.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>DbgPixelCount, number of pixels processed since power-up.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>The SYSDEBUG2, or Pixel Throughput Monitor register indicates the number of pixel processed since power-up or the last time the core was reset. The SYSDEBUG registers can be useful to identify external memory / Frame buffer / throughput bottlenecks in a video system. Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4d33f70be0091a541f59ccc2fae8b321"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetVersion" ref="4d33f70be0091a541f59ccc2fae8b321" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetVersion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function facilitates software identification of exact version of the RGB2YCrCb hardware (h/w).<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Version, contents of a Version register.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2b42bd16e5b9525bff94f9eabe19df1e"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetYMax" ref="2b42bd16e5b9525bff94f9eabe19df1e" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetYMax </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the maximum value of the Luma (Y) channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>YMax, Maximum value within range [0, 255] of the Luma channel.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c15c6a85e4604f4c7716ebe69093917a"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetYMin" ref="c15c6a85e4604f4c7716ebe69093917a" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetYMin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the minimum value of the Luma (Y) channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>YMin, minimum value within range [0, 255] of the Luma channel.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c17bd369ba0e788e5dcbca27fb2c7940"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_GetYOffset" ref="c17bd369ba0e788e5dcbca27fb2c7940" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XRgb2YCrCb_GetYOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the offset compensation value for the Luma (Y) channel.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>YOffset is compensation value within range [0, 255] for the Luma (Y) channel.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3d35a1adbadf61ad019954a5f4587b75"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_IsDbgByPassEnabled" ref="3d35a1adbadf61ad019954a5f4587b75" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XRgb2YCrCb_IsDbgByPassEnabled </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the current bypass mode of a core.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>TRUE if ByPass mode is enabled.</li><li>FALSE if ByPpass mode is not enabled.</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="f6f98177fb8bded5d21fc68257a49064"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_IsDbgTestPatternEnabled" ref="f6f98177fb8bded5d21fc68257a49064" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XRgb2YCrCb_IsDbgTestPatternEnabled </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function returns the test-pattern generator mode (enabled or not), if debug feature is enabled.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>TRUE if Test-pattern mode is enabled.</li><li>FALSE if Test-pattern mode is not enabled.</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Debug functionality should be enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d6a59676f9a37cb776215e22449f89ea"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_Select_OutputRange" ref="d6a59676f9a37cb776215e22449f89ea" args="(XRgb2YCrCb *InstancePtr, enum XRgb_OutputRanges Range)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_Select_OutputRange </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="xrgb2ycrcb_8h.html#9fced2690ef18942e406ab9145f75de1">XRgb_OutputRanges</a>&nbsp;</td>
<td class="paramname"> <em>Range</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function governs the range of outputs Y, Cr and Cb by affecting the conversion coefficients as well as the clipping and clamping values.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Range</em>&nbsp;</td><td>needs to be set from the enum XRgb_OutputRanges values as: 0 = XRGB_TV_16_TO_240, 1 = XRGB_STUDIO_16_TO_235, 2 = XRGB_GRAPHICS_0_TO_255.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="055a02edae1cc77605e360b675c56d80"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_Select_Standard" ref="055a02edae1cc77605e360b675c56d80" args="(XRgb2YCrCb *InstancePtr, enum XRgb_Standards StandardSel, enum XRgb_OutputRanges InputRange, u32 DataWidth, struct XRgb2YCrCb_Coef_Inputs *CoefIn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_Select_Standard </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="xrgb2ycrcb_8h.html#0af3ea67f07c56f3bf624202c229595b">XRgb_Standards</a>&nbsp;</td>
<td class="paramname"> <em>StandardSel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="xrgb2ycrcb_8h.html#9fced2690ef18942e406ab9145f75de1">XRgb_OutputRanges</a>&nbsp;</td>
<td class="paramname"> <em>InputRange</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>DataWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> *&nbsp;</td>
<td class="paramname"> <em>CoefIn</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function populates an <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> structure with the values from the selected video standard.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>StandardSel</em>&nbsp;</td><td>needs to be set from enum XRgb_Standards value as : 0 = XRGB_STANDARD_ITU_601_SD 1 = XRGB_STANDARD_ITU_709_NTSC 2 = XRGB_STANDARD_ITU_709_PAL 3 = XRGB_STANDARD_YUV. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>InputRange</em>&nbsp;</td><td>needs to be set from enum XRgb_OutputRanges value as: 0 = XRGB_TV_16_TO_240, 1 = XRGB_STUDIO_16_TO_235, 2 = XRGB_GRAPHICS_0_TO_255. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DataWidth</em>&nbsp;</td><td>specifies the valid range of [8,10,12,16] that needs to be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CoefIn</em>&nbsp;</td><td>specifies a pointer to a <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html">XRgb2YCrCb_Coef_Inputs</a> structure which is populated with the values from selected video standard.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="068788cac52a17d49848da6443235ea1"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_SetActiveSize" ref="068788cac52a17d49848da6443235ea1" args="(XRgb2YCrCb *InstancePtr, u16 HSize, u16 VSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_SetActiveSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>HSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>VSize</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets active H/V sizes in the active size register.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>HSize</em>&nbsp;</td><td>specifies the number of Active Pixels per scanline that needs to be set within the range [32, 7680]. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>VSize</em>&nbsp;</td><td>specifies the number of Active Lines per frame that needs to be set within the range [32, 7680].</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a8918c65e3bd52acd1d0923a16a255eb"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_SetCbMax" ref="a8918c65e3bd52acd1d0923a16a255eb" args="(XRgb2YCrCb *InstancePtr, u32 CbMax)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_SetCbMax </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>CbMax</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the maximum value allowed on the Cb Chroma channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CbMax</em>&nbsp;</td><td>specifies the maximum value within range [0, 255] of Cb Chroma channel that needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="af72e639f6ec9a424f316360852fbe61"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_SetCbMin" ref="af72e639f6ec9a424f316360852fbe61" args="(XRgb2YCrCb *InstancePtr, u32 CbMin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_SetCbMin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>CbMin</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the minimum value allowed on the Cb Chroma channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CbMin</em>&nbsp;</td><td>specifies the maximum value within range [0, 255] of Cb Chroma channel needs to set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="216aa5281d270baf69de79daf425a465"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_SetCbOffset" ref="216aa5281d270baf69de79daf425a465" args="(XRgb2YCrCb *InstancePtr, u32 CbOffset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_SetCbOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>CbOffset</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the offset compensation value for the Cb Chroma channel.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CbOffset</em>&nbsp;</td><td>specifies the compensation value within range [0, 255] of Cb Chroma channel that needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2bb93dbcbf42c736cdcf61e9c75c93ce"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_SetCoefs" ref="2bb93dbcbf42c736cdcf61e9c75c93ce" args="(XRgb2YCrCb *InstancePtr, double ACoef, double BCoef, double CCoef, double DCoef)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_SetCoefs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>ACoef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>BCoef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>CCoef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>DCoef</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets A, B, C and D coefficients.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ACoef</em>&nbsp;</td><td>specifies the A coefficient value within the range [0.0 to 1.0] that needs to be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>BCoef</em>&nbsp;</td><td>specifies the B coefficient value within the range [0.0 to 1.0] that needs to be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CCoef</em>&nbsp;</td><td>specifies the C coefficient value within the range [0.0 to 1.0] that needs to be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DCoef</em>&nbsp;</td><td>specifies the D coefficient value within the range [0.0 to 1.0] that needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="09cb057bdb4c96b8a3d1ed2411fba8ff"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_SetCrMax" ref="09cb057bdb4c96b8a3d1ed2411fba8ff" args="(XRgb2YCrCb *InstancePtr, u32 CrMax)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_SetCrMax </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>CrMax</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the maximum value allowed on the Cr Chroma channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CrMax</em>&nbsp;</td><td>specifies the maximum value within range [0, 255] of Cr Chroma channel that needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="7097a7fffb31f244f3d8b8980a41d7ed"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_SetCrMin" ref="7097a7fffb31f244f3d8b8980a41d7ed" args="(XRgb2YCrCb *InstancePtr, u32 CrMin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_SetCrMin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>CrMin</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the minimum value allowed on the Cr Chroma channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CrMin</em>&nbsp;</td><td>specifies the minimum value within range [0, 255] of Cr Chroma channel that needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3a4c66f6336a4ee35d36d0f95941f3af"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_SetCrOffset" ref="3a4c66f6336a4ee35d36d0f95941f3af" args="(XRgb2YCrCb *InstancePtr, u32 CrOffset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_SetCrOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>CrOffset</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the offset compensation value for the Cr Chroma channel.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CrOffset</em>&nbsp;</td><td>specifies the compensation value within range [0, 255] of Cr Chroma channel that needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c99d692e475eb69dc95a666e58d06c7b"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_Setup" ref="c99d692e475eb69dc95a666e58d06c7b" args="(XRgb2YCrCb *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_Setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets up double buffered ACTIVE_SIZE register and enables the register update.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="fd685f798f6c43ce121eec09d3f5fe7f"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_SetYMax" ref="fd685f798f6c43ce121eec09d3f5fe7f" args="(XRgb2YCrCb *InstancePtr, u32 YMax)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_SetYMax </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>YMax</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the maximum value allowed on the Luma (Y) channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>YMax</em>&nbsp;</td><td>specifies the maximum value within range [0, 255] of Luma channel that needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8cfcf42b1428ad80a23abd74c8d4ca6b"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_SetYMin" ref="8cfcf42b1428ad80a23abd74c8d4ca6b" args="(XRgb2YCrCb *InstancePtr, u32 YMin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_SetYMin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>YMin</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the minimum value allowed on the Luma (Y) channel of the 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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>YMin</em>&nbsp;</td><td>specifies the minimum value within range [0, 255] of Luma channel that needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b4c03e136fcf6039a16ac5e6a2422921"></a><!-- doxytag: member="xrgb2ycrcb.c::XRgb2YCrCb_SetYOffset" ref="b4c03e136fcf6039a16ac5e6a2422921" args="(XRgb2YCrCb *InstancePtr, u32 YOffset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XRgb2YCrCb_SetYOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>YOffset</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sets the offset compensation value for the Luma (Y) channel.<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>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>YOffset</em>&nbsp;</td><td>specifies the compensation value within range [0, 255] of Luma channel that needs to be set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div><p>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.