*/
enum Type
{
- NONE, ///< None of the faces should be culled @SINCE_1_1.43
- FRONT, ///< Cull front face, back face should never be shown @SINCE_1_1.43
- BACK, ///< Cull back face, back face should never be shown @SINCE_1_1.43
+ NONE, ///< None of the faces should be culled @SINCE_1_1.43
+ FRONT, ///< Cull front face, front faces should never be shown @SINCE_1_1.43
+ BACK, ///< Cull back face, back faces should never be shown @SINCE_1_1.43
FRONT_AND_BACK, ///< Cull front and back faces; if the geometry is composed of triangles none of the faces will be shown @SINCE_1_1.43
};
} // namespace DepthFunction
+namespace RenderMode
+{
+
+/**
+ * @brief Controls how this renderer uses its stencil properties and writes to the color buffer.
+ * @SINCE_1_2_5
+ */
+enum Type
+{
+ NONE, ///< Don’t write to either color or stencil buffer (But will potentially render to depth buffer). @SINCE_1_2_5
+ AUTO, ///< Managed by the Actor Clipping API. This is the default. @SINCE_1_2_5
+ COLOR, ///< Ingore stencil properties. Write to the color buffer. @SINCE_1_2_5
+ STENCIL, ///< Use the stencil properties. Do not write to the color buffer. @SINCE_1_2_5
+ COLOR_STENCIL ///< Use the stencil properties AND Write to the color buffer. @SINCE_1_2_5
+};
+
+} // namespace RenderMode
+
namespace StencilFunction
{
} // namespace StencilFunction
-namespace StencilMode
-{
-
-/**
- * @brief How the stencil buffer will be managed.
- * @SINCE_1_1.43
- */
-enum Type
-{
- OFF, ///< Off for this renderer @SINCE_1_1.43
- AUTO, ///< Managed by the Actor clipping API. This is the default @SINCE_1_1.43
- ON ///< On for this renderer. Select this to use the Renderer stencil properties to manage behavior. Note that Actor clipping management is bypassed for this renderer @SINCE_1_1.43
-};
-
-} // namespace StencilMode
-
namespace StencilOperation
{
DEPTH_TEST_MODE,
/**
+ * @brief name "renderMode", type INTEGER
+ * @see RenderMode
+ * @note The default value is RenderMode::AUTO
+ * @SINCE_1_2_5
+ */
+ RENDER_MODE,
+
+ /**
* @brief name "stencilFunction", type INTEGER
* @see StencilFunction
* @note The default value is StencilFunction::ALWAYS
STENCIL_MASK,
/**
- * @brief name "stencilMode", type INTEGER
- * @see StencilMode
- * @note The default value is StencilMode::AUTO
- * @SINCE_1_1.43
- */
- STENCIL_MODE,
-
- /**
* @brief name "stencilOperationOnFail", type INTEGER
* @see StencilOperation
* @note The default value is StencilOperation::KEEP
* @SINCE_1_1.43
*/
STENCIL_OPERATION_ON_Z_PASS,
-
- /**
- * @brief name "writeToColorBuffer", type BOOLEAN
- * This allows per-renderer control of writing to the color buffer.
- * For example: This can be turned off to write to the stencil or depth buffers only.
- * @note The default value is True
- * @SINCE_1_1.43
- */
- WRITE_TO_COLOR_BUFFER
};
};
* @SINCE_1_1.43
* @param[in] geometry Geometry to be used by this renderer
* @param[in] shader Shader to be used by this renderer
+ * @return A handle to the Renderer
*/
static Renderer New( Geometry& geometry, Shader& shader );