/elec/propeller-clock

To get this branch, use:
bzr branch http://bzr.ed.am/elec/propeller-clock

« back to all changes in this revision

Viewing changes to src/text_renderer.h

  • Committer: Tim Marston
  • Date: 2012-05-17 22:49:36 UTC
  • Revision ID: tim@ed.am-20120517224936-0wgyem932dlq5bs4
various tweaks, a (failed) attempt to fix text reset bug and added TODO

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/text_renderer.h
 
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
 
 
30
#define MESSAGE_BUFFER_LEN 32
 
31
 
 
32
 
 
33
namespace TextRenderer
 
34
{
 
35
 
 
36
        /**
 
37
         * Initialise.
 
38
         */
 
39
        void init();
 
40
 
 
41
        /**
 
42
         * Get the width, in pexels, of a message.
 
43
         *
 
44
         * @param message_len the length of the message
 
45
         * @param scale taxt scaling factor
 
46
         */
 
47
        int get_width( int message_len, int scale );
 
48
 
 
49
        /**
 
50
         * Draw a column of pixels at pixel-offset x in the message.
 
51
         *
 
52
         * @param message the message
 
53
         * @param message_len the length of the message (to save it being
 
54
         *              calculated)
 
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
 
58
         * @param scale taxt scaling factor
 
59
         */
 
60
        void render( const char *message, int message_len, int x,
 
61
                                 bool y_flip, int y_shift, int scale );
 
62
 
 
63
        /**
 
64
         * Reset the output buffer.
 
65
         */
 
66
        void reset_buffer();
 
67
 
 
68
 
 
69
        /**
 
70
         * Notify renderer that the output buffer will require rendering.
 
71
         */
 
72
        void buffer_in_use();
 
73
 
 
74
 
 
75
        /**
 
76
         * Output the output buffer (and reset the output buffer).
 
77
         */
 
78
        void output_buffer();
 
79
 
 
80
        /**
 
81
         * Get the font number in use.
 
82
         *
 
83
         * @return font number
 
84
         */
 
85
        int get_font();
 
86
 
 
87
        /**
 
88
         * Switch to the next font.
 
89
         */
 
90
        void inc_font();
 
91
 
 
92
};
 
93
 
 
94
 
 
95
#endif //_TEXT_RENDERER_H_