#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.
namespace Dali
{
-
namespace Toolkit
{
-
/**
* @addtogroup dali_toolkit_visuals
* @{
*/
namespace ImageVisual
{
-
/**
* @brief ImageVisual Property.
* @SINCE_1_1.45
*/
namespace Property
{
-
/**
* @brief Enumeration for the instance of properties belonging to the ImageVisual.
* @SINCE_1_1.45
/**
* @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
*/
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 ReleasePolicy::DESTROYED
* @see ReleasePolicy::Type
*/
-
RELEASE_POLICY,
/**
* @SINCE_1_3_5
* @note Default true
*/
-
ORIENTATION_CORRECTION,
};
*/
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.
+ 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
*/
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.
+ 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 ReleasePolicy
} // namespace ImageVisual