annotate Framework/Toolbox/TextRenderer.h @ 1326:55166e57a77c broker

doc
author Benjamin Golinvaux <bgo@osimis.io>
date Tue, 24 Mar 2020 21:32:35 +0100
parents 2d8ab34c8c91
children 30deba7bc8e2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1085
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
1 /**
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
2 * Stone of Orthanc
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
1270
2d8ab34c8c91 upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1085
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
1085
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
6 *
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
10 * the License, or (at your option) any later version.
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
11 *
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
15 * Affero General Public License for more details.
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
16 *
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
19 **/
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
20
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
21
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
22 #pragma once
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
23
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
24 #include "Core/Images/Image.h"
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
25 #include <EmbeddedResources.h>
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
26
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
27 namespace OrthancStone
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
28 {
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
29 // Helpers methods to render text in bitmaps.
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
30 // Compared to the GlyphBitmapAlphabet::RenderText, these methods do not need a
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
31 // code page.
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
32 class TextRenderer : public boost::noncopyable
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
33 {
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
34 public:
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
35 // simply renders text in GrayScale8 with a black background and a white text
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
36 static Orthanc::ImageAccessor* Render(Orthanc::EmbeddedResources::FileResourceId resource,
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
37 unsigned int fontSize,
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
38 const std::string& utf8String);
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
39
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
40 // renders text in "color" with alpha in a RGBA32 image
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
41 static Orthanc::ImageAccessor* RenderWithAlpha(Orthanc::EmbeddedResources::FileResourceId resource,
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
42 unsigned int fontSize,
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
43 const std::string& utf8String,
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
44 uint8_t foreground);
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
45
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
46 // // renders text in color + a border with alpha in a RGBA32 image
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
47 // static Orthanc::ImageAccessor* RenderWithAlpha(Orthanc::EmbeddedResources::FileResourceId resource,
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
48 // unsigned int fontSize,
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
49 // const std::string& utf8String,
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
50 // uint8_t foreground,
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
51 // uint8_t borderColor);
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
52 };
63539e826355 Added TextRenderer
Alain Mazy <alain@mazy.be>
parents:
diff changeset
53 }