Tizen Native API  4.0
Enumerations
Dali::Toolkit::ImageVisual::Property Namespace Reference

ImageVisual Property. More...

Enumerations

enum  
 Enumeration for the instance of properties belonging to the ImageVisual. More...

Detailed Description

ImageVisual Property.

Since:
3.0, DALi version 1.1.45

Enumeration Type Documentation

anonymous enum

Enumeration for the instance of properties belonging to the ImageVisual.

Since:
3.0, DALi version 1.1.45
Enumerator:
URL 

The URL of the image.

Name "url", type Property::STRING or Property::ARRAY of Property::STRING.

Note:
The array form is used for generating animated image visuals.
The number of threads used for local and remote image loading can be controlled by the environment variables DALI_TEXTURE_LOCAL_THREADS and DALI_TEXTURE_REMOTE_THREADS respectively. The default values are 4 threads for local image loading and 8 threads for remote image loading.
Since:
3.0, DALi version 1.1.45
Note:
Mandatory.
FITTING_MODE 

Fitting options, used when resizing images to fit desired dimensions.

Name "fittingMode", type Dali::FittingMode (Property::INTEGER) or Property::STRING.

Since:
3.0, DALi version 1.1.45
Note:
Optional. If not supplied, default is FittingMode::SHRINK_TO_FIT.
For Normal Quad images only.
See also:
Dali::FittingMode
SAMPLING_MODE 

Filtering options, used when resizing images to sample original pixels.

Name "samplingMode", type Dali::SamplingMode (Property::INTEGER) or Property::STRING.

Since:
3.0, DALi version 1.1.45
Note:
Optional. If not supplied, default is SamplingMode::BOX.
For Normal Quad images only.
See also:
Dali::SamplingMode
DESIRED_WIDTH 

The desired image width.

Name "desiredWidth", type Property::INTEGER.

Since:
3.0, DALi version 1.1.45
Note:
Optional. If not specified, the actual image width is used.
For Normal Quad images only.
DESIRED_HEIGHT 

The desired image height.

Name "desiredHeight", type Property::INTEGER.

Since:
3.0, DALi version 1.1.45
Note:
Optional. If not specified, the actual image height is used.
For Normal Quad images only.
SYNCHRONOUS_LOADING 

Whether to load the image synchronously.

Name "synchronousLoading", type Property::BOOLEAN.

Since:
3.0, DALi version 1.1.45
Note:
Optional. If not specified, the default is false, i.e. the image is loaded asynchronously.
For Normal Quad images only.
BORDER_ONLY 

If true, only draws the borders.

Name "borderOnly", type Property::BOOLEAN.

Since:
3.0, DALi version 1.1.45
Note:
Optional. If not specified, the default is false.
For N-Patch images only.
PIXEL_AREA 

The image area to be displayed.

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:
4.0, DALi version 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.
For Normal Quad images only.
WRAP_MODE_U 

The wrap mode for u coordinate.

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:
4.0, DALi version 1.2.1
Note:
Optional. If not specified, the default is CLAMP.
For Normal QUAD image only.
WRAP_MODE_V 

The wrap mode for v coordinate.

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:
4.0, DALi version 1.2.1
Note:
Optional. If not specified, the default is CLAMP.
For Normal QUAD image only.
BORDER 

The border of the image.

Name "border", type Property::RECTANGLE or Property::VECTOR4. The border of the image in the order: left, right, bottom, top.

Since:
4.0, DALi version 1.2.60
Note:
Optional.
For N-Patch images only.
ATLASING 

Whether to use the texture atlas.

Name "atlasing", type Property::BOOLEAN.

Since:
4.0, DALi version 1.2.60
Note:
Optional. By default atlasing is off.
ALPHA_MASK_URL 

URL of a masking image.

Name "alphaMaskUrl", type Property::STRING, URL of image to apply as a mask after image loading. If set after the main URL has finished loading, this may necessitate a re-load of the main image. The alpha mask image will be scaled on load to match the size of the main image, then applied to the pixel data before uploading to GL.

Since:
4.0, DALi version 1.2.60
Note:
Optional.
BATCH_SIZE 

Defines the batch size for pre-loading images in the AnimatedImageVisual.

Name "batchSize", type Property::INTEGER, number of images to pre-load before starting to play. Default value: 1

Since:
4.0, DALi version 1.2.60
Note:
Optional.
CACHE_SIZE 

Defines the cache size for loading images in the AnimatedImageVisual.

Name "cacheSize", type Property::INTEGER, number of images to keep cached ahead during playback. Default value: 1

Since:
4.0, DALi version 1.2.60
Note:
Optional.
, cacheSize should be >= batchSize. If it isn't, then the cache will automatically be changed to batchSize.
, because of the defaults, it is expected that the application developer tune the batch and cache sizes to their particular use case.
FRAME_DELAY 

The number of milliseconds between each frame in the AnimatedImageVisual.

Name "frameDelay", type Property::INTEGER, The number of milliseconds between each frame.

Since:
4.0, DALi version 1.2.60
Note:
Optional.
This is only used when multiple URLs are provided.
MASK_CONTENT_SCALE 

The scale factor to apply to the content image before masking.

Name "maskContentScale", type Property::FLOAT, The scale factor to apply to the content before masking. Note, scaled images are cropped to the same size as the alpha mask.

Since:
4.0, DALi version 1.2.60
Note:
Optional.
CROP_TO_MASK 

Whether to crop image to mask or scale mask to fit image.

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:
4.0, DALi version 1.2.60
Note:
Optional.
If this is false, then the mask is scaled to fit the image before being applied.
LOAD_POLICY 

The policy to determine when an image should be loaded.

Name "loadPolicy", Type LoadPolicy::Type (Property::INTEGER)or Property::STRING.

Since:
4.0, DALi version 1.3.5
Note:
Default LoadPolicy::ATTACHED
See also:
LoadPolicy::Type
RELEASE_POLICY 

The policy to determine when an image should no longer be cached.

Name "releasePolicy", Type ReleasePolicy::Type (Property::INTEGER) or Property::STRING

Since:
4.0, DALi version 1.3.5
Note:
Default ReleasePolicy::DESTROYED
See also:
ReleasePolicy::Type
ORIENTATION_CORRECTION 

Determines if image orientation should be corrected so the image displays as it was intended.

Name "orientationCorrection", Type Property::BOOLEAN, if true the image's orientation will be corrected.

Since:
4.0, DALi version 1.3.5
Note:
Default true