X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fvisuals%2Fimage-visual-properties.h;h=edd94ccf5b50338f162537d7a041200ecd22a415;hb=dc1b9bcdb0aae8a6c0cea63cd57678f19e7742d4;hp=7d46ac70ce6ca415567e60361d973e365f36b7aa;hpb=c04a09f43cb4d1def43aff517e6f8053f8a96add;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/visuals/image-visual-properties.h b/dali-toolkit/public-api/visuals/image-visual-properties.h index 7d46ac7..edd94cc 100644 --- a/dali-toolkit/public-api/visuals/image-visual-properties.h +++ b/dali-toolkit/public-api/visuals/image-visual-properties.h @@ -19,7 +19,7 @@ */ // INTERNAL INCLUDES -#include +#include namespace Dali { @@ -27,12 +27,29 @@ namespace Dali namespace Toolkit { +/** + * @addtogroup dali_toolkit_visuals + * @{ + */ + +/** + * @brief ImageVisual is to render an image into the control's quad. + * @SINCE_1_1.45 + */ namespace ImageVisual { +/** + * @brief ImageVisual Property + * @SINCE_1_1.45 + */ namespace Property { +/** + * @brief ImageVisual Property + * @SINCE_1_1.45 + */ enum { /** @@ -100,18 +117,45 @@ enum BORDER_ONLY, /** - * @brief This enables Image visuals to automatically be converted to Batch-Image visuals. - * @details Name "batchingEnabled", type Property::BOOLEAN. - * @SINCE_1_2.0 - * @note Optional. For Image visuals only. Not to be used with NPatch or SVG images. + * @brief The image area to be displayed. + * @details Name "pixelArea", type Property::VECTOR4. + * It is a rectangular area. + * The first two elements indicate the top-left position of the area, and the last two elements are the area width and height respectively. + * @SINCE_1_2.1 + * @note Optional. If not specified, the default value is [0.0, 0.0, 1.0, 1.0], i.e. the entire area of the image. + * @note For Normal Quad images only. + */ + PIXEL_AREA, + + /** + * @brief The wrap mode for u coordinate. + * @details Name "wrapModeU", type Dali::WrapMode::Type (Property::INTEGER) or Property::STRING + * It decides how the texture should be sampled when the u coordinate exceeds the range of 0.0 to 1.0. + * @SINCE_1_2.1 + * @note Optional. If not specified, the default is CLAMP. + * @note For Normal QUAD image only. */ - BATCHING_ENABLED, + WRAP_MODE_U, + + /** + * @brief The wrap mode for v coordinate. + * @details Name "wrapModeV", type Dali::WrapMode::Type (Property::INTEGER) or Property::STRING + * it decides how the texture should be sampled when the v coordinate exceeds the range of 0.0 to 1.0. + * @SINCE_1_2.1 + * @note Optional. If not specified, the default is CLAMP. + * @note For Normal QUAD image only. + */ + WRAP_MODE_V, }; } // namespace Property } // namespace ImageVisual +/** + * @} + */ + } // namespace Toolkit } // namespace Dali