1 #ifndef DALI_RENDERER_H
2 #define DALI_RENDERER_H
5 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/actors/blending.h> // Dali::BlendingMode, Dali::BlendingEquation, Dali::BlendingFactor
23 #include <dali/public-api/object/handle.h> // Dali::Handle
24 #include <dali/public-api/object/property-index-ranges.h> // DEFAULT_OBJECT_PROPERTY_START_INDEX
25 #include <dali/devel-api/rendering/geometry.h> // Dali::Geometry
26 #include <dali/devel-api/rendering/texture-set.h> // Dali::TextureSet
31 namespace Internal DALI_INTERNAL
37 * @brief Renderer is a handle to an object used to show content by combining a Geometry, a TextureSet and a shader
39 class DALI_IMPORT_API Renderer : public Handle
44 * @brief Set face culling mode.
48 NONE, ///< None of the faces should be culled
49 CULL_FRONT, ///< Cull front face, back face should never be shown
50 CULL_BACK, ///< Cull back face, back face should never be shown
51 CULL_BACK_AND_FRONT, ///< Cull back and front faces, if the geometry is composed of triangles none of the faces will be shown
55 * @brief An enumeration of properties belonging to the Renderer class.
61 DEPTH_INDEX = DEFAULT_OBJECT_PROPERTY_START_INDEX, ///< name "depthIndex", type INTEGER
62 FACE_CULLING_MODE, ///< name "faceCullingMode", type INTEGER
63 BLENDING_MODE, ///< name "blendingMode", type INTEGER
64 BLEND_EQUATION_RGB, ///< name "blendEquationRgb", type INTEGER
65 BLEND_EQUATION_ALPHA, ///< name "blendEquationAlpha", type INTEGER
66 BLENDING_SRC_FACTOR_RGB, ///< name "sourceBlendFactorRgb", type INTEGER
67 BLENDING_DEST_FACTOR_RGB, ///< name "destinationBlendFactorRgb", type INTEGER
68 BLENDING_SRC_FACTOR_ALPHA, ///< name "sourceBlendFactorAlpha", type INTEGER
69 BLENDING_DEST_FACTOR_ALPHA, ///< name "destinationBlendFactorAlpha", type INTEGER
70 BLENDING_COLOR, ///< name "blendingColor", type VECTOR4
71 BLEND_PRE_MULTIPLIED_ALPHA, ///< name "blendPreMultipledAlpha", type BOOLEAN
76 * @brief Creates a new Renderer object
78 * @param[in] geometry Geometry to be used by this renderer
79 * @param[in] shader Shader to be used by this renderer
81 static Renderer New( Geometry& geometry, Shader& shader );
84 * @brief Default constructor, creates an empty handle
94 * @brief Copy constructor, creates a new handle to the same object
96 * @param[in] handle Handle to an object
98 Renderer( const Renderer& handle );
101 * @brief Downcast to a renderer handle.
103 * If not a renderer the returned renderer handle is left uninitialized.
104 * @param[in] handle to an object
105 * @return renderer handle or an uninitialized handle
107 static Renderer DownCast( BaseHandle handle );
110 * @brief Assignment operator, changes this handle to point at the same object
112 * @param[in] handle Handle to an object
113 * @return Reference to the assigned object
115 Renderer& operator=( const Renderer& handle );
118 * @brief Sets the geometry to be used by this renderer
120 * @param[in] geometry The geometry to be used by this renderer
122 void SetGeometry( Geometry& geometry );
125 * @brief Gets the geometry used by this renderer
127 * @return The geometry used by the renderer
129 Geometry GetGeometry() const;
132 * @brief Sets the texture set to be used by this renderer
134 * @param[in] textureSet The texture set to be used by this renderer
136 void SetTextures( TextureSet& textureSet );
139 * @brief Gets the texture set used by this renderer
141 * @return The texture set used by the renderer
143 TextureSet GetTextures() const;
146 * @brief Set the shader used by this renderer
147 * @param[in] shader The shader to be used by this renderer
149 void SetShader( Shader& shader );
152 * @brief Get the shader used by this renderer
153 * @return THe shader used by the renderer
155 Shader GetShader() const;
158 * @brief Specify the pixel arithmetic used when the actor is blended.
160 * @param[in] srcFactorRgba Specifies how the red, green, blue, and alpha source blending factors are computed.
161 * The options are BlendingFactor::ZERO, ONE, SRC_COLOR, ONE_MINUS_SRC_COLOR, DST_COLOR, ONE_MINUS_DST_COLOR,
162 * SRC_ALPHA, ONE_MINUS_SRC_ALPHA, DST_ALPHA, ONE_MINUS_DST_ALPHA, CONSTANT_COLOR, ONE_MINUS_CONSTANT_COLOR,
163 * GL_CONSTANT_ALPHA, GL_ONE_MINUS_CONSTANT_ALPHA, and GL_SRC_ALPHA_SATURATE.
165 * @param[in] destFactorRgba Specifies how the red, green, blue, and alpha destination blending factors are computed.
166 * The options are BlendingFactor::ZERO, ONE, SRC_COLOR, ONE_MINUS_SRC_COLOR, DST_COLOR, ONE_MINUS_DST_COLOR,
167 * SRC_ALPHA, ONE_MINUS_SRC_ALPHA, DST_ALPHA, ONE_MINUS_DST_ALPHA, CONSTANT_COLOR, ONE_MINUS_CONSTANT_COLOR,
168 * GL_CONSTANT_ALPHA, and GL_ONE_MINUS_CONSTANT_ALPHA.
170 void SetBlendFunc( BlendingFactor::Type srcFactorRgba, BlendingFactor::Type destFactorRgba );
173 * @brief Specify the pixel arithmetic used when the actor is blended.
175 * @param[in] srcFactorRgb Specifies how the red, green, and blue source blending factors are computed.
176 * The options are BlendingFactor::ZERO, ONE, SRC_COLOR, ONE_MINUS_SRC_COLOR, DST_COLOR, ONE_MINUS_DST_COLOR,
177 * SRC_ALPHA, ONE_MINUS_SRC_ALPHA, DST_ALPHA, ONE_MINUS_DST_ALPHA, CONSTANT_COLOR, ONE_MINUS_CONSTANT_COLOR,
178 * GL_CONSTANT_ALPHA, GL_ONE_MINUS_CONSTANT_ALPHA, and GL_SRC_ALPHA_SATURATE.
180 * @param[in] destFactorRgb Specifies how the red, green, blue, and alpha destination blending factors are computed.
181 * The options are BlendingFactor::ZERO, ONE, SRC_COLOR, ONE_MINUS_SRC_COLOR, DST_COLOR, ONE_MINUS_DST_COLOR,
182 * SRC_ALPHA, ONE_MINUS_SRC_ALPHA, DST_ALPHA, ONE_MINUS_DST_ALPHA, CONSTANT_COLOR, ONE_MINUS_CONSTANT_COLOR,
183 * GL_CONSTANT_ALPHA, and GL_ONE_MINUS_CONSTANT_ALPHA.
185 * @param[in] srcFactorAlpha Specifies how the alpha source blending factor is computed.
186 * The options are the same as for srcFactorRgb.
188 * @param[in] destFactorAlpha Specifies how the alpha source blending factor is computed.
189 * The options are the same as for destFactorRgb.
191 void SetBlendFunc( BlendingFactor::Type srcFactorRgb, BlendingFactor::Type destFactorRgb,
192 BlendingFactor::Type srcFactorAlpha, BlendingFactor::Type destFactorAlpha );
195 * @brief Query the pixel arithmetic used when the actor is blended.
197 * @param[out] srcFactorRgb Specifies how the red, green, blue, and alpha source blending factors are computed.
198 * @param[out] destFactorRgb Specifies how the red, green, blue, and alpha destination blending factors are computed.
199 * @param[out] srcFactorAlpha Specifies how the red, green, blue, and alpha source blending factors are computed.
200 * @param[out] destFactorAlpha Specifies how the red, green, blue, and alpha destination blending factors are computed.
202 void GetBlendFunc( BlendingFactor::Type& srcFactorRgb, BlendingFactor::Type& destFactorRgb,
203 BlendingFactor::Type& srcFactorAlpha, BlendingFactor::Type& destFactorAlpha ) const;
206 * @brief Specify the equation used when the actor is blended.
208 * The options are BlendingEquation::ADD, SUBTRACT, or REVERSE_SUBTRACT.
209 * @param[in] equationRgba The equation used for combining red, green, blue, and alpha components.
211 void SetBlendEquation( BlendingEquation::Type equationRgba );
214 * @brief Specify the equation used when the actor is blended.
216 * @param[in] equationRgb The equation used for combining red, green, and blue components.
217 * @param[in] equationAlpha The equation used for combining the alpha component.
218 * The options are BlendingEquation::ADD, SUBTRACT, or REVERSE_SUBTRACT.
220 void SetBlendEquation( BlendingEquation::Type equationRgb, BlendingEquation::Type equationAlpha );
223 * @brief Query the equation used when the actor is blended.
225 * @param[out] equationRgb The equation used for combining red, green, and blue components.
226 * @param[out] equationAlpha The equation used for combining the alpha component.
228 void GetBlendEquation( BlendingEquation::Type& equationRgb, BlendingEquation::Type& equationAlpha ) const;
232 * @brief The constructor
234 * @param [in] pointer A pointer to a newly allocated Renderer
236 explicit DALI_INTERNAL Renderer( Internal::Renderer* pointer );
241 #endif // DALI_RENDERER_H