![]() |
v_letterbox
Xilinx SDK Drivers API Documentation
|
Data Structures | |
| struct | XV_Lbox_l2 |
| Letterbox Layer 2 data. More... | |
Enumerations | |
| enum | XLboxColorId |
| This typedef contains the different background colors available. More... | |
Functions | |
| int | XV_LBoxInitialize (XV_Lbox_l2 *InstancePtr, u16 DeviceId) |
| This function initializes the core instance. More... | |
| void | XV_LBoxStart (XV_Lbox_l2 *InstancePtr) |
| This function starts the letter box core. More... | |
| void | XV_LBoxStop (XV_Lbox_l2 *InstancePtr) |
| This function stops the letter box core. More... | |
| void | XV_LBoxSetActiveWin (XV_Lbox_l2 *InstancePtr, XVidC_VideoWindow *ActiveWindow, u32 FrameWidth, u32 FrameHeight) |
| This function configures the letterbox active window. More... | |
| void | XV_LboxSetBackgroundColor (XV_Lbox_l2 *InstancePtr, XLboxColorId ColorId, XVidC_ColorFormat cfmt, XVidC_ColorDepth bpc) |
| This function configures the background color to be painted outside active window. More... | |
| void | XV_LBoxDbgReportStatus (XV_Lbox_l2 *InstancePtr) |
| This function prints LBox IP status on the console. More... | |
| enum XLboxColorId |
#include <xv_letterbox_l2.h>
This typedef contains the different background colors available.
| void XV_LBoxDbgReportStatus | ( | XV_Lbox_l2 * | InstancePtr | ) |
#include <xv_letterbox_l2.c>
This function prints LBox IP status on the console.
| InstancePtr | is the pointer to the core instance. |
References XV_letterbox_Config::BaseAddress, and XV_letterbox::Config.
| int XV_LBoxInitialize | ( | XV_Lbox_l2 * | InstancePtr, |
| u16 | DeviceId | ||
| ) |
#include <xv_letterbox_l2.c>
This function initializes the core instance.
| InstancePtr | is a pointer to core instance to be worked upon |
| DeviceId | is instance id of the core |
| void XV_LBoxSetActiveWin | ( | XV_Lbox_l2 * | InstancePtr, |
| XVidC_VideoWindow * | ActiveWindow, | ||
| u32 | FrameWidth, | ||
| u32 | FrameHeight | ||
| ) |
#include <xv_letterbox_l2.c>
This function configures the letterbox active window.
All pixels within the window are passed to the output as-is. Any pixel outside the defined window will be clamped to the programmed background color
| InstancePtr | is a pointer to the core instance to be worked on. |
| ActiveWindow | is structure that contains window coordinates and size |
| FrameWidth | is the input stream width |
| FrameHeight | is the input stream height |
| void XV_LboxSetBackgroundColor | ( | XV_Lbox_l2 * | InstancePtr, |
| XLboxColorId | ColorId, | ||
| XVidC_ColorFormat | cfmt, | ||
| XVidC_ColorDepth | bpc | ||
| ) |
#include <xv_letterbox_l2.c>
This function configures the background color to be painted outside active window.
| InstancePtr | is a pointer to the core instance to be worked on. |
| ColorId | is the background color requested |
| cfmt | is the color format of the input stream |
| bpc | is the color depth (bits per channel) |
| void XV_LBoxStart | ( | XV_Lbox_l2 * | InstancePtr | ) |
#include <xv_letterbox_l2.c>
This function starts the letter box core.
| InstancePtr | is a pointer to the core instance to be worked on. |
| void XV_LBoxStop | ( | XV_Lbox_l2 * | InstancePtr | ) |
#include <xv_letterbox_l2.c>
This function stops the letter box core.
| InstancePtr | is a pointer to the core instance to be worked on. |