blob: 37321b562817a683c7412eb67509c4c61d90b590 [file] [log] [blame]
/* ----------------------------------------------------------------------------
* ATMEL Microcontroller Software Support
* ----------------------------------------------------------------------------
* Copyright (c) 2008, Atmel Corporation
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
*
* Atmel's name may not be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ----------------------------------------------------------------------------
*/
//------------------------------------------------------------------------------
/// \unit
///
/// !!!Purpose
///
/// The font.h files declares a font structure and a LCDD_DrawChar function
/// that must be implemented by a font definition file to be used with the
/// LCDD_DrawString method of draw.h.
///
/// The font10x14.c implements the necessary variable and function for a 10x14
/// font.
///
/// !!!Usage
///
/// -# Declare a gFont global variable with the necessary Font information.
/// -# Implement an LCDD_DrawChar function which displays the specified
/// character on the LCD.
/// -# Use the LCDD_DrawString method defined in draw.h to display a complete
/// string.
//------------------------------------------------------------------------------
#ifndef FONT_H
#define FONT_H
//------------------------------------------------------------------------------
// Global types
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
/// Describes the font (width, height, supported characters, etc.) used by
/// the LCD driver draw API.
//------------------------------------------------------------------------------
typedef struct _Font {
/// Font width in pixels.
unsigned char width;
/// Font height in pixels.
unsigned char height;
} Font;
//------------------------------------------------------------------------------
// Global variables
//------------------------------------------------------------------------------
/// Global variable describing the font being instancied.
extern const Font gFont;
//------------------------------------------------------------------------------
// Global functions
//------------------------------------------------------------------------------
extern void LCDD_DrawChar(
void *pBuffer,
unsigned int x,
unsigned int y,
char c,
unsigned int color);
#endif //#ifndef FONT_H