ScummVM API documentation
variable_width_sprite_font.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  * of the License, or(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 AGS_PLUGINS_AGS_SPRITE_FONT_VAR_WIDTH_SPR_FONT_H
23 #define AGS_PLUGINS_AGS_SPRITE_FONT_VAR_WIDTH_SPR_FONT_H
24 
25 #include "ags/plugins/plugin_base.h"
26 #include "ags/plugins/ags_plugin.h"
27 #include "ags/plugins/ags_sprite_font/variable_width_font.h"
28 
29 namespace AGS3 {
30 namespace Plugins {
31 namespace AGSSpriteFont {
32 
34 protected:
35  IAGSEngine *_engine;
37 
38  VariableWidthFont *getFontFor(int fontNum);
39  void Draw(BITMAP *src, BITMAP *dest, int destx, int desty, int srcx, int srcy, int width, int height, int colour);
40 public:
43 
44  void SetGlyph(int fontNum, int charNum, int x, int y, int width, int height);
45  void SetSprite(int fontNum, int spriteNum);
46  void SetSpacing(int fontNum, int spacing);
47  // Clifftop Games custom plugin support
48  void SetLineHeightAdjust(int fontNum, int LineHeight, int SpacingHeight, int SpacingOverride);
49 
50  // IAGSFontRenderer implementation
51  bool LoadFromDisk(int fontNumber, int fontSize) override {
52  return true;
53  }
54 
55  void FreeMemory(int fontNumber) override;
56  bool SupportsExtendedCharacters(int fontNumber) override;
57  int GetTextWidth(const char *text, int fontNumber) override;
58  int GetTextHeight(const char *text, int fontNumber) override;
59  void RenderText(const char *text, int fontNumber, BITMAP *destination, int x, int y, int colour) override;
60  void AdjustYCoordinateForFont(int *ycoord, int fontNumber) override { }
61  void EnsureTextValidForFont(char *text, int fontNumber) override;
62 
63  // IAGSFontRenderer2 implementation
64  int GetVersion() override { return 26; /* compatible engine API ver */ }
65  const char *GetRendererName() override { return "VariableWidthSpriteFontRenderer"; }
66  const char *GetFontName(int fontNumber) override { return ""; /* not supported */ }
67  int GetFontHeight(int fontNumber) override;
68  int GetLineSpacing(int fontNumber) override;
69 };
70 
71 } // namespace AGSSpriteFont
72 } // namespace Plugins
73 } // namespace AGS3
74 
75 #endif
Definition: vector.h:39
Definition: surface.h:32
Definition: ags_font_renderer.h:47
Definition: ags_plugin.h:328
Definition: variable_width_font.h:33
Definition: variable_width_sprite_font.h:33
Definition: ags.h:40