Overte C++ Documentation
RenderLayer.h
1 //
2 // Created by Sam Gondelman on 1/3/19.
3 // Copyright 2019 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_RenderLayer_h
10 #define hifi_RenderLayer_h
11 
12 #include "QString"
13 
14 /*@jsdoc
15  * <p>A layer in which an entity may be rendered.</p>
16  * <table>
17  * <thead>
18  * <tr><th>Value</th><th>Description</th></tr>
19  * </thead>
20  * <tbody>
21  * <tr><td><code>"world"</code></td><td>The entity is drawn in the world with everything else.</td></tr>
22  * <tr><td><code>"front"</code></td><td>The entity is drawn on top of the world layer but behind the HUD surface.</td></tr>
23  * <tr><td><code>"hud"</code></td><td>The entity is drawn on top of other layers and the HUD surface.</td></tr>
24  * </tbody>
25  * </table>
26  * @typedef {string} Entities.RenderLayer
27  */
28 
29 enum class RenderLayer {
30  WORLD = 0,
31  FRONT,
32  HUD
33 };
34 
35 class RenderLayerHelpers {
36 public:
37  static QString getNameForRenderLayer(RenderLayer mode);
38 };
39 
40 #endif // hifi_RenderLayer_h
41