X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Factors%2Fblending.h;h=c3f33c770c3e0b62ea21379d2f6601c4b4d9b41f;hb=334442ab65c242cf6da1435749a5c5c5bb69f592;hp=8bde005aa52aa70063e7db724a0c9d42b64230d3;hpb=226a0a9c08f0b2ba78404e32db98195583f5d791;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/actors/blending.h b/dali/public-api/actors/blending.h index 8bde005..c3f33c7 100644 --- a/dali/public-api/actors/blending.h +++ b/dali/public-api/actors/blending.h @@ -2,7 +2,7 @@ #define __DALI_BLENDING_H__ /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2015 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. @@ -23,18 +23,24 @@ namespace Dali { +/** + * @addtogroup dali_core_actors + * @{ + */ namespace BlendingMode { /** * @brief Blending mode. - * @see Dali::RenderableActor::SetBlendMode() and Dali::RenderableActor::GetBlendMode() + * @SINCE_1_0.0 + * @remarks This is an experimental feature and might not be supported in the next release. + * We do recommend not to use it. */ enum Type { - OFF, ///< Blending is disabled. - AUTO, ///< Blending is enabled if there is alpha channel. - ON ///< Blending is enabled. + OFF, ///< Blending is disabled. @SINCE_1_0.0 + AUTO, ///< Blending is enabled if there is alpha channel. This is the default mode. @SINCE_1_0.0 + ON ///< Blending is enabled. @SINCE_1_0.0 }; } //namespace BlendingMode @@ -44,25 +50,27 @@ namespace BlendingFactor /** * @brief Blending Factor. * - * @see Dali::RenderableActor::SetBlendFunc() and Dali::RenderableActor::GetBlendFunc() + * @SINCE_1_0.0 + * @remarks This is an experimental feature and might not be supported in the next release. + * We do recommend not to use it. */ enum Type { - ZERO = 0, - ONE = 1, - SRC_COLOR = 0x0300, - ONE_MINUS_SRC_COLOR = 0x0301, - SRC_ALPHA = 0x0302, - ONE_MINUS_SRC_ALPHA = 0x0303, - DST_ALPHA = 0x0304, - ONE_MINUS_DST_ALPHA = 0x0305, - DST_COLOR = 0x0306, - ONE_MINUS_DST_COLOR = 0x0307, - SRC_ALPHA_SATURATE = 0x0308, - CONSTANT_COLOR = 0x8001, - ONE_MINUS_CONSTANT_COLOR = 0x8002, - CONSTANT_ALPHA = 0x8003, - ONE_MINUS_CONSTANT_ALPHA = 0x8004 + ZERO = 0, ///< ZERO @SINCE_1_0.0 + ONE = 1, ///< ONE @SINCE_1_0.0 + SRC_COLOR = 0x0300, ///< SRC_COLOR @SINCE_1_0.0 + ONE_MINUS_SRC_COLOR = 0x0301, ///< ONE_MINUS_SRC_COLOR @SINCE_1_0.0 + SRC_ALPHA = 0x0302, ///< SRC_ALPHA @SINCE_1_0.0 + ONE_MINUS_SRC_ALPHA = 0x0303, ///< ONE_MINUS_SRC_ALPHA @SINCE_1_0.0 + DST_ALPHA = 0x0304, ///< DST_ALPHA @SINCE_1_0.0 + ONE_MINUS_DST_ALPHA = 0x0305, ///< ONE_MINUS_DST_ALPHA @SINCE_1_0.0 + DST_COLOR = 0x0306, ///< DST_COLOR @SINCE_1_0.0 + ONE_MINUS_DST_COLOR = 0x0307, ///< ONE_MINUS_DST_COLOR @SINCE_1_0.0 + SRC_ALPHA_SATURATE = 0x0308, ///< SRC_ALPHA_SATURATE @SINCE_1_0.0 + CONSTANT_COLOR = 0x8001, ///< CONSTANT_COLOR @SINCE_1_0.0 + ONE_MINUS_CONSTANT_COLOR = 0x8002, ///< ONE_MINUS_CONSTANT_COLOR @SINCE_1_0.0 + CONSTANT_ALPHA = 0x8003, ///< CONSTANT_ALPHA @SINCE_1_0.0 + ONE_MINUS_CONSTANT_ALPHA = 0x8004 ///< ONE_MINUS_CONSTANT_ALPHA @SINCE_1_0.0 }; } // namespace BlendingFactor @@ -72,13 +80,15 @@ namespace BlendingEquation /** * @brief Blending Equation. * - * @see Dali::RenderableActor::SetBlendEquation() and Dali::RenderableActor::GetBlendEquation() + * @SINCE_1_0.0 + * @remarks This is an experimental feature and might not be supported in the next release. + * We do recommend not to use it. */ enum Type { - ADD = 0x8006, - SUBTRACT = 0x800A, - REVERSE_SUBTRACT = 0x800B + ADD = 0x8006, ///< The source and destination colors are added to each other. @SINCE_1_0.0 + SUBTRACT = 0x800A, ///< Subtracts the destination from the source. @SINCE_1_0.0 + REVERSE_SUBTRACT = 0x800B ///< Subtracts the source from the destination. @SINCE_1_0.0 }; } // namespace BlendingEquation @@ -91,6 +101,9 @@ DALI_IMPORT_API extern const BlendingFactor::Type DEFAULT_BLENDING_DEST_FACTOR DALI_IMPORT_API extern const BlendingEquation::Type DEFAULT_BLENDING_EQUATION_RGB; ///< BlendingEquation::ADD DALI_IMPORT_API extern const BlendingEquation::Type DEFAULT_BLENDING_EQUATION_ALPHA; ///< BlendingEquation::ADD +/** + * @} + */ } // namespace Dali #endif // __DALI_BLENDING_H__