X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=dali-scene3d%2Fpublic-api%2Floader%2Frenderer-state.h;h=25365e965f2bf0397e7e615f48344fa1ea76bcfa;hb=HEAD;hp=0dc3c52c08c2c532b38d7c32c92c03dbd259d7f2;hpb=f2ee13ccda8c768fddc68f5208b7dcfa54c07242;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-scene3d/public-api/loader/renderer-state.h b/dali-scene3d/public-api/loader/renderer-state.h index 0dc3c52..25365e9 100644 --- a/dali-scene3d/public-api/loader/renderer-state.h +++ b/dali-scene3d/public-api/loader/renderer-state.h @@ -1,7 +1,7 @@ #ifndef DALI_SCENE3D_LOADER_RENDERER_STATE_H #define DALI_SCENE3D_LOADER_RENDERER_STATE_H /* - * Copyright (c) 2022 Samsung Electronics Co., Ltd. + * Copyright (c) 2023 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,20 +17,17 @@ * */ -// INTERAL INCLUDES -#include "dali-scene3d/public-api/api.h" - // EXTERNAL INCLUDES -#include "dali/public-api/rendering/renderer.h" +#include -namespace Dali -{ -namespace Scene3D -{ -namespace Loader +// INTERAL INCLUDES +#include + +namespace Dali::Scene3D::Loader { -/* +/** * @brief Contains values for comparison functions used in depth and stencil testing. + * @SINCE_2_0.7 * @note Relative order of members must match DepthFunction::Type and StencilFunction::Type. */ struct DALI_SCENE3D_API Comparison @@ -51,8 +48,9 @@ struct DALI_SCENE3D_API Comparison Comparison() = delete; }; -/* +/** * @brief Determines the blend factor used. + * @SINCE_2_0.7 * @note Relative order of members must match BlendFactor::Type. */ struct DALI_SCENE3D_API BlendFactor @@ -80,27 +78,29 @@ struct DALI_SCENE3D_API BlendFactor BlendFactor() = delete; }; -/* +/** * @brief Determines which buffers shall the Renderer write into. + * @SINCE_2_0.7 * @note Relative order of members must match RenderMode::Type. */ struct DALI_SCENE3D_API BufferMode { enum Type { - OMIT, ///< not specified - will not be updated - NONE, ///< Don’t write to either color or stencil buffer (But will potentially render to depth buffer). - AUTO, ///< Writes are managed by the Actor Clipping API. This is DALi's default. - COLOR, ///< Ignore stencil properties. Write to the color buffer. - STENCIL, ///< Use the stencil properties. Do not write to the color buffer. - COLOR_STENCIL ///< Use the stencil properties AND Write to the color buffer. + OMIT, ///< not specified - will not be updated. @SINCE_2_0.7 + NONE, ///< Don’t write to either color or stencil buffer (But will potentially render to depth buffer). @SINCE_2_0.7 + AUTO, ///< Writes are managed by the Actor Clipping API. This is DALi's default. @SINCE_2_0.7 + COLOR, ///< Ignore stencil properties. Write to the color buffer. @SINCE_2_0.7 + STENCIL, ///< Use the stencil properties. Do not write to the color buffer. @SINCE_2_0.7 + COLOR_STENCIL ///< Use the stencil properties AND Write to the color buffer. @SINCE_2_0.7 }; BufferMode() = delete; }; -/* +/** * @brief Contains values and functionality for configuring Renderers. + * @SINCE_2_0.7 */ namespace RendererState { @@ -137,9 +137,10 @@ enum DALI_SCENE3D_API Value : Type DEFAULT = DEPTH_WRITE | DEPTH_TEST | CULL_BACK | (Comparison::LESS_EQUAL << DEPTH_FUNCTION_SHIFT), }; -/* +/** * @brief Encodes the given blend factors into a RenderMode value, maskable into other options, - * passable into ApplyRenderMode(). + * passable into ApplyRenderMode(). + * @SINCE_2_0.7 */ inline DALI_SCENE3D_API constexpr uint32_t FromBlendFactors(BlendFactor::Type srcRgb, BlendFactor::Type destRgb, BlendFactor::Type srcAlpha, BlendFactor::Type destAlpha) { @@ -148,8 +149,9 @@ inline DALI_SCENE3D_API constexpr uint32_t FromBlendFactors(BlendFactor::Type sr << BLEND_FACTOR_BASE_SHIFT; } -/* +/** * @brief Applies the settings encoded in @a rendererState, to a @a renderer. + * @SINCE_2_0.7 * @note Depth function is only set if not Comparison::OMIT. * @note Blend factors are only set if not BlendFactor::OMIT. * @note Buffer mode is only set is not BufferMode::OMIT. @@ -158,8 +160,6 @@ DALI_SCENE3D_API void Apply(Type rendererState, Renderer& renderer); } // namespace RendererState -} // namespace Loader -} // namespace Scene3D -} // namespace Dali +} // namespace Dali::Scene3D::Loader #endif //DALI_SCENE3D_LOADER_RENDERER_STATE_H