osd
Xilinx SDK Drivers API Documentation
XOsd Struct Reference

The XOsd instance data. More...

Data Fields

XOsd_Config Config
 Hardware configuration. More...
 
u32 IsReady
 Core instance is initialized. More...
 
u32 InstructionInExternalMem
 Flag indicating if the instruction list is from external memory. More...
 
u32 ScreenHeight
 Screen Height of the OSD output. More...
 
u32 ScreenWidth
 Screen Width of the OSD output. More...
 
XOsd_Layer Layers [(XOSD_MAX_NUM_OF_LAYERS)]
 Properties of layers. More...
 
XOsd_CallBack ProcStartCallBack
 Call back for Processing Start interrupt. More...
 
void * ProcStartRef
 To be passed to the Process Start interrupt callback. More...
 
XOsd_CallBack FrameDoneCallBack
 Call back for Frame Done interrupt. More...
 
void * FrameDoneRef
 To be passed to the Frame Done interrupt callback. More...
 
XOsd_ErrorCallBack ErrCallBack
 Call back for Error interrupt. More...
 
void * ErrRef
 To be passed to the Error interrupt callback. More...
 

Detailed Description

The XOsd instance data.

An instance must be allocated for each OSD core in use.

Field Documentation

◆ Config

◆ ErrCallBack

XOsd_ErrorCallBack XOsd::ErrCallBack

Call back for Error interrupt.

Referenced by XOsd_IntrHandler(), and XOsd_SetCallBack().

◆ ErrRef

void* XOsd::ErrRef

To be passed to the Error interrupt callback.

Referenced by XOsd_IntrHandler(), and XOsd_SetCallBack().

◆ FrameDoneCallBack

XOsd_CallBack XOsd::FrameDoneCallBack

Call back for Frame Done interrupt.

Referenced by XOsd_IntrHandler(), and XOsd_SetCallBack().

◆ FrameDoneRef

void* XOsd::FrameDoneRef

To be passed to the Frame Done interrupt callback.

Referenced by XOsd_IntrHandler(), and XOsd_SetCallBack().

◆ InstructionInExternalMem

u32 XOsd::InstructionInExternalMem

Flag indicating if the instruction list is from external memory.

Referenced by XOsd_CfgInitialize().

◆ IsReady

◆ Layers

◆ ProcStartCallBack

XOsd_CallBack XOsd::ProcStartCallBack

Call back for Processing Start interrupt.

Referenced by XOsd_CfgInitialize(), XOsd_IntrHandler(), and XOsd_SetCallBack().

◆ ProcStartRef

void* XOsd::ProcStartRef

To be passed to the Process Start interrupt callback.

Referenced by XOsd_IntrHandler(), and XOsd_SetCallBack().

◆ ScreenHeight

u32 XOsd::ScreenHeight

Screen Height of the OSD output.

Referenced by XOsd_SetActiveSize(), and XOsd_SetLayerDimension().

◆ ScreenWidth

u32 XOsd::ScreenWidth

Screen Width of the OSD output.

Referenced by XOsd_SetActiveSize(), and XOsd_SetLayerDimension().