#define DALI_TOOLKIT_IMAGE_VISUAL_PROPERTIES_H
/*
- * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 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
* @details Name "cropToMask", type Property::BOOLEAN, True if the image should
* be cropped to match the mask size, or false if the image should remain the same size.
* @SINCE_1_2.60
- * @note Optional.
+ * @note Optional, Default true
* @note If this is false, then the mask is scaled to fit the image before being applied.
*/
CROP_TO_MASK,
LOAD_POLICY,
/**
- * @brief The policy to determine when an image should no longer be cached.
+ * @brief The policy to determine when an image request to be released so should no longer be cached.
* @details Name "releasePolicy", Type ReleasePolicy::Type (Property::INTEGER) or Property::STRING
* @SINCE_1_3_5
- * @note Default ReleasePolicy::DESTROYED
+ * @note Default ReleasePolicy::DETACHED
* @see ReleasePolicy::Type
*/
RELEASE_POLICY,
*/
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
/**
- * @brief The policy determining when a image is deleted from the cache in relation to the ImageVisual lifetime.
+ * @brief The policy determining when a image is requested to be 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.
+ 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