wiki/MHEG5_17_9_0_api/stb__osd_8h_source.html

 /*******************************************************************************

  * Copyright � 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)

  * Copyright � 2008 Ocean Blue Software Ltd

  *

  * This file is part of a DTVKit Software Component

  * You are permitted to copy, modify or distribute this file subject to the terms

  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org

  *

  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,

  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES

  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.

  *

  * If you or your organisation is not a member of DTVKit then you have access

  * to this source code outside of the terms of the licence agreement

  * and you are expected to delete this and any associated files immediately.

  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org

  *******************************************************************************/

 #ifndef _STB_OSD_H

 #define _STB_OSD_H


 #include "techtype.h"

 #include "osdtype.h"


 /*---Constant and macro definitions for public use-----------------------------*/


 /*---Enumerations for public use-----------------------------------------------*/


 /*---Global type defs for public use-------------------------------------------*/


 /*---Global Function prototypes for public use---------------------------------*/


 void STB_OSDMhegSetPalette(U16BIT index, U16BIT number, const U32BIT *argb);


 void* STB_OSDMhegSetResolution(U16BIT width, U16BIT height, U8BIT bits);


 void* STB_OSDMhegCreateSurface( U16BIT width, U16BIT height,

    BOOLEAN init, U32BIT colour );


 void* STB_OSDMhegLockBuffer( void *surface, U32BIT *pPitch );


 void STB_OSDMhegUnlockBuffer( void *surface );


 void STB_OSDMhegDestroySurface( void *surface );


 void STB_OSDMhegBlitBitmap( void *surface, S_RECTANGLE *pRect, U32BIT pitch,

    U16BIT screen_x, U16BIT screen_y, E_BLIT_OP bflg );


 void STB_OSDMhegFillRectangle( S_RECTANGLE *pRect, U32BIT colour, E_BLIT_OP bflg );


 void STB_OSDMhegBlitStretch( S_RECTANGLE *pSrcRect, void *src_surf,

    S_RECTANGLE *pDstRect, void *dst_surf, E_BLIT_OP bflg );


 void STB_OSDMhegFillSurface( void *surface, S_RECTANGLE *pRect, U32BIT colour,

    E_BLIT_OP bflg );


 void STB_OSDMhegUpdate(void);


 void STB_OSDMhegClear(void);


 #endif /* _STB_OSD_H */

osdtype.h
definition of OSD types

S_RECTANGLE
Definition: osdtype.h:54

STB_OSDMhegClear
void STB_OSDMhegClear(void)
Clear MHEG's entire OSD.

STB_OSDMhegFillRectangle
void STB_OSDMhegFillRectangle(S_RECTANGLE *pRect, U32BIT colour, E_BLIT_OP bflg)
Draw a filled rectangle on OSD back buffer in the location given. Where pixel colour is less than fou...

STB_OSDMhegCreateSurface
void * STB_OSDMhegCreateSurface(U16BIT width, U16BIT height, BOOLEAN init, U32BIT colour)
Creates a hardware surface on which MHEG5 engine will draw an individual MHEG object. At its basic the function can just allocate the buffer to be returned by STB_OSDMhegLockBuffer(). It's size being: (width * height * bytes_per_pixel) Also, when 'init' is TRUE, function initialises surface buffer to the specified colour. For pixel colour format of less than four bytes, use least significant bits of 'colour'.

STB_OSDMhegSetResolution
void * STB_OSDMhegSetResolution(U16BIT width, U16BIT height, U8BIT bits)
Sets the size of the OSD to be used by MHEG engine. The return must be a surface handle for the entir...

STB_OSDMhegDestroySurface
void STB_OSDMhegDestroySurface(void *surface)
This function destroys surface and all data allocated by STB_OSDMhegCreateSurface() ...

STB_OSDMhegUpdate
void STB_OSDMhegUpdate(void)
Commit OSD changes to the screen - changes given by previous calls to STB_OSDMhegDrawRectangle() and ...

techtype.h
System Wide Global Technical Data Type Definitions.

STB_OSDMhegSetPalette
void STB_OSDMhegSetPalette(U16BIT index, U16BIT number, const U32BIT *argb)
Sets Colour Palette array of up to 256 values, for single byte colour depth. This palette being an ar...

STB_OSDMhegFillSurface
void STB_OSDMhegFillSurface(void *surface, S_RECTANGLE *pRect, U32BIT colour, E_BLIT_OP bflg)
Draw a filled rectangle on surface in the location given. Where pixel colour is less than four bytes...

STB_OSDMhegLockBuffer
void * STB_OSDMhegLockBuffer(void *surface, U32BIT *pPitch)
Converts hardware surface handle returned by STB_OSDMhegCreateSurface() to buffer address that the en...

STB_OSDMhegBlitStretch
void STB_OSDMhegBlitStretch(S_RECTANGLE *pSrcRect, void *src_surf, S_RECTANGLE *pDstRect, void *dst_surf, E_BLIT_OP bflg)
Stretch blit bitmap data from source surface to destination surface using source and destination rect...

STB_OSDMhegBlitBitmap
void STB_OSDMhegBlitBitmap(void *surface, S_RECTANGLE *pRect, U32BIT pitch, U16BIT screen_x, U16BIT screen_y, E_BLIT_OP bflg)
Render bitmap on OSD back buffer in the given screen location, with given operation. The bitmap is referenced 'surface' - a handle returned by STB_OSDMhegCreateSurface()

STB_OSDMhegUnlockBuffer
void STB_OSDMhegUnlockBuffer(void *surface)
This function informs HW that MHEG5 is finished writing to the buffer.