X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fvisuals%2Fimage-visual-properties-devel.h;h=e87af5d76a056cbd80f9bd04338c269c7d3125fc;hb=14a48afd7d9b5ba7bd8c8ebc69b214be8310613a;hp=d2622da9f912627069ea46078d80a82979166e36;hpb=1fbb87959f02b4526fd66d9b8b39e4f8241c23ee;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/devel-api/visuals/image-visual-properties-devel.h b/dali-toolkit/devel-api/visuals/image-visual-properties-devel.h index d2622da..e87af5d 100644 --- a/dali-toolkit/devel-api/visuals/image-visual-properties-devel.h +++ b/dali-toolkit/devel-api/visuals/image-visual-properties-devel.h @@ -30,6 +30,42 @@ namespace Toolkit namespace DevelImageVisual { +/** + * @brief The policy determining if the image is loaded when the visual is staged or created. + */ +namespace LoadPolicy +{ + +/** + * @brief The available named elements that define the LoadPolicy. + */ +enum Type +{ + IMMEDIATE = 0, ///< The image is loaded when the ImageVisual is created. + ATTACHED ///< The image is loaded when the ImageVisual is attached to the stage. +}; + +} // namespace LoadPolicy + +/** + * @brief The policy determining when a image is deleted from the cache in relation to the ImageVisual lifetime. + * @note If the texture is being shared by another visual it persist if still required. + */ +namespace ReleasePolicy +{ + +/** + * @brief The available named elements that define the ReleasePolicy. + */ +enum Type +{ + DETACHED = 0, ///< Image deleted from cache when ImageVisual detached from stage. + DESTROYED, ///< Image deleted from cache when ImageVisual destroyed. + NEVER ///< Image is never deleted, will survive the lifetime of the application. +}; + +} // namespace ReleasePolicy; + namespace Property { @@ -45,25 +81,57 @@ enum Type PIXEL_AREA = Dali::Toolkit::ImageVisual::Property::PIXEL_AREA, WRAP_MODE_U = Dali::Toolkit::ImageVisual::Property::WRAP_MODE_U, WRAP_MODE_V = Dali::Toolkit::ImageVisual::Property::WRAP_MODE_V, + BORDER = Dali::Toolkit::ImageVisual::Property::BORDER, + ATLASING = Dali::Toolkit::ImageVisual::Property::ATLASING, + ALPHA_MASK_URL = Dali::Toolkit::ImageVisual::Property::ALPHA_MASK_URL, + BATCH_SIZE = Dali::Toolkit::ImageVisual::Property::BATCH_SIZE, + CACHE_SIZE = Dali::Toolkit::ImageVisual::Property::CACHE_SIZE, + FRAME_DELAY = Dali::Toolkit::ImageVisual::Property::FRAME_DELAY, + MASK_CONTENT_SCALE = Dali::Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, + CROP_TO_MASK = Dali::Toolkit::ImageVisual::Property::CROP_TO_MASK, /** - * @brief The border of the image - * @details Name "border", type Property::RECTANGLE or Property::VECTOR4 - * The border of the image in the order: left, right, bottom, top. - * - * @note Optional. - * @note For N-Patch images only. + * @brief The policy to determine when an image should be loaded. + * @details Name "loadPolicy", Type LoadPolicy::Type (Property::INTEGER)or Property::STRING. + * @note Default LoadPolicy::ATTACHED + * @see LoadPolicy::Type + */ + LOAD_POLICY = CROP_TO_MASK + 1, + + /** + * @brief The policy to determine when an image should no longer be cached. + * @details Name "releasePolicy", Type ReleasePolicy::Type (Property::INTEGER) or Property::STRING + * @note Default ReleasePolicy::DESTROYED + * @see ReleasePolicy::Type */ - BORDER = WRAP_MODE_V + 1, + RELEASE_POLICY = CROP_TO_MASK + 2, /** - * @brief Whether to use the texture atlas - * @details Name "atlasing", type Property::BOOLEAN, true to enable texture atlas + * @brief Determines if image orientation should be corrected so the image displays as it was intended. + * @details Name "orientationCorrection", Type Property::BOOLEAN, if true the image's orientation will be corrected. + * @note Default true + */ + ORIENTATION_CORRECTION = CROP_TO_MASK + 3, + + /** + * @brief Overlays the auxiliary iamge on top of an NPatch image. + * + * The resulting visual image will be at least as large as the + * smallest possible n-patch or the auxiliary image, whichever is + * larger. * - * @note Optional. By default atlasing is off. + * @details Name "auxiliaryImage", Type Property::STRING, URL of the image. + * @note Default true + */ + AUXILIARY_IMAGE = CROP_TO_MASK + 4, + + /** + * @brief An alpha value for mixing between the masked main NPatch image and the auxiliary image + * @details Name "auxiliaryImageAlpha", Type Property::FLOAT, between 0 and 1 + * @note Default 0 */ + AUXILIARY_IMAGE_ALPHA = CROP_TO_MASK + 5, - ATLASING = WRAP_MODE_V + 2, }; } //namespace Property