X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fvisuals%2Fimage-visual-properties.h;h=c28b05923e1739b1c0991d7d64eb9fdc3d81427e;hp=93902cf0b5670694f2638c982b5700307321ffa9;hb=763c96a171fb79c5ae983792434537c70ac231fb;hpb=a1569d27e91ea58dbfbcdb3692fe10a971d06732 diff --git a/dali-toolkit/public-api/visuals/image-visual-properties.h b/dali-toolkit/public-api/visuals/image-visual-properties.h index 93902cf..c28b059 100644 --- a/dali-toolkit/public-api/visuals/image-visual-properties.h +++ b/dali-toolkit/public-api/visuals/image-visual-properties.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_IMAGE_VISUAL_PROPERTIES_H /* - * Copyright (c) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 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. @@ -184,19 +184,21 @@ enum /** * @brief Defines the batch size for pre-loading images in the AnimatedImageVisual * @details Name "batchSize", type Property::INTEGER, number of images to pre-load - * before starting to play. Default value: 1 + * before starting to play. Default value: 2 * @SINCE_1_2.60 * @note Optional. + * @note Minimum supported value is 2. */ BATCH_SIZE, /** * @brief Defines the cache size for loading images in the AnimatedImageVisual * @details Name "cacheSize", type Property::INTEGER, number of images to keep - * cached ahead during playback. Default value: 1 + * cached ahead during playback. Default value: 2 * * @SINCE_1_2.60 * @note Optional. + * @note Minimum supported value is 2. * @note, cacheSize should be >= batchSize. * If it isn't, then the cache will automatically be changed to batchSize. * @note, because of the defaults, it is expected that the application developer @@ -232,10 +234,78 @@ enum * @note If this is false, then the mask is scaled to fit the image before being applied. */ CROP_TO_MASK, + + /** + * @brief The policy to determine when an image should be loaded. + * @details Name "loadPolicy", Type LoadPolicy::Type (Property::INTEGER)or Property::STRING. + * @SINCE_1_3_5 + * @note Default LoadPolicy::ATTACHED + * @see LoadPolicy::Type + */ + + LOAD_POLICY, + + /** + * @brief The policy to determine when an image should no longer be cached. + * @details Name "releasePolicy", Type ReleasePolicy::Type (Property::INTEGER) or Property::STRING + * @SINCE_1_3_5 + * @note Default ReleasePolicy::DESTROYED + * @see ReleasePolicy::Type + */ + RELEASE_POLICY, + + /** + * @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. + * @SINCE_1_3_5 + * @note Default true + */ + ORIENTATION_CORRECTION, + }; } // namespace Property +/** + * @brief The policy determining if the image is loaded when the visual is staged or created. + * @SINCE_1_3_5 + */ +namespace LoadPolicy +{ + +/** + * @brief The available named elements that define the LoadPolicy. + * @SINCE_1_3_5 + */ +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. + * @SINCE_1_3_5 + * @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. + * @SINCE_1_3_5 + */ +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 ImageVisual /**