/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: edam
  • Date: 2011-11-04 15:07:26 UTC
  • Revision ID: edam@waxworlds.org-20111104150726-0evv5cetrckzg9do
cleaned-up info

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
 
         * Get the width, in pexels, of a message.
38
 
         *
39
 
         * @param message_len the length of the message
40
 
         */
41
 
        int get_width( int message_len );
42
 
 
43
 
        /**
44
 
         * Draw a column of pixels at pixel-offset x in the message.
45
 
         *
46
 
         * @param message the message
47
 
         * @param message_len the length of the message (to save it being
48
 
         *              calculated)
49
 
         * @param x the pixel column of the message to draw
50
 
         * @param y_flip true to draw up-side down
51
 
         * @param y_shift shift the drawing up/down
52
 
         */
53
 
        void render( const char *message, int message_len, int x,
54
 
                                 bool y_flip, int y_shift );
55
 
 
56
 
        /**
57
 
         * Reset the output buffer.
58
 
         */
59
 
        void reset_buffer();
60
 
 
61
 
 
62
 
        /**
63
 
         * Notify renderer that the output buffer will require rendering.
64
 
         */
65
 
        void buffer_in_use();
66
 
 
67
 
 
68
 
        /**
69
 
         * Output the output buffer (and reset the output buffer).
70
 
         */
71
 
        void output_buffer();
72
 
 
73
 
        /**
74
 
         * Get the font number in use.
75
 
         *
76
 
         * @return font number
77
 
         */
78
 
        int get_font();
79
 
 
80
 
        /**
81
 
         * Switch to the next font.
82
 
         */
83
 
        void inc_font();
84
 
 
85
 
};
86
 
 
87
 
 
88
 
#endif //_TEXT_RENDERER_H_