summaryrefslogtreecommitdiff
path: root/docs/Xamarin.Forms.Core
diff options
context:
space:
mode:
authorMike Norman <mknorman@gmail.com>2017-07-24 20:31:47 (GMT)
committerStephane Delcroix <stephane@delcroix.org>2017-07-24 20:31:47 (GMT)
commitb12f0b3bb71dfa22ac91d0d07463a7da7646e049 (patch)
treeff8bcabb72c7bd232f6b7695af00957cfdf7d855 /docs/Xamarin.Forms.Core
parent56fc6218fff87b6b22c6b2ff3856972e891c7a01 (diff)
downloadxamarin-forms-b12f0b3bb71dfa22ac91d0d07463a7da7646e049.zip
xamarin-forms-b12f0b3bb71dfa22ac91d0d07463a7da7646e049.tar.gz
xamarin-forms-b12f0b3bb71dfa22ac91d0d07463a7da7646e049.tar.bz2
Improved the API doc for Image.IsOpaque (#1025)
* Improved the API doc for Image.IsOpaque * update docs
Diffstat (limited to 'docs/Xamarin.Forms.Core')
-rw-r--r--docs/Xamarin.Forms.Core/Xamarin.Forms/Image.xml11
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Image.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Image.xml
index bee5933..cbc6281 100644
--- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Image.xml
+++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Image.xml
@@ -192,9 +192,12 @@ indicator.BindingContext = image;]]></code>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
- <summary>Gets or sets the opacity flag for the image. This is a bindable property.</summary>
- <value>A <see cref="T:System.Boolean" /> indicating the value for the property. Default is false.</value>
- <remarks>If true, you'll be able to see through transparent parts of the image.</remarks>
+ <summary>Gets or sets a Boolean value that, if <see langword="true" /> hints to the rendering engine that it may safely omit drawing visual elements behind the image.</summary>
+ <value>The value of the opacity rendering hint.</value>
+ <remarks>
+ <para>When this property is <see langword="true" />, and if the <see cref="P:Xamarin.Forms.Image.Opacity" /> property is set to its default value of <c>1.0</c>, and if the source image is not transparent, then the rendering engine on the target platform can safely ignore those portions of visual elements that appear behind this image when drawing the screen. This can improve performance. However, developers should not set this property to <see langword="true" /> if the alpha channel of the image indicates transparency, if the <see cref="P:Xamarin.Forms.Image.Opacity" /> property is less than <c>1.0</c>, or if the source image itself is transparent. Doing any of these when this property is <see langword="true" /> may result in visual artifacts or other (undefined) behavior. Conversely, developers should ensure that this property is set to <see langword="false" /> if they suspect or know that any of the previously mentioned conditions may indicate that the image will be transparent or partially transparent.</para>
+ <para>Setting this property does not change the opacity of the image. Instead, it indicates whether the rendering engine may treat the image as opaque while rendering.</para>
+ </remarks>
</Docs>
</Member>
<Member MemberName="IsOpaqueProperty">
@@ -214,7 +217,7 @@ indicator.BindingContext = image;]]></code>
<ReturnType>Xamarin.Forms.BindableProperty</ReturnType>
</ReturnValue>
<Docs>
- <summary>Identifies the IsOpaque bindable property.</summary>
+ <summary>Backing store for the IsOpaque bindable property.</summary>
<remarks>
</remarks>
</Docs>