Overte C++ Documentation
TextEffect.h
1 //
2 // Created by Bradley Austin Davis on 2015/07/16
3 // Copyright 2013 High Fidelity, Inc.
4 //
5 // Distributed under the Apache License, Version 2.0.
6 // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
7 //
8 
9 #ifndef hifi_TextEffect_h
10 #define hifi_TextEffect_h
11 
12 #include "QString"
13 
14 /*@jsdoc
15  * <p>A {@link Entities.EntityProperties-Text|Text} entity may use one of the following effects:</p>
16  * <table>
17  * <thead>
18  * <tr><th>Value</th><th>Description</th></tr>
19  * </thead>
20  * <tbody>
21  * <tr><td><code>"none"</code></td><td>No effect.</td></tr>
22  * <tr><td><code>"outline"</code></td><td>An outline effect.</td></tr>
23  * <tr><td><code>"outline fill"</code></td><td>An outline effect, with fill.</td></tr>
24  * <tr><td><code>"shadow"</code></td><td>A shadow effect.</td></tr>
25  * </tbody>
26  * </table>
27  * @typedef {string} Entities.TextEffect
28  */
29 
30 enum class TextEffect {
31  NO_EFFECT = 0,
32  OUTLINE_EFFECT,
33  OUTLINE_WITH_FILL_EFFECT,
34  SHADOW_EFFECT
35 };
36 
37 class TextEffectHelpers {
38 public:
39  static QString getNameForTextEffect(TextEffect effect);
40 };
41 
42 #endif // hifi_TextEffect_h