1 // Copyright (c) 2019 Samsung Electronics Co., Ltd.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
15 using System.ComponentModel;
20 /// Specifies the release policy types.<br />
21 /// Decides if the image should be cached in different conditions.
23 /// <since_tizen> 5 </since_tizen>
24 public enum ReleasePolicyType
27 /// Image is released when visual detached from scene.
31 /// Image is only released when visual is destroyed.
35 /// Image is not released.
41 /// Specifies the load policy types.<br />
42 /// Decides when the image texture should be loaded.
44 /// <since_tizen> 5 </since_tizen>
45 public enum LoadPolicyType
48 /// Load texture once the image source has been provided. Even if not being used yet.
52 /// Only load texture once the visual is attached, when the image needs to be shown.
58 /// Enumeration for the horizontal alignment of objects such as texts and layout items.
60 /// <since_tizen> 3 </since_tizen>
61 public enum HorizontalAlignment
64 /// Objects are placed at the beginning of the horizontal direction.
66 [Description("BEGIN")]
69 /// Objects are placed at the center of the horizontal direction.
71 [Description("CENTER")]
74 /// Objects are placed at the end of the horizontal direction.
81 /// Enumeration for the vertical alignment of objects such as texts and layout items.
83 /// <since_tizen> 3 </since_tizen>
84 public enum VerticalAlignment
87 /// Objects are placed at the top of the vertical direction.
92 /// Objects are placed at the center of the vertical direction.
94 [Description("CENTER")]
97 /// Objects are placed at the bottom of the vertical direction.
99 [Description("BOTTOM")]
104 /// This specifies wrap mode types.<br />
105 /// WrapModeU and WrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0.
107 /// <since_tizen> 3 </since_tizen>
108 public enum WrapModeType
111 /// The default value.
129 /// This specifies fitting mode types. Fitting options, used when resizing images to fit desired dimensions.<br />
130 /// A fitting mode controls the region of a loaded image to be mapped to the desired image rectangle.<br />
131 /// All fitting modes preserve the aspect ratio of the image contents.<br />
133 /// <since_tizen> 3 </since_tizen>
134 public enum FittingModeType
137 /// Full-screen image display: Limit loaded image resolution to device resolution using the ShrinkToFit mode.
141 /// Thumbnail gallery grid: Limit loaded image resolution to screen tile using the ScaleToFill mode.
145 /// Image columns: Limit loaded image resolution to column width using the FitWidth mode.
149 /// Image rows: Limit loaded image resolution to row height using the FitHeight mode.
153 /// Image displayed in its original size (no scaling) using the Center mode.
155 [EditorBrowsable(EditorBrowsableState.Never)]
158 /// Image stretched to fill the desired area (aspect ratio could be changed) using the Fill mode.
160 [EditorBrowsable(EditorBrowsableState.Never)]
165 /// This specifies sampling mode types. Filtering options are used when resizing images to sample original pixels.<br />
166 /// A SamplingMode controls how pixels in an input image are sampled and combined to generate each pixel of a destination image during scaling.<br />
167 /// NoFilter and Box modes do not guarantee that the output pixel array exactly matches the rectangle specified by the desired dimensions and the FittingMode,<br />
168 /// but all other filter modes do if the desired dimensions are not more than the raw dimensions of the input image file.<br />
170 /// <since_tizen> 3 </since_tizen>
171 public enum SamplingModeType
174 /// Iteratively box filter to generate an image of 1/2, 1/4, 1/8, etc. width and height and approximately the desired size. <br />
175 /// This is the default.
179 /// For each output pixel, read one input pixel.
183 /// For each output pixel, read a quad of four input pixels and write a weighted average of them.
187 /// Iteratively box filter to generate an image of 1/2, 1/4, 1/8, etc. width and height and approximately the desired size, <br />
188 /// then for each output pixel, read one pixel from the last level of box filtering.<br />
192 /// Iteratively box filter to almost the right size, then for each output pixel, read four pixels from the last level of box filtering and write their weighted average.
196 /// No filtering is performed. If the SCALE_TO_FILL scaling mode is enabled, the borders of the image may be trimmed to match the aspect ratio of the desired dimensions.
200 /// For caching algorithms where a client strongly prefers a cache-hit to reuse a cached image.
206 /// The type of coordinate system for certain attributes of the points in a gradient.
208 /// <since_tizen> 3 </since_tizen>
209 public enum GradientVisualUnitsType
212 /// Uses the normals for the start, end, and center points, i.e., top-left is (-0.5, -0.5) and bottom-right is (0.5, 0.5).
216 /// Uses the user coordinates for the start, end, and center points, i.e., in a 200 by 200 control, top-left is (0, 0) and bottom-right is (200, 200).
222 /// This specifies SpreadMethod types.<br />
223 /// SpreadMethod defines what happens if the gradient starts or ends inside the bounds of the target rectangle.<br />
225 /// <since_tizen> 3 </since_tizen>
226 public enum GradientVisualSpreadMethodType
229 /// Uses the terminal colors of the gradient to fill the remainder of the quad.
233 /// Reflects the gradient pattern start-to-end, end-to-start, start-to-end, etc. until the quad is filled.
237 /// Repeats the gradient pattern start-to-end, start-to-end, start-to-end, etc. until the quad is filled.
243 /// The shading mode used by the mesh visual.
245 /// <since_tizen> 3 </since_tizen>
246 public enum MeshVisualShadingModeValue
249 /// *Simplest*. One color that is lit by ambient and diffuse lighting.
251 TexturelessWithDiffuseLighting,
253 /// Uses only the visual image textures provided with specular lighting in addition to ambient and diffuse lighting.
255 TexturedWithSpecularLighting,
257 /// Uses all textures provided including gloss, normal, and texture map along with specular, ambient, and diffuse lighting.
259 TexturedWithDetailedSpecularLighting
263 /// The primitive shape to render as a primitive visual.
265 /// <since_tizen> 3 </since_tizen>
266 public enum PrimitiveVisualShapeType
269 /// A perfectly round geometrical object in the three-dimensional space.
273 /// The area bound between two circles, i.e., a cone with the tip removed.
277 /// Equivalent to a conical frustum with the top radius of zero.
278 /// </summary>Equivalent to a conical frustum with the top radius of zero.
281 /// Equivalent to a conical frustum with the top radius of zero.
285 /// Equivalent to a conical frustum with equal radii for the top and bottom circles.
289 /// Equivalent to a bevelled cube with a bevel percentage of zero.
293 /// Equivalent to a bevelled cube with a bevel percentage of one.
299 /// The values of this enum determine how the visual should fit into the view.
301 /// <since_tizen> 5 </since_tizen>
302 public enum VisualFittingModeType
305 /// The visual should be scaled to fit, preserving aspect ratio.
309 /// The visual should be stretched to fill, not preserving aspect ratio.
313 /// The visual should be scaled to fit, preserving aspect ratio. The visual will be filled without empty area, and outside is cropped away.
315 [EditorBrowsable(EditorBrowsableState.Never)]
316 OverFitKeepAspectRatio,
318 /// The visual should keep original size of image. it is not scaled and not stretched.
320 [EditorBrowsable(EditorBrowsableState.Never)]
323 /// The visual should be scaled to fit, preserving aspect ratio. Height is scaled proportionately to maintain aspect ratio.
325 [EditorBrowsable(EditorBrowsableState.Never)]
328 /// The visual should be scaled to fit, preserving aspect ratio. WIDTH is scaled proportionately to maintain aspect ratio.
330 [EditorBrowsable(EditorBrowsableState.Never)]
335 /// This specifies policy types that could be used by the transform for the offset or size.
337 /// <since_tizen> 3 </since_tizen>
338 public enum VisualTransformPolicyType
341 /// Relative to the control (percentage [0.0f to 1.0f] of the control).
345 /// Absolute value in world units.
351 /// This specifies all the transform property types.
353 /// <since_tizen> 3 </since_tizen>
354 public enum VisualTransformPropertyType
357 /// Offset of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units).
361 /// Size of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units).
365 /// The origin of the visual within its control area.
369 /// The anchor-point of the visual.
373 /// Whether the x or y offset values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
377 /// Whether the width or the height size values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
381 /// Extra size value that will be added to the computed visual size.
383 [EditorBrowsable(EditorBrowsableState.Never)]
388 /// This specifies visual types.
390 /// <since_tizen> 3 </since_tizen>
394 /// The index for the visual type.
396 /// <since_tizen> 3 </since_tizen>
400 /// Renders a solid color as an internal border to the control's quad.
404 /// Renders a solid color to the control's quad.
408 /// Renders a smooth transition of colors to the control's quad.
412 /// Renders an image into the control's quad.
416 /// Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file.
420 /// Renders a simple 3D shape, such as a cube or a sphere.
424 /// Renders a simple wire-frame outlining a quad.
432 /// Renders an NPatch image.
436 /// Renders an SVG image.
440 /// Renders a animated image (animated GIF).
444 /// Renders an animated gradient.
446 [EditorBrowsable(EditorBrowsableState.Never)]
447 AnimatedGradient = Visual.Type.AnimatedImage + 1,
449 /// Renders an animated vector image.
451 [EditorBrowsable(EditorBrowsableState.Never)]
452 AnimatedVectorImage = Visual.Type.AnimatedImage + 2,
456 [EditorBrowsable(EditorBrowsableState.Never)]
457 Arc = AnimatedImage + 3,
460 /// Keyword for invalid visual type. (NUI only)
462 [EditorBrowsable(EditorBrowsableState.Never)]
463 Invalid = Border - 1,
467 /// This specifies visual properties.
469 /// <since_tizen> 3 </since_tizen>
470 [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1716: Identifiers should not match keywords")]
471 public struct Property
476 /// <since_tizen> 3 </since_tizen>
477 public static readonly int Type = NDalic.VisualPropertyType;
481 /// <since_tizen> 3 </since_tizen>
482 public static readonly int Shader = NDalic.VisualPropertyShader;
486 /// <since_tizen> 3 </since_tizen>
487 public static readonly int Transform = NDalic.VisualPropertyTransform;
489 /// PremultipliedAlpha.
491 /// <since_tizen> 3 </since_tizen>
492 public static readonly int PremultipliedAlpha = NDalic.VisualPropertyPremultipliedAlpha;
496 /// <since_tizen> 3 </since_tizen>
497 public static readonly int MixColor = NDalic.VisualPropertyMixColor;
501 /// <since_tizen> 3 </since_tizen>
502 public static readonly int Opacity = NDalic.VisualPropertyMixColor + 1;
504 /// The fitting mode of the visual.
506 /// <since_tizen> 5 </since_tizen>
507 public static readonly int VisualFittingMode = NDalic.VisualPropertyMixColor + 2;
509 /// The corner radius of the visual.
511 [EditorBrowsable(EditorBrowsableState.Never)]
512 public static readonly int CornerRadius = NDalic.VisualPropertyMixColor + 3;
514 /// The corner radius policy of the visual.
515 /// Whether the corner radius value is relative (percentage [0.0f to 1.0f] of the visual size) or absolute (in world units).
517 [EditorBrowsable(EditorBrowsableState.Never)]
518 public static readonly int CornerRadiusPolicy = NDalic.VisualPropertyMixColor + 4;
520 /// The borderline width of the visual.
522 [EditorBrowsable(EditorBrowsableState.Never)]
523 public static readonly int BorderlineWidth = NDalic.VisualPropertyMixColor + 5;
525 /// The borderline color of the visual.
527 [EditorBrowsable(EditorBrowsableState.Never)]
528 public static readonly int BorderlineColor = NDalic.VisualPropertyMixColor + 6;
530 /// The borderline offset of the visual.
531 /// Relative position of borderline. (percentage [-1.0f to 1.0f]).
532 /// If -1.0f, borderline draw inside of visual
533 /// If 1.0f, borderline draw outside of visual
534 /// If 0.0f, half draw inside and half draw outside of visual
536 [EditorBrowsable(EditorBrowsableState.Never)]
537 public static readonly int BorderlineOffset = NDalic.VisualPropertyMixColor + 7;
541 /// This specifies shader properties.
543 /// <since_tizen> 3 </since_tizen>
544 public struct ShaderProperty
547 /// Vertex shader code
549 /// <since_tizen> 3 </since_tizen>
550 public static readonly int VertexShader = NDalic.VisualShaderVertex;
552 /// Fragment shader code
554 /// <since_tizen> 3 </since_tizen>
555 public static readonly int FragmentShader = NDalic.VisualShaderFragment;
557 /// How to subdivide the grid along X
559 /// <since_tizen> 3 </since_tizen>
560 public static readonly int ShaderSubdivideGridX = NDalic.VisualShaderSubdivideGridX;
562 /// How to subdivide the grid along Y
564 /// <since_tizen> 3 </since_tizen>
565 public static readonly int ShaderSubdivideGridY = NDalic.VisualShaderSubdivideGridY;
569 /// <since_tizen> 3 </since_tizen>
570 public static readonly int ShaderHints = NDalic.VisualShaderHints;
574 /// This specifies visual align types.
576 /// <since_tizen> 3 </since_tizen>
577 public enum AlignType
582 /// <since_tizen> 3 </since_tizen>
587 /// <since_tizen> 3 </since_tizen>
592 /// <since_tizen> 3 </since_tizen>
597 /// <since_tizen> 3 </since_tizen>
602 /// <since_tizen> 3 </since_tizen>
607 /// <since_tizen> 3 </since_tizen>
612 /// <since_tizen> 3 </since_tizen>
617 /// <since_tizen> 3 </since_tizen>
622 /// <since_tizen> 3 </since_tizen>
628 /// This specifies properties of the BorderVisual.
630 /// <since_tizen> 3 </since_tizen>
631 public struct BorderVisualProperty
634 /// The color of the border.
636 /// <since_tizen> 3 </since_tizen>
637 public static readonly int Color = NDalic.BorderVisualColor;
639 /// The width of the border (in pixels).
641 /// <since_tizen> 3 </since_tizen>
642 public static readonly int Size = NDalic.BorderVisualSize;
644 /// Whether anti-aliasing of the border is required.
646 /// <since_tizen> 3 </since_tizen>
647 public static readonly int AntiAliasing = NDalic.BorderVisualAntiAliasing;
651 /// This specifies properties of the ColorVisual.
653 /// <since_tizen> 3 </since_tizen>
654 public struct ColorVisualProperty
657 /// The solid color required.
659 /// <since_tizen> 3 </since_tizen>
660 public static readonly int MixColor = NDalic.ColorVisualMixColor;
662 /// Whether to render if the MixColor is transparent.
664 /// <since_tizen> 5 </since_tizen>
665 public static readonly int RenderIfTransparent = NDalic.ColorVisualMixColor + 1;
667 /// Then radius value for the area to blur.
669 [EditorBrowsable(EditorBrowsableState.Never)]
670 public static readonly int BlurRadius = NDalic.ColorVisualMixColor + 2;
674 /// This specifies properties of the GradientVisual.
676 /// <since_tizen> 3 </since_tizen>
677 public struct GradientVisualProperty
680 /// The start position of a linear gradient.
682 /// <since_tizen> 3 </since_tizen>
683 public static readonly int StartPosition = NDalic.GradientVisualStartPosition;
685 /// The end position of a linear gradient.
687 /// <since_tizen> 3 </since_tizen>
688 public static readonly int EndPosition = NDalic.GradientVisualEndPosition;
690 /// The center point of a radial gradient.
692 /// <since_tizen> 3 </since_tizen>
693 public static readonly int Center = NDalic.GradientVisualCenter;
695 /// The size of the radius of a radial gradient.
697 /// <since_tizen> 3 </since_tizen>
698 public static readonly int Radius = NDalic.GradientVisualRadius;
700 /// All the stop offsets.
702 /// <since_tizen> 3 </since_tizen>
703 public static readonly int StopOffset = NDalic.GradientVisualStopOffset;
705 /// The color at the stop offsets.
707 /// <since_tizen> 3 </since_tizen>
708 public static readonly int StopColor = NDalic.GradientVisualStopColor;
710 /// Defines the coordinate system for certain attributes of the points in a gradient.
712 /// <since_tizen> 3 </since_tizen>
713 public static readonly int Units = NDalic.GradientVisualUnits;
715 /// Indicates what happens if the gradient starts or ends inside the bounds of the target rectangle.
717 /// <since_tizen> 3 </since_tizen>
718 public static readonly int SpreadMethod = NDalic.GradientVisualSpreadMethod;
722 /// This specifies properties of the ImageVisual.
724 /// <since_tizen> 3 </since_tizen>
725 public struct ImageVisualProperty
728 /// The URL of the image.
730 /// <since_tizen> 3 </since_tizen>
731 public static readonly int URL = NDalic.ImageVisualUrl;
734 /// Fitting options, used when resizing images to fit desired dimensions.
736 /// <since_tizen> 3 </since_tizen>
737 public static readonly int FittingMode = NDalic.ImageVisualFittingMode;
740 /// Filtering options, used when resizing images to sample original pixels.
742 /// <since_tizen> 3 </since_tizen>
743 public static readonly int SamplingMode = NDalic.ImageVisualSamplingMode;
746 /// The desired image width.
748 /// <since_tizen> 3 </since_tizen>
749 public static readonly int DesiredWidth = NDalic.ImageVisualDesiredWidth;
752 /// The desired image height.
754 /// <since_tizen> 3 </since_tizen>
755 public static readonly int DesiredHeight = NDalic.ImageVisualDesiredHeight;
758 /// Whether to load the image synchronously.
760 /// <since_tizen> 3 </since_tizen>
761 public static readonly int SynchronousLoading = NDalic.ImageVisualSynchronousLoading;
764 /// If true, only draws the borders.
766 /// <since_tizen> 3 </since_tizen>
767 public static readonly int BorderOnly = NDalic.ImageVisualBorderOnly;
770 /// The image area to be displayed.
772 /// <since_tizen> 3 </since_tizen>
773 public static readonly int PixelArea = NDalic.ImageVisualPixelArea;
776 /// The wrap mode for u coordinate.
778 /// <since_tizen> 3 </since_tizen>
779 public static readonly int WrapModeU = NDalic.ImageVisualWrapModeU;
782 /// The wrap mode for v coordinate.
784 /// <since_tizen> 3 </since_tizen>
785 public static readonly int WrapModeV = NDalic.ImageVisualWrapModeV;
788 /// The border of the image.
790 /// <since_tizen> 3 </since_tizen>
791 public static readonly int Border = NDalic.ImageVisualBorder;
794 /// Whether to use the texture atlas.
796 /// <since_tizen> 5 </since_tizen>
797 public static readonly int Atlasing = NDalic.ImageVisualBorder + 1;
800 /// The URL of the alpha mask image.
802 /// <since_tizen> 3 </since_tizen>
803 public static readonly int AlphaMaskURL = NDalic.ImageVisualAlphaMaskUrl;
806 /// Defines the batch size for pre-loading images in the AnimatedImageVisual
808 /// <since_tizen> 4 </since_tizen>
809 public static readonly int BatchSize = NDalic.ImageVisualBatchSize;
812 /// Defines the cache size for loading images in the AnimatedImageVisual
814 /// <since_tizen> 4 </since_tizen>
815 public static readonly int CacheSize = NDalic.ImageVisualCacheSize;
818 /// The number of milliseconds between each frame in the AnimatedImageVisual
820 /// <since_tizen> 4 </since_tizen>
821 public static readonly int FrameDelay = NDalic.ImageVisualFrameDelay;
824 /// The scale factor to apply to the content image before masking.
826 /// <since_tizen> 4 </since_tizen>
827 public static readonly int MaskContentScale = NDalic.ImageVisualMaskContentScale;
830 /// Whether to crop image to mask or scale mask to fit image
832 /// <since_tizen> 4 </since_tizen>
833 public static readonly int CropToMask = NDalic.ImageVisualCropToMask;
836 /// The policy to determine when an image should be loaded.
838 /// <since_tizen> 5 </since_tizen>
839 public static readonly int LoadPolicy = NDalic.ImageVisualLoadPolicy;
842 /// The policy to determine when an image should no longer be cached.
844 /// <since_tizen> 5 </since_tizen>
845 public static readonly int ReleasePolicy = NDalic.ImageVisualReleasePolicy;
848 /// Determines if image orientation should be corrected so that the image displays as it was intended.
850 /// <since_tizen> 5 </since_tizen>
851 public static readonly int OrientationCorrection = NDalic.ImageVisualOrientationCorrection;
854 /// Overlays the auxiliary image on top of an NPatch image.
856 /// <since_tizen> 5 </since_tizen>
857 public static readonly int AuxiliaryImageURL = NDalic.ImageVisualAuxiliaryImageUrl;
860 /// Alpha value for the auxiliary image, without affecting the underlying NPatch image
862 /// <since_tizen> 5 </since_tizen>
863 public static readonly int AuxiliaryImageAlpha = NDalic.ImageVisualAuxiliaryImageAlpha;
866 /// The number of times the AnimatedImageVisual will be looped.
867 /// The default is -1. If the value is less than 0, loop unlimited. Otherwise, loop loopCount times.
869 /// <since_tizen> 5 </since_tizen>
870 public static readonly int LoopCount = NDalic.ImageVisualLoopCount;
873 /// @brief The playing range the AnimatedVectorImageVisual will use.
874 /// Animation will play between the values specified.The array can only have two values, and more will be ignored.
875 /// Both values should be between 0 and the total frame number, otherwise they will be ignored.
876 /// If the range provided is not in proper order (minimum, maximum), it will be reordered.
877 /// @details Name "playRange", Type Property::ARRAY of Property::INTEGER
878 /// @note Default 0 and the total frame number.
881 /// Hidden API (Inhouse API)
883 [EditorBrowsable(EditorBrowsableState.Never)]
884 public static readonly int PlayRange = NDalic.ImageVisualOrientationCorrection + 4;
887 /// @brief The playing state the AnimatedVectorImageVisual will use.
888 /// @details Name "playState", type PlayState (Property::INTEGER)
889 /// @note This property is read-only.
892 /// Hidden API (Inhouse API)
894 [EditorBrowsable(EditorBrowsableState.Never)]
895 public static readonly int PlayState = NDalic.ImageVisualOrientationCorrection + 5;
898 /// @brief The current frame number the AnimatedVectorImageVisual will use.
899 /// @details Name "currentFrameNumber", Type Property::INTEGER, between[0, the maximum frame number] or between the play range if specified
900 /// @note This property is read-only.
905 [EditorBrowsable(EditorBrowsableState.Never)]
906 public static readonly int CurrentFrameNumber = NDalic.ImageVisualOrientationCorrection + 6;
909 /// @brief The total frame number the AnimatedVectorImageVisual will use.
910 /// @details Name "totalFrameNumber", Type Property::INTEGER.
911 /// @note This property is read-only.
916 [EditorBrowsable(EditorBrowsableState.Never)]
917 public static readonly int TotalFrameNumber = NDalic.ImageVisualOrientationCorrection + 7;
920 /// @brief The stop behavior the AnimatedVectorImageVisual will use.
921 /// @details Name "stopBehavior", Type StopBehavior::Type (Property::INTEGER)
922 /// @note Default value is StopBehavior::CURRENT_FRAME.
927 [EditorBrowsable(EditorBrowsableState.Never)]
928 public static readonly int StopBehavior = NDalic.ImageVisualOrientationCorrection + 8;
931 /// @brief The looping mode the AnimatedVectorImageVisual will use.
932 /// @details Name "loopingMode", Type LoopingMode::Type (Property::INTEGER)
933 /// @note Default value is LoopingMode::RESTART.
938 [EditorBrowsable(EditorBrowsableState.Never)]
939 public static readonly int LoopingMode = NDalic.ImageVisualOrientationCorrection + 9;
942 /// @brief The content information the AnimatedVectorImageVisual will use.
943 /// @details Name "contentInfo", Type Property::MAP.
944 /// The map contains the layer name as a key and Property::Array as a value.
945 /// And the array contains 2 integer values which are the frame numbers, the start frame number and the end frame number of the layer.
946 /// @note This property is read-only.
951 [EditorBrowsable(EditorBrowsableState.Never)]
952 public static readonly int ContentInfo = NDalic.ImageVisualOrientationCorrection + 10;
955 /// @brief Whether to redraw the image when the visual is scaled down.
956 /// @details Name "redrawInScalingDown", type Property::BOOLEAN.
957 /// @note It is used in the AnimatedVectorImageVisual.The default is true.
962 [EditorBrowsable(EditorBrowsableState.Never)]
963 public static readonly int RedrawInScalingDown = NDalic.ImageVisualOrientationCorrection + 11;
966 /// @brief Whether to apply mask on the GPU or not.
967 /// @details Name "MaskingMode", type MaskingModeType (Property::INTEGER).
968 /// @note It is used in the ImageVisual, and AnimatedImageVisual.The default is MaskingOnLoading.
970 [EditorBrowsable(EditorBrowsableState.Never)]
971 public static readonly int MaskingMode = NDalic.ImageVisualOrientationCorrection + 12;
974 /// @brief Whether to uploading texture before ResourceReady signal emit or after texture load completed time.
975 /// @details Name "fastTrackUploading", type Property::BOOLEAN.
976 /// @note It is used in the ImageVisual. The default is false.
978 [EditorBrowsable(EditorBrowsableState.Never)]
979 public static readonly int FastTrackUploading = NDalic.ImageVisualOrientationCorrection + 13;
982 /// @brief The marker information the AnimatedVectorImageVisual will use.
983 /// @details Type Property::MAP.
984 /// The map contains the marker name as a key and Property::Array as a value.
985 /// And the array contains 2 integer values which are the frame numbers, the start frame number and the end frame number of the marker.
986 /// @note This property is read-only.
988 [EditorBrowsable(EditorBrowsableState.Never)]
989 public static readonly int MarkerInfo = NDalic.ImageVisualOrientationCorrection + 15;
993 /// This specifies properties of the MeshVisual.
995 /// <since_tizen> 3 </since_tizen>
996 public struct MeshVisualProperty
999 /// The location of the ".obj" file.
1001 /// <since_tizen> 3 </since_tizen>
1002 public static readonly int ObjectURL = NDalic.MeshVisualObjectUrl;
1004 /// The location of the ".mtl" file.
1006 [EditorBrowsable(EditorBrowsableState.Never)]
1007 public static readonly int MaterialURL = NDalic.MeshVisualMaterialUrl;
1009 /// The location of the ".mtl" file.
1011 /// <since_tizen> 3 </since_tizen>
1012 public static readonly int MaterialtURL = NDalic.MeshVisualMaterialUrl;
1014 /// Path to the directory the textures (including gloss and normal) are stored in.
1016 /// <since_tizen> 3 </since_tizen>
1017 public static readonly int TexturesPath = NDalic.MeshVisualTexturesPath;
1019 /// Sets the type of shading mode that the mesh will use.
1021 /// <since_tizen> 3 </since_tizen>
1022 public static readonly int ShadingMode = NDalic.MeshVisualShadingMode;
1024 /// Whether to use mipmaps for textures or not.
1026 /// <since_tizen> 3 </since_tizen>
1027 public static readonly int UseMipmapping = NDalic.MeshVisualUseMipmapping;
1029 /// Whether to average normals at each point to smooth textures or not.
1031 /// <since_tizen> 3 </since_tizen>
1032 public static readonly int UseSoftNormals = NDalic.MeshVisualUseSoftNormals;
1034 /// The position, in stage space, of the point light that applies lighting to the model.
1036 /// <since_tizen> 3 </since_tizen>
1037 public static readonly int LightPosition = NDalic.MeshVisualLightPosition;
1041 /// This specifies properties of the PrimitiveVisual.
1043 /// <since_tizen> 3 </since_tizen>
1044 public struct PrimitiveVisualProperty
1047 /// The specific shape to render.
1049 /// <since_tizen> 3 </since_tizen>
1050 public static readonly int Shape = NDalic.PrimitiveVisualShape;
1052 /// The color of the shape.
1054 /// <since_tizen> 3 </since_tizen>
1055 public static readonly int MixColor = NDalic.PrimitiveVisualMixColor;
1057 /// The number of slices as you go around the shape.
1059 /// <since_tizen> 3 </since_tizen>
1060 public static readonly int Slices = NDalic.PrimitiveVisualSlices;
1062 /// The number of stacks as you go down the shape.
1064 /// <since_tizen> 3 </since_tizen>
1065 public static readonly int Stacks = NDalic.PrimitiveVisualStacks;
1067 /// The scale of the radius of the top circle of a conical frustum.
1069 /// <since_tizen> 3 </since_tizen>
1070 public static readonly int ScaleTopRadius = NDalic.PrimitiveVisualScaleTopRadius;
1072 /// The scale of the radius of the bottom circle of a conical frustum.
1074 /// <since_tizen> 3 </since_tizen>
1075 public static readonly int ScaleBottomRadius = NDalic.PrimitiveVisualScaleBottomRadius;
1077 /// The scale of the height of a conic.
1079 /// <since_tizen> 3 </since_tizen>
1080 public static readonly int ScaleHeight = NDalic.PrimitiveVisualScaleHeight;
1082 /// The scale of the radius of a cylinder.
1084 /// <since_tizen> 3 </since_tizen>
1085 public static readonly int ScaleRadius = NDalic.PrimitiveVisualScaleRadius;
1087 /// The dimensions of a cuboid. Scales in the same fashion as a 9-patch image.
1089 /// <since_tizen> 3 </since_tizen>
1090 public static readonly int ScaleDimensions = NDalic.PrimitiveVisualScaleDimensions;
1092 /// Determines how bevelled the cuboid should be, based off the smallest dimension.
1094 /// <since_tizen> 3 </since_tizen>
1095 public static readonly int BevelPercentage = NDalic.PrimitiveVisualBevelPercentage;
1097 /// Defines how smooth the bevelled edges should be.
1099 /// <since_tizen> 3 </since_tizen>
1100 public static readonly int BevelSmoothness = NDalic.PrimitiveVisualBevelSmoothness;
1102 /// The position, in stage space, of the point light that applies lighting to the model.
1104 /// <since_tizen> 3 </since_tizen>
1105 public static readonly int LightPosition = NDalic.PrimitiveVisualLightPosition;
1109 /// This specifies properties of the TextVisual.
1111 /// <since_tizen> 3 </since_tizen>
1112 public struct TextVisualProperty
1115 /// The text to display in UTF-8 format.
1117 /// <since_tizen> 3 </since_tizen>
1118 public static readonly int Text = NDalic.TextVisualText;
1120 /// The requested font family to use.
1122 /// <since_tizen> 3 </since_tizen>
1123 public static readonly int FontFamily = NDalic.TextVisualFontFamily;
1125 /// The requested font style to use.
1127 /// <since_tizen> 3 </since_tizen>
1128 public static readonly int FontStyle = NDalic.TextVisualFontStyle;
1130 /// The size of font in points.
1132 /// <since_tizen> 3 </since_tizen>
1133 public static readonly int PointSize = NDalic.TextVisualPointSize;
1135 /// The single-line or multi-line layout option.
1137 /// <since_tizen> 3 </since_tizen>
1138 public static readonly int MultiLine = NDalic.TextVisualMultiLine;
1140 /// The line horizontal alignment.
1142 /// <since_tizen> 3 </since_tizen>
1143 public static readonly int HorizontalAlignment = NDalic.TextVisualHorizontalAlignment;
1145 /// The line vertical alignment.
1147 /// <since_tizen> 3 </since_tizen>
1148 public static readonly int VerticalAlignment = NDalic.TextVisualVerticalAlignment;
1150 /// The color of the text.
1152 /// <since_tizen> 3 </since_tizen>
1153 public static readonly int TextColor = NDalic.TextVisualTextColor;
1155 /// Whether the mark-up processing is enabled.
1157 /// <since_tizen> 3 </since_tizen>
1158 public static readonly int EnableMarkup = NDalic.TextVisualEnableMarkup;
1160 /// The shadow parameters.
1162 /// <since_tizen> 5 </since_tizen>
1163 public static readonly int Shadow = NDalic.TextVisualEnableMarkup + 1;
1165 /// The default underline parameters.
1167 /// <since_tizen> 5 </since_tizen>
1168 public static readonly int Underline = NDalic.TextVisualEnableMarkup + 2;
1170 /// The default outline parameters.
1172 /// <since_tizen> 5 </since_tizen>
1173 public static readonly int Outline = NDalic.TextVisualEnableMarkup + 3;
1175 /// The default text background parameters.
1177 /// <since_tizen> 5 </since_tizen>
1178 public static readonly int Background = NDalic.TextVisualEnableMarkup + 4;
1182 /// This specifies properties of the NpatchImageVisual.
1184 /// <since_tizen> 3 </since_tizen>
1185 public struct NpatchImageVisualProperty
1188 /// The URL of the image.
1190 /// <since_tizen> 3 </since_tizen>
1191 public static readonly int URL = NDalic.ImageVisualUrl;
1193 /// Fitting options, used when resizing images to fit desired dimensions.
1195 /// <since_tizen> 3 </since_tizen>
1196 public static readonly int FittingMode = NDalic.ImageVisualFittingMode;
1198 /// Filtering options, used when resizing images to sample original pixels.
1200 /// <since_tizen> 3 </since_tizen>
1201 public static readonly int SamplingMode = NDalic.ImageVisualSamplingMode;
1203 /// The desired image width.
1205 /// <since_tizen> 3 </since_tizen>
1206 public static readonly int DesiredWidth = NDalic.ImageVisualDesiredWidth;
1208 /// The desired image height.
1210 /// <since_tizen> 3 </since_tizen>
1211 public static readonly int DesiredHeight = NDalic.ImageVisualDesiredHeight;
1213 /// Whether to load the image synchronously.
1215 /// <since_tizen> 3 </since_tizen>
1216 public static readonly int SynchronousLoading = NDalic.ImageVisualSynchronousLoading;
1218 /// If true, only draws the borders.
1220 /// <since_tizen> 3 </since_tizen>
1221 public static readonly int BorderOnly = NDalic.ImageVisualBorderOnly;
1223 /// The image area to be displayed.
1225 /// <since_tizen> 3 </since_tizen>
1226 public static readonly int PixelArea = NDalic.ImageVisualPixelArea;
1228 /// The wrap mode for u coordinate.
1230 /// <since_tizen> 3 </since_tizen>
1231 public static readonly int WrapModeU = NDalic.ImageVisualWrapModeU;
1233 /// The wrap mode for v coordinate.
1235 /// <since_tizen> 3 </since_tizen>
1236 public static readonly int WrapModeV = NDalic.ImageVisualWrapModeV;
1238 /// The border of the image.
1240 /// <since_tizen> 3 </since_tizen>
1241 public static readonly int Border = NDalic.ImageVisualWrapModeV + 1;
1245 /// This specifies properties of the ArcVisual.
1247 internal struct ArcVisualProperty
1250 /// The thickness of the arc.
1252 /// <remarks>The value is float type.</remarks>
1253 /// <remarks>This is mandatory property.</remarks>
1254 internal static readonly int Thickness = NDalic.ImageVisualUrl;
1257 /// The start angle where the arc begins in degrees.
1259 /// <remarks>The value is float type.</remarks>
1260 /// <remarks>The property of optional. The default value is 0.</remarks>
1261 internal static readonly int StartAngle = Thickness + 1;
1264 /// The sweep angle of the arc in degrees.
1266 /// <remarks>The value is float type.</remarks>
1267 /// <remarks>The property of optional. The default value is 360.</remarks>
1268 internal static readonly int SweepAngle = Thickness + 2;
1271 /// The cap style of the arc.
1274 /// The value is integer type.
1275 /// The value 0 means butt, the arc does not extend beyond its two endpoints.
1276 /// The value 1 means round, the arc will be extended by a half circle with the center at the end.
1278 /// <remarks>The property of optional. The default value is 0 (butt).</remarks>
1279 internal static readonly int Cap = Thickness + 3;
1283 /// Enumeration for Circular alignment.
1284 /// The @p horizontalAlignment and @p verticalAlignment can be used to align the text within the text area.
1286 [EditorBrowsable(EditorBrowsableState.Never)]
1287 public enum CircularAlignment
1290 /// Texts place at the begin of Circular direction.
1292 [Description("BEGIN")]
1295 /// Texts place at the center of Circular direction.
1297 [Description("CENTER")]
1300 /// Texts place at the end of Circular direction.
1302 [Description("END")]
1307 /// Enumeration for Text Layout.
1309 [EditorBrowsable(EditorBrowsableState.Never)]
1310 public enum TextLayout
1315 [Description("singleLine")]
1320 [Description("multiLine")]
1325 [Description("circular")]
1330 /// Defines how a color is blended.
1332 /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API.
1333 [EditorBrowsable(EditorBrowsableState.Never)]
1334 public enum ColorBlendingMode
1341 /// The color is multiplied by another one.