Struct ImageVisualProperty

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll

This specifies properties of the ImageVisual.

public struct ImageVisualProperty

Fields

View Source

AlphaMaskURL

The URL of the alpha mask image.

Declaration
public static readonly int AlphaMaskURL
Field Value
Type Description
int
View Source

Atlasing

Whether to use the texture atlas.

Declaration
public static readonly int Atlasing
Field Value
Type Description
int
View Source

AuxiliaryImageAlpha

Alpha value for the auxiliary image, without affecting the underlying NPatch image

Declaration
public static readonly int AuxiliaryImageAlpha
Field Value
Type Description
int
View Source

AuxiliaryImageURL

Overlays the auxiliary image on top of an NPatch image.

Declaration
public static readonly int AuxiliaryImageURL
Field Value
Type Description
int
View Source

BatchSize

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

Declaration
public static readonly int BatchSize
Field Value
Type Description
int
View Source

Border

The border of the image.

Declaration
public static readonly int Border
Field Value
Type Description
int
View Source

BorderOnly

If true, only draws the borders.

Declaration
public static readonly int BorderOnly
Field Value
Type Description
int
View Source

CacheSize

Defines the cache size for loading images in the AnimatedImageVisual

Declaration
public static readonly int CacheSize
Field Value
Type Description
int
View Source

ContentInfo

@brief The content information the AnimatedVectorImageVisual will use. @details Name "contentInfo", Type Property::MAP. The map contains the layer name as a key and Property::Array as a value. And the array contains 2 integer values which are the frame numbers, the start frame number and the end frame number of the layer. @note This property is read-only.

Declaration
public static readonly int ContentInfo
Field Value
Type Description
int
Remarks

Inhouse API

View Source

CropToMask

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

Declaration
public static readonly int CropToMask
Field Value
Type Description
int
View Source

CurrentFrameNumber

@brief The current frame number the AnimatedVectorImageVisual will use. @details Name "currentFrameNumber", Type Property::INTEGER, between[0, the maximum frame number] or between the play range if specified @note This property is read-only.

Declaration
public static readonly int CurrentFrameNumber
Field Value
Type Description
int
Remarks

Inhouse API

View Source

DesiredHeight

The desired image height.

Declaration
public static readonly int DesiredHeight
Field Value
Type Description
int
View Source

DesiredWidth

The desired image width.

Declaration
public static readonly int DesiredWidth
Field Value
Type Description
int
View Source

EnableFrameCache

@brief Whether to animated image visual uses fixed cache or not. @details type Property::BOOLEAN. If this property is true, animated image visual uses fixed cache for loading and keeps loaded frame until the visual is removed. It reduces CPU cost when the animated image will be looping. But it can spend a lot of memory if the resource has high resolution image or many frame count. @note It is used in the AnimatedVectorImageVisual. The default is false

Declaration
public static readonly int EnableFrameCache
Field Value
Type Description
int
View Source

FastTrackUploading

@brief Whether to uploading texture before ResourceReady signal emit or after texture load completed time. @details Name "fastTrackUploading", type Property::BOOLEAN. @note It is used in the ImageVisual. The default is false.

Declaration
public static readonly int FastTrackUploading
Field Value
Type Description
int
View Source

FittingMode

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

Declaration
public static readonly int FittingMode
Field Value
Type Description
int
View Source

FrameDelay

The number of milliseconds between each frame in the AnimatedImageVisual

Declaration
public static readonly int FrameDelay
Field Value
Type Description
int
View Source

FrameSpeedFactor

@brief Specifies a speed factor for the animated image frame. @details Name "frameSpeedFactor", type Property::FLOAT.

The speed factor is a multiplier of the normal velocity of the animation. Values between [0,1] will slow down the animation and values above one will speed up the animation.

@note The range of this value is clamped between [0.01f ~ 100.0f]. It might be supported out of bound, and negative value in future. @note Used by the ImageVisual and AnimatedVectorImageVisual. The default is 1.0f.

Declaration
public static readonly int FrameSpeedFactor
Field Value
Type Description
int
View Source

LoadPolicy

The policy to determine when an image should be loaded.

Declaration
public static readonly int LoadPolicy
Field Value
Type Description
int
View Source

LoopCount

The number of times the AnimatedImageVisual will be looped. The default is -1. If the value is less than 0, loop unlimited. Otherwise, loop loopCount times.

Declaration
public static readonly int LoopCount
Field Value
Type Description
int
View Source

LoopingMode

@brief The looping mode the AnimatedVectorImageVisual will use. @details Name "loopingMode", Type LoopingMode::Type (Property::INTEGER) @note Default value is LoopingMode::RESTART.

Declaration
public static readonly int LoopingMode
Field Value
Type Description
int
Remarks

Inhouse API

View Source

MarkerInfo

@brief The marker information the AnimatedVectorImageVisual will use. @details Type Property::MAP. The map contains the marker name as a key and Property::Array as a value. And the array contains 2 integer values which are the frame numbers, the start frame number and the end frame number of the marker. @note This property is read-only.

Declaration
public static readonly int MarkerInfo
Field Value
Type Description
int
View Source

MaskContentScale

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

Declaration
public static readonly int MaskContentScale
Field Value
Type Description
int
View Source

MaskingMode

@brief Whether to apply mask on the GPU or not. @details Name "MaskingMode", type MaskingModeType (Property::INTEGER). @note It is used in the ImageVisual, and AnimatedImageVisual.The default is MaskingOnLoading.

Declaration
public static readonly int MaskingMode
Field Value
Type Description
int
View Source

NotifyAfterRasterization

@brief Whether notify AnimatedVectorImageVisual to render thread after every rasterization or not. @details type Property::BOOLEAN. If this property is true, AnimatedVectorImageVisual send notify to render thread after every rasterization. If false, AnimatedVectorImageVisual set Renderer's Behaviour as Continouly (mean, always update the render thread.)

This flag is useful if given resource has low fps, so we don't need to render every frame. @note It is used in the AnimatedVectorImageVisual. The default is false.

Declaration
public static readonly int NotifyAfterRasterization
Field Value
Type Description
int
View Source

OrientationCorrection

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

Declaration
public static readonly int OrientationCorrection
Field Value
Type Description
int
View Source

PixelArea

The image area to be displayed.

Declaration
public static readonly int PixelArea
Field Value
Type Description
int
View Source

PlayRange

@brief The playing range the AnimatedVectorImageVisual will use. Animation will play between the values specified.The array can only have two values, and more will be ignored. Both values should be between 0 and the total frame number, otherwise they will be ignored. If the range provided is not in proper order (minimum, maximum), it will be reordered. @details Name "playRange", Type Property::ARRAY of Property::INTEGER @note Default 0 and the total frame number.

Declaration
public static readonly int PlayRange
Field Value
Type Description
int
Remarks

Hidden API (Inhouse API)

View Source

PlayState

@brief The playing state the AnimatedVectorImageVisual will use. @details Name "playState", type PlayState (Property::INTEGER) @note This property is read-only.

Declaration
public static readonly int PlayState
Field Value
Type Description
int
Remarks

Hidden API (Inhouse API)

View Source

RedrawInScalingDown

@brief Whether to redraw the image when the visual is scaled down. @details Name "redrawInScalingDown", type Property::BOOLEAN. @note It is used in the AnimatedVectorImageVisual.The default is true.

Declaration
public static readonly int RedrawInScalingDown
Field Value
Type Description
int
Remarks

Inhouse API

View Source

RedrawInScalingUp

@brief Whether to redraw the image when the visual is scaled up. @details Name "redrawInScalingUp", type Property::BOOLEAN. @note It is used in the AnimatedVectorImageVisual.The default is true.

Declaration
public static readonly int RedrawInScalingUp
Field Value
Type Description
int
Remarks

Inhouse API

View Source

ReleasePolicy

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

Declaration
public static readonly int ReleasePolicy
Field Value
Type Description
int
View Source

RenderScale

@brief Renders a texture at a given scale. @details Name "renderScale", type Property::FLOAT. @note It is used when scaling up AnimatedVectorImageVisual. The default is 1.0f.

Declaration
public static readonly int RenderScale
Field Value
Type Description
int
View Source

SamplingMode

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

Declaration
public static readonly int SamplingMode
Field Value
Type Description
int
View Source

StopBehavior

@brief The stop behavior the AnimatedVectorImageVisual will use. @details Name "stopBehavior", Type StopBehavior::Type (Property::INTEGER) @note Default value is StopBehavior::CURRENT_FRAME.

Declaration
public static readonly int StopBehavior
Field Value
Type Description
int
Remarks

Inhouse API

View Source

SynchronousLoading

Whether to load the image synchronously.

Declaration
public static readonly int SynchronousLoading
Field Value
Type Description
int
View Source

SynchronousSizing

@brief Whether to synchronize image texture size to visual size. @details Name "synchronousSizing", type Property::BOOLEAN. If this property is true, ImageVisual ignores mDesiredSize. @note Used by the ImageVisual. The default is false.

Declaration
public static readonly int SynchronousSizing
Field Value
Type Description
int
View Source

TotalFrameNumber

@brief The total frame number the AnimatedVectorImageVisual will use. @details Name "totalFrameNumber", Type Property::INTEGER. @note This property is read-only.

Declaration
public static readonly int TotalFrameNumber
Field Value
Type Description
int
Remarks

Inhouse API

View Source

URL

The URL of the image.

Declaration
public static readonly int URL
Field Value
Type Description
int
View Source

WrapModeU

The wrap mode for u coordinate.

Declaration
public static readonly int WrapModeU
Field Value
Type Description
int
View Source

WrapModeV

The wrap mode for v coordinate.

Declaration
public static readonly int WrapModeV
Field Value
Type Description
int

Extension Methods