ScummVM API documentation
speech_overlay.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef HOLLYWOOD_MONSTERS_SCENES_SPEECH_OVERLAY_H
23#define HOLLYWOOD_MONSTERS_SCENES_SPEECH_OVERLAY_H
24
25#include "common/array.h"
26#include "common/str.h"
27#include "common/types.h"
28
29namespace Graphics {
30struct Surface;
31}
32
33namespace Hollywood {
34
35class HollywoodFont;
36
37// Wrapped subtitle text and its resolved scene position.
39 SpeechOverlay() : visible(false), colorIndex(0), centerX(0), topY(0) {}
40
41 bool visible;
42 byte colorIndex;
43 uint16 centerX;
44 uint16 topY;
46};
47
48enum SpeechOverlayWrapStyle {
49 kSpeechOverlayAdaptiveWrap,
50 kSpeechOverlayFixedEdgeWrap
51};
52
53void wrapSpeechOverlayText(const Common::String &text, int anchorX,
55 SpeechOverlayWrapStyle style = kSpeechOverlayAdaptiveWrap);
56void layoutSpeechOverlay(SpeechOverlay &overlay, const HollywoodFont *font,
57 int centerX, int anchorBottomY, int viewportXOffset = 0);
58void drawSpeechOverlayText(const SpeechOverlay &overlay, HollywoodFont *font,
59 Graphics::Surface &surface, int viewportXOffset = 0, int viewportYOffset = 0);
60
61} // End of namespace Hollywood
62
63#endif // HOLLYWOOD_MONSTERS_SCENES_SPEECH_OVERLAY_H
Definition: str.h:59
Definition: formatinfo.h:28
Definition: surface.h:67
Definition: speech_overlay.h:38