Extract common code out into kdm_for_screen()
[dcpomatic.git] / src / lib / bitmap_text.h
1 /*
2     Copyright (C) 2014-2018 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     DCP-o-matic is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 #ifndef DCPOMATIC_BITMAP_CAPTION_H
22 #define DCPOMATIC_BITMAP_CAPTION_H
23
24 #include "rect.h"
25 #include <boost/shared_ptr.hpp>
26
27 class Image;
28
29 class BitmapText
30 {
31 public:
32         BitmapText (boost::shared_ptr<Image> i, dcpomatic::Rect<double> r)
33                 : image (i)
34                 , rectangle (r)
35         {}
36
37         boost::shared_ptr<Image> image;
38         /** Area that the subtitle covers on its corresponding video, expressed in
39          *  proportions of the image size; e.g. rectangle.x = 0.5 would mean that
40          *  the rectangle starts half-way across the video.
41          *
42          *  This rectangle may or may not have had a TextContent's offsets and
43          *  scale applied to it, depending on context.
44          */
45         dcpomatic::Rect<double> rectangle;
46 };
47
48 #endif