agl_string.h

TI公司的算法标准 Framework5的源代码

/*! \verbatim
==============================================================================
                     Copyright (C) 2002 A.T.E.M.E.
                          All Rights Reserved
------------------------------------------------------------------------------
 MODULE NAME... AGL_STRING
 FILENAME...... agl_string.h
 PROJECT....... AGL
------------------------------------------------------------------------------
 HISTORY:
 V1.0    19/02/2002  TSO
------------------------------------------------------------------------------
\endverbatim <P> \file

\brief Header for string functions.

</P>*//*====================================================================*/

#ifndef __AGL_STRING_H__
#define __AGL_STRING_H__

#ifdef __cplusplus
extern "C" {
#endif

/*=======================================================================*//*!
\defgroup STRING STRING - Video string inlay module

	This module provides function which allow string insertion in graphical frames.
	
</P>*//*==============================================================*//*@{*/

/*--------------------------------------------------------------------------*/
/*! Put a string in a graphical YUY2 frame (YUV422)
 
	\param pFrame
				A pointer to a YUY2 frame

	\param width
				Frame width

	\param pString
				A pointer to the string to be put on the frame
				
	\param x
				x position (in pixels) where the string is put
				
	\param y
				y position (in pixels) where the string is put

	\param pFont
				A pointer to the font to be used

	\param fgColor
				Foreground color to be used for the string. The value
				passed represents the color Y, U and V component packed
				into a 32 bits word. Y is in the 8 lower bits. The 
				following 8 bits (8 to 15) are for U and bits 16 to
				23 are for V. The remaining bits are unused.

	\param bgColor
				Background color to be used for the string. The bits
				representation is the same as for fgColor.
				The special color FONT_COL_TRANSP can be used for a
				transparent background.

	\return	Nothing

	\b Example: 
	\verbatim
	
	STRING_putStringYUY2(myFrame, 352, "Hello World", 16, 32, &font_lucida, 0x8080FF, 0x808000);
	
	\endverbatim
*/
void STRING_putStringYUY2(void *pFrame, Uint32 width, 
								char *pString, Uint32 x, Uint32 y,
								FONT_Font *pFont, Uint32 fgColor, Uint32 bgColor);

/*@}*//* end of group STRING */

#ifdef __cplusplus
}
#endif

#endif