Class ImageVisual

    Definition

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

    A class encapsulating the property map of the image visual.

    public class ImageVisual : VisualMap, IDisposable
    Inheritance
    object
    VisualMap
    ImageVisual
    Implements
    System.IDisposable

    Constructors

    View Source

    ImageVisual()

    Default constructor of ImageVisual class.

    Declaration
    public ImageVisual()

    Properties

    View Source

    AlphaMaskURL

    Gets or sets the URL of the alpha mask.
    Optional.

    Declaration
    public string AlphaMaskURL { get; set; }
    Property Value
    Type Description
    string
    View Source

    Atlasing

    Whether to use the texture atlas or not. Optional. By default atlasing is off.

    Declaration
    public bool Atlasing { get; set; }
    Property Value
    Type Description
    bool
    View Source

    AuxiliaryImageAlpha

    An alpha value for mixing between the masked main NPatch image and the auxiliary image.

    Declaration
    public float AuxiliaryImageAlpha { get; set; }
    Property Value
    Type Description
    float
    View Source

    AuxiliaryImageURL

    Overlays the auxiliary image on top of an NPatch image. The resulting visual image will be at least as large as the smallest possible n-patch or the auxiliary image, whichever is larger.

    Declaration
    public string AuxiliaryImageURL { get; set; }
    Property Value
    Type Description
    string
    View Source

    BorderOnly

    Gets or sets whether to draw the borders only (If true).
    If not specified, the default is false.
    For n-patch images only.
    Optional.

    Declaration
    public bool BorderOnly { get; set; }
    Property Value
    Type Description
    bool
    View Source

    CropToMask

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

    Declaration
    public bool CropToMask { get; set; }
    Property Value
    Type Description
    bool
    View Source

    DesiredHeight

    Gets or sets the desired image height.
    If not specified, the actual image height is used.
    For normal quad images only.
    Optional.

    Declaration
    public int DesiredHeight { get; set; }
    Property Value
    Type Description
    int
    View Source

    DesiredWidth

    Gets or sets the desired image width.
    If not specified, the actual image width is used.
    For normal quad images only.
    Optional.

    Declaration
    public int DesiredWidth { get; set; }
    Property Value
    Type Description
    int
    View Source

    FittingMode

    Gets or sets fitting options used when resizing images to fit the desired dimensions.
    If not supplied, the default is FittingModeType.ShrinkToFit.
    For normal quad images only.
    Optional.

    Declaration
    public FittingModeType FittingMode { get; set; }
    Property Value
    Type Description
    FittingModeType
    View Source

    LoadPolicy

    Gets or sets the Image Visual image loading policy.
    It decides if a texture should be loaded immediately after source set or only after the visual is added to the window.

    Declaration
    public LoadPolicyType LoadPolicy { get; set; }
    Property Value
    Type Description
    LoadPolicyType
    View Source

    MaskContentScale

    Gets or sets scale factor to apply to the content image before masking.

    Declaration
    public float MaskContentScale { get; set; }
    Property Value
    Type Description
    float
    View Source

    OrientationCorrection

    Gets or sets whether to automatically correct the orientation based on the Exchangeable Image File (EXIF) data.
    If not specified, the default is true.
    For JPEG images only.
    Optional.

    Declaration
    public bool OrientationCorrection { get; set; }
    Property Value
    Type Description
    bool
    View Source

    PixelArea

    Gets or sets the image area to be displayed.
    It is a rectangular area.
    The first two elements indicate the top-left position of the area, and the last two elements are the areas of the width and the height respectively.
    If not specified, the default value is Vector4 (0.0, 0.0, 1.0, 1.0), i.e., the entire area of the image.
    For normal quad images only.
    Optional.

    Declaration
    public Vector4 PixelArea { get; set; }
    Property Value
    Type Description
    Vector4
    View Source

    ReleasePolicy

    Gets or sets the Image Visual release policy.
    It decides if a texture should be released from the cache or kept to reduce the loading time.

    Declaration
    public ReleasePolicyType ReleasePolicy { get; set; }
    Property Value
    Type Description
    ReleasePolicyType
    View Source

    SamplingMode

    Gets or sets filtering options used when resizing images to the sample original pixels.
    If not supplied, the default is SamplingModeType.Box.
    For normal quad images only.
    Optional.

    Declaration
    public SamplingModeType SamplingMode { get; set; }
    Property Value
    Type Description
    SamplingModeType
    View Source

    SynchronousLoading

    Gets or sets whether to load the image synchronously.
    If not specified, the default is false, i.e., the image is loaded asynchronously.
    For normal quad images only.
    Optional.

    Declaration
    public bool SynchronousLoading { get; set; }
    Property Value
    Type Description
    bool
    View Source

    URL

    Gets or sets the URL of the image.
    Mandatory.

    Declaration
    public string URL { get; set; }
    Property Value
    Type Description
    string
    View Source

    WrapModeU

    Gets or sets the wrap mode for the u coordinate.
    It decides how the texture should be sampled when the u coordinate exceeds the range of 0.0 to 1.0.
    If not specified, the default is WrapModeType.Default(CLAMP).
    For normal quad images only.
    Optional.

    Declaration
    public WrapModeType WrapModeU { get; set; }
    Property Value
    Type Description
    WrapModeType
    View Source

    WrapModeV

    Gets or sets the wrap mode for the v coordinate.
    It decides how the texture should be sampled when the v coordinate exceeds the range of 0.0 to 1.0.
    The first two elements indicate the top-left position of the area, and the last two elements are the areas of the width and the height respectively.
    If not specified, the default is WrapModeType.Default(CLAMP).
    For normal quad images only. Optional.

    Declaration
    public WrapModeType WrapModeV { get; set; }
    Property Value
    Type Description
    WrapModeType

    Methods

    View Source

    ComposingPropertyMap()

    Compose the out visual map.

    Declaration
    protected override void ComposingPropertyMap()
    Overrides
    VisualMap.ComposingPropertyMap()

    Implements

    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX