Add github workflow & gitignore

[irrlicht.git] / include / ISceneManager.h

diff --git a/include/ISceneManager.h b/include/ISceneManager.h
index 29b4b8786afe10bfd7650a1108375c2982ff4445..65e81c3dfa2c36fc0be72249fde2c9f47d8c0199 100644 (file)
--- a/include/ISceneManager.h
+++ b/include/ISceneManager.h
@@ -52,7 +52,9 @@ namespace scene
 {\r
        //! Enumeration for render passes.\r
        /** A parameter passed to the registerNodeForRendering() method of the ISceneManager,\r
-       specifying when the node wants to be drawn in relation to the other nodes. */\r
+       specifying when the node wants to be drawn in relation to the other nodes.\r
+       Note: Despite the numbering this is not used as bit-field.\r
+       */\r
        enum E_SCENE_NODE_RENDER_PASS\r
        {\r
                //! No pass currently active\r
@@ -92,7 +94,11 @@ namespace scene
                ESNRP_TRANSPARENT_EFFECT =32,\r
 \r
                //! Drawn after the solid nodes, before the transparent nodes, the time for drawing shadow volumes\r
-               ESNRP_SHADOW =64\r
+               ESNRP_SHADOW =64,\r
+\r
+               //! Drawn after transparent effect nodes. For custom gui's. Unsorted (in order nodes registered themselves). \r
+               ESNRP_GUI = 128\r
+\r
        };\r
 \r
        class IAnimatedMesh;\r
@@ -1122,6 +1128,8 @@ namespace scene
                \param pass: Specifies when the node wants to be drawn in relation to the other nodes.\r
                For example, if the node is a shadow, it usually wants to be drawn after all other nodes\r
                and will use ESNRP_SHADOW for this. See scene::E_SCENE_NODE_RENDER_PASS for details.\r
+               Note: This is _not_ a bitfield. If you want to register a note for several render passes, then \r
+               call this function once for each pass.\r
                \return scene will be rendered ( passed culling ) */\r
                virtual u32 registerNodeForRendering(ISceneNode* node,\r
                        E_SCENE_NODE_RENDER_PASS pass = ESNRP_AUTOMATIC) = 0;\r