/elec/propeller-clock : contents of src/text

: (revision 93)

To get this branch, use:

bzr branch
http://bzr.ed.am/elec/propeller-clock

/*
 * text_renderer.h
 *
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
 *
 * This file is part of propeller-clock (hereafter referred to as "this
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
 * information.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef _TEXT_RENDERER_H_
#define _TEXT_RENDERER_H_


#include <PString.h>


#define MESSAGE_BUFFER_LEN 32


namespace TextRenderer
{

	/**
	 * Initialise.
	 */
	void init();

	/**
	 * Get the width, in pexels, of a message.
	 *
	 * @param message_len the length of the message
	 * @param scale taxt scaling factor
	 */
	int get_width( int message_len, int scale );

	/**
	 * Draw a column of pixels at pixel-offset x in the message.
	 *
	 * @param message the message
	 * @param message_len the length of the message (to save it being
	 * 		calculated)
	 * @param x the pixel column of the message to draw
	 * @param y_flip true to draw up-side down
	 * @param y_shift shift the drawing up/down
	 * @param scale taxt scaling factor
	 */
	void render( const char *message, int message_len, int x,
				 bool y_flip, int y_shift, int scale );

	/**
	 * Reset the output buffer.
	 */
	void reset_buffer();


	/**
	 * Notify renderer that the output buffer will require rendering.
	 */
	void buffer_in_use();


	/**
	 * Output the output buffer (and reset the output buffer).
	 */
	void output_buffer();

	/**
	 * Get the font number in use.
	 *
	 * @return font number
	 */
	int get_font();

	/**
	 * Switch to the next font.
	 */
	void inc_font();

};


#endif //_TEXT_RENDERER_H_

59 by edam removed ulibc, fixed button, added text rendering	1	/*
	2	* text_renderer.h
	3	*
	4	* Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
	5	*
	6	* This file is part of propeller-clock (hereafter referred to as "this
	7	* program"). See http://ed.am/dev/software/arduino/propeller-clock for more
	8	* information.
	9	*
	10	* This program is free software: you can redistribute it and/or modify
	11	* it under the terms of the GNU Lesser General Public License as published
	12	* by the Free Software Foundation, either version 3 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU Lesser General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU Lesser General Public License
	21	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	22	*/
	23	#ifndef _TEXT_RENDERER_H_
	24	#define _TEXT_RENDERER_H_
	25
	26
	27	#include <PString.h>
	28
	29
62 by edam moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages	30	#define MESSAGE_BUFFER_LEN 32
	31
	32
60 by edam remove TextRenderer singleton and save space	33	namespace TextRenderer
59 by edam removed ulibc, fixed button, added text rendering	34	{
62 by edam moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages	35
	36	/**
76 by edam switch button to no interim presses during settings mode; added NVRAM support	37	* Initialise.
	38	*/
	39	void init();
	40
	41	/**
62 by edam moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages	42	* Get the width, in pexels, of a message.
	43	*
	44	* @param message_len the length of the message
79 by Tim Marston added adjustable text scaling factor	45	* @param scale taxt scaling factor
62 by edam moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages	46	*/
79 by Tim Marston added adjustable text scaling factor	47	int get_width( int message_len, int scale );
62 by edam moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages	48
	49	/**
	50	* Draw a column of pixels at pixel-offset x in the message.
59 by edam removed ulibc, fixed button, added text rendering	51	*
	52	* @param message the message
64 by Tim Marston added support for eclipse project and converted to a manual Makefile	53	* @param message_len the length of the message (to save it being
	54	* calculated)
62 by edam moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages	55	* @param x the pixel column of the message to draw
	56	* @param y_flip true to draw up-side down
	57	* @param y_shift shift the drawing up/down
79 by Tim Marston added adjustable text scaling factor	58	* @param scale taxt scaling factor
62 by edam moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages	59	*/
	60	void render( const char *message, int message_len, int x,
79 by Tim Marston added adjustable text scaling factor	61	bool y_flip, int y_shift, int scale );
62 by edam moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages	62
	63	/**
	64	* Reset the output buffer.
	65	*/
	66	void reset_buffer();
	67
71 by Tim Marston added time set mode, made text renderer's buffer auto reset/output	68
	69	/**
	70	* Notify renderer that the output buffer will require rendering.
	71	*/
	72	void buffer_in_use();
	73
	74
62 by edam moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages	75	/**
	76	* Output the output buffer (and reset the output buffer).
	77	*/
	78	void output_buffer();
59 by edam removed ulibc, fixed button, added text rendering	79
63 by edam widenned clock hands, tweaked scales, got top & bottom text modes working	80	/**
71 by Tim Marston added time set mode, made text renderer's buffer auto reset/output	81	* Get the font number in use.
63 by edam widenned clock hands, tweaked scales, got top & bottom text modes working	82	*
71 by Tim Marston added time set mode, made text renderer's buffer auto reset/output	83	* @return font number
	84	*/
	85	int get_font();
	86
	87	/**
	88	* Switch to the next font.
	89	*/
	90	void inc_font();
63 by edam widenned clock hands, tweaked scales, got top & bottom text modes working	91
59 by edam removed ulibc, fixed button, added text rendering	92	};
	93
	94
	95	#endif //_TEXT_RENDERER_H_