Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
951 lines (898 sloc) 63.6 KB
<Type Name="BitmapSource" FullName="System.Windows.Media.Imaging.BitmapSource">
<TypeSignature Language="C#" Value="public abstract class BitmapSource : System.Windows.Media.ImageSource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit BitmapSource extends System.Windows.Media.ImageSource" />
<TypeSignature Language="DocId" Value="T:System.Windows.Media.Imaging.BitmapSource" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class BitmapSource&#xA;Inherits ImageSource" />
<TypeSignature Language="C++ CLI" Value="public ref class BitmapSource abstract : System::Windows::Media::ImageSource" />
<TypeSignature Language="F#" Value="type BitmapSource = class&#xA; inherit ImageSource&#xA; interface DUCE.IResource" />
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Windows.Media.ImageSource</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Windows.Localizability(System.Windows.LocalizationCategory.None, Readability=System.Windows.Readability.Unreadable)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a single, constant set of pixels at a certain size and resolution.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Windows.Media.Imaging.BitmapSource> is the basic building block of the [!INCLUDE[TLA#tla_winclient](~/includes/tlasharptla-winclient-md.md)] imaging pipeline, conceptually representing a single, constant set of pixels at a certain size and resolution. A <xref:System.Windows.Media.Imaging.BitmapSource> could be a single frame in an image file that a decoder provides, or it could be the result of a transform that operates on a <xref:System.Windows.Media.Imaging.BitmapSource> of its own. <xref:System.Windows.Media.Imaging.BitmapSource> is not used to represent a multi-frame image or an animation.
[!INCLUDE[TLA#tla_winclient](~/includes/tlasharptla-winclient-md.md)] natively supports compression and decompression of [!INCLUDE[TLA#tla_bmp](~/includes/tlasharptla-bmp-md.md)], [!INCLUDE[TLA#tla_gif](~/includes/tlasharptla-gif-md.md)], [!INCLUDE[TLA#tla_jpegorg](~/includes/tlasharptla-jpegorg-md.md)], [!INCLUDE[TLA#tla_png](~/includes/tlasharptla-png-md.md)], and [!INCLUDE[TLA#tla_tiff](~/includes/tlasharptla-tiff-md.md)] images.
For bitmap decoding scenarios, <xref:System.Windows.Media.Imaging.BitmapSource> uses automatic codec discovery, based on the installed codecs on the user's system.
The maximum height and width of an image is 2^16 pixels at 32 bits per channel * 4 channels. The maximum size of a <xref:System.Windows.Media.Imaging.BitmapSource> is 2^32 bytes (64 gigabytes) and the maximum image size is four gigapixels. The minimum image size is 1x1.
## Examples
The following code example demonstrates how to create a <xref:System.Windows.Media.Imaging.BitmapSource> and use it as the source of an <xref:System.Windows.Controls.Image> control.
[!code-csharp[imagingsnippetgallery_procedural_snip#BitmapSourceCreate](~/samples/snippets/csharp/VS_Snippets_Wpf/ImagingSnippetGallery_procedural_snip/CSharp/BitmapSourceExample.cs#bitmapsourcecreate)]
[!code-vb[imagingsnippetgallery_procedural_snip#BitmapSourceCreate](~/samples/snippets/visualbasic/VS_Snippets_Wpf/ImagingSnippetGallery_procedural_snip/VB/BitmapSourceExample.vb#bitmapsourcecreate)]
The following code example uses a <xref:System.Windows.Media.Imaging.BitmapSource> derived class, <xref:System.Windows.Media.Imaging.BitmapImage>, to create a bitmap from an image file and use it as the source of an <xref:System.Windows.Controls.Image> control.
[!code-csharp[imageelementexample#SimpleCSharp1](~/samples/snippets/csharp/VS_Snippets_Wpf/ImageElementExample/CSharp/SimpleImageExample.xaml.cs#simplecsharp1)]
[!code-vb[imageelementexample#SimpleCSharp1](~/samples/snippets/visualbasic/VS_Snippets_Wpf/ImageElementExample/VB/SimpleImageExample.xaml.vb#simplecsharp1)]
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Imaging.BitmapImage" />
<related type="ExternalDocumentation" href="https://msdn.microsoft.com/library/windows/desktop/ee719902(v=vs.85).aspx">Microsoft Windows Imaging Component</related>
<related type="ExternalDocumentation" href="https://msdn.microsoft.com/library/windows/desktop/ee690171(v=vs.85).aspx">IWCBitmapSource</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected BitmapSource ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; BitmapSource();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netcore-3.0">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netcore-3.0">
<AttributeName>System.Security.SecurityTreatAsSafe</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CheckIfSiteOfOrigin">
<MemberSignature Language="C#" Value="protected void CheckIfSiteOfOrigin ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void CheckIfSiteOfOrigin() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.CheckIfSiteOfOrigin" />
<MemberSignature Language="VB.NET" Value="Protected Sub CheckIfSiteOfOrigin ()" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; void CheckIfSiteOfOrigin();" />
<MemberSignature Language="F#" Value="member this.CheckIfSiteOfOrigin : unit -&gt; unit" Usage="bitmapSource.CheckIfSiteOfOrigin " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netcore-3.0">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netcore-3.0">
<AttributeName>System.Security.SecurityTreatAsSafe</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Checks whether the bitmap source content is from a known site of origin. This method is used to make sure that pixel copying operations are safe.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method only succeeds if it is passed a <xref:System.Uri> that is from a site of origin or that is defined in a `pack:`. In all other conditions, this method will fail.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public System.Windows.Media.Imaging.BitmapSource Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Media.Imaging.BitmapSource Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.Clone" />
<MemberSignature Language="VB.NET" Value="Public Function Clone () As BitmapSource" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Windows::Media::Imaging::BitmapSource ^ Clone();" />
<MemberSignature Language="F#" Value="override this.Clone : unit -&gt; System.Windows.Media.Imaging.BitmapSource" Usage="bitmapSource.Clone " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.Imaging.BitmapSource</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a modifiable clone of this <see cref="T:System.Windows.Media.Imaging.BitmapSource" />, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.</summary>
<returns>A modifiable clone of the current object. The cloned object's <see cref="P:System.Windows.Freezable.IsFrozen" /> property will be <see langword="false" /> even if the source's <see cref="P:System.Windows.Freezable.IsFrozen" /> property was <see langword="true." /></returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is used to produce modifiable copies of frozen <xref:System.Windows.Freezable> objects (or any <xref:System.Windows.Freezable> object). For convenience, this method shadows the inherited version with a strongly typed implementation.
For more information, see <xref:System.Windows.Freezable.Clone%2A?displayProperty=nameWithType>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CloneCore">
<MemberSignature Language="C#" Value="protected override void CloneCore (System.Windows.Freezable sourceFreezable);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void CloneCore(class System.Windows.Freezable sourceFreezable) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.CloneCore(System.Windows.Freezable)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub CloneCore (sourceFreezable As Freezable)" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; override void CloneCore(System::Windows::Freezable ^ sourceFreezable);" />
<MemberSignature Language="F#" Value="override this.CloneCore : System.Windows.Freezable -&gt; unit" Usage="bitmapSource.CloneCore sourceFreezable" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceFreezable" Type="System.Windows.Freezable" />
</Parameters>
<Docs>
<param name="sourceFreezable">The <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> to clone.</param>
<summary>Makes this instance a deep copy of the specified <see cref="T:System.Windows.Media.Imaging.BitmapSource" />. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is called by the <xref:System.Windows.Freezable.Clone%2A> method and should not be called directly from your code, except when you call the base implementation while overriding this method. To create a modifiable copy of the current object, call <xref:System.Windows.Freezable.Clone%2A> instead of calling this method directly.
For more information, see <xref:System.Windows.Freezable.CloneCore%2A?displayProperty=nameWithType>.
]]></format>
</remarks>
<altmember cref="M:System.Windows.Freezable.CloneCore(System.Windows.Freezable)" />
</Docs>
</Member>
<Member MemberName="CloneCurrentValue">
<MemberSignature Language="C#" Value="public System.Windows.Media.Imaging.BitmapSource CloneCurrentValue ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Media.Imaging.BitmapSource CloneCurrentValue() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.CloneCurrentValue" />
<MemberSignature Language="VB.NET" Value="Public Function CloneCurrentValue () As BitmapSource" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Windows::Media::Imaging::BitmapSource ^ CloneCurrentValue();" />
<MemberSignature Language="F#" Value="override this.CloneCurrentValue : unit -&gt; System.Windows.Media.Imaging.BitmapSource" Usage="bitmapSource.CloneCurrentValue " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.Imaging.BitmapSource</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a modifiable clone of this <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.</summary>
<returns>A modifiable clone of the current object. The cloned object's <see cref="P:System.Windows.Freezable.IsFrozen" /> property will be <see langword="false" /> even if the source's <see cref="P:System.Windows.Freezable.IsFrozen" /> property was <see langword="true" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is used to produce modifiable copies of frozen <xref:System.Windows.Freezable> objects (or any <xref:System.Windows.Freezable> object). For convenience, this method shadows the inherited version with a strongly typed implementation.
For more information, see <xref:System.Windows.Freezable.CloneCurrentValue%2A?displayProperty=nameWithType>.
]]></format>
</remarks>
<altmember cref="M:System.Windows.Freezable.CloneCurrentValue" />
</Docs>
</Member>
<Member MemberName="CloneCurrentValueCore">
<MemberSignature Language="C#" Value="protected override void CloneCurrentValueCore (System.Windows.Freezable sourceFreezable);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void CloneCurrentValueCore(class System.Windows.Freezable sourceFreezable) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.CloneCurrentValueCore(System.Windows.Freezable)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub CloneCurrentValueCore (sourceFreezable As Freezable)" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; override void CloneCurrentValueCore(System::Windows::Freezable ^ sourceFreezable);" />
<MemberSignature Language="F#" Value="override this.CloneCurrentValueCore : System.Windows.Freezable -&gt; unit" Usage="bitmapSource.CloneCurrentValueCore sourceFreezable" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceFreezable" Type="System.Windows.Freezable" />
</Parameters>
<Docs>
<param name="sourceFreezable">The <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> to clone.</param>
<summary>Makes this instance a modifiable deep copy of the specified <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> using current property values. Resource references, data bindings, and animations are not copied, but their current values are.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is called by the <xref:System.Windows.Freezable.CloneCurrentValue%2A> method and should not be called directly from your code, except when you call the base implementation while overriding this method. To create a modifiable copy of the current object, call <xref:System.Windows.Freezable.CloneCurrentValue%2A> instead of calling this method directly.
For more information, see <xref:System.Windows.Freezable.CloneCurrentValueCore%2A?displayProperty=nameWithType>.
]]></format>
</remarks>
<altmember cref="M:System.Windows.Freezable.CloneCurrentValueCore(System.Windows.Freezable)" />
</Docs>
</Member>
<MemberGroup MemberName="CopyPixels">
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Copies the bitmap pixel data.</summary>
</Docs>
</MemberGroup>
<Member MemberName="CopyPixels">
<MemberSignature Language="C#" Value="public virtual void CopyPixels (Array pixels, int stride, int offset);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void CopyPixels(class System.Array pixels, int32 stride, int32 offset) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.CopyPixels(System.Array,System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub CopyPixels (pixels As Array, stride As Integer, offset As Integer)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual void CopyPixels(Array ^ pixels, int stride, int offset);" />
<MemberSignature Language="F#" Value="abstract member CopyPixels : Array * int * int -&gt; unit&#xA;override this.CopyPixels : Array * int * int -&gt; unit" Usage="bitmapSource.CopyPixels (pixels, stride, offset)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netcore-3.0">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pixels" Type="System.Array" />
<Parameter Name="stride" Type="System.Int32" />
<Parameter Name="offset" Type="System.Int32" />
</Parameters>
<Docs>
<param name="pixels">The destination array.</param>
<param name="stride">The stride of the bitmap.</param>
<param name="offset">The pixel location where copying starts.</param>
<summary>Copies the bitmap pixel data into an array of pixels with the specified stride, starting at the specified offset.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CopyPixels">
<MemberSignature Language="C#" Value="public virtual void CopyPixels (System.Windows.Int32Rect sourceRect, Array pixels, int stride, int offset);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void CopyPixels(valuetype System.Windows.Int32Rect sourceRect, class System.Array pixels, int32 stride, int32 offset) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.CopyPixels(System.Windows.Int32Rect,System.Array,System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub CopyPixels (sourceRect As Int32Rect, pixels As Array, stride As Integer, offset As Integer)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual void CopyPixels(System::Windows::Int32Rect sourceRect, Array ^ pixels, int stride, int offset);" />
<MemberSignature Language="F#" Value="abstract member CopyPixels : System.Windows.Int32Rect * Array * int * int -&gt; unit&#xA;override this.CopyPixels : System.Windows.Int32Rect * Array * int * int -&gt; unit" Usage="bitmapSource.CopyPixels (sourceRect, pixels, stride, offset)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netcore-3.0">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceRect" Type="System.Windows.Int32Rect" />
<Parameter Name="pixels" Type="System.Array" />
<Parameter Name="stride" Type="System.Int32" />
<Parameter Name="offset" Type="System.Int32" />
</Parameters>
<Docs>
<param name="sourceRect">The source rectangle to copy. An <see cref="P:System.Windows.Int32Rect.Empty" /> value specifies the entire bitmap.</param>
<param name="pixels">The destination array.</param>
<param name="stride">The stride of the bitmap.</param>
<param name="offset">The pixel location where copying begins.</param>
<summary>Copies the bitmap pixel data within the specified rectangle into an array of pixels that has the specified stride starting at the specified offset.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An empty `sourceRect` value (specified as all zeros) copies the entire bitmap.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CopyPixels">
<MemberSignature Language="C#" Value="public virtual void CopyPixels (System.Windows.Int32Rect sourceRect, IntPtr buffer, int bufferSize, int stride);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void CopyPixels(valuetype System.Windows.Int32Rect sourceRect, native int buffer, int32 bufferSize, int32 stride) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.CopyPixels(System.Windows.Int32Rect,System.IntPtr,System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub CopyPixels (sourceRect As Int32Rect, buffer As IntPtr, bufferSize As Integer, stride As Integer)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual void CopyPixels(System::Windows::Int32Rect sourceRect, IntPtr buffer, int bufferSize, int stride);" />
<MemberSignature Language="F#" Value="abstract member CopyPixels : System.Windows.Int32Rect * nativeint * int * int -&gt; unit&#xA;override this.CopyPixels : System.Windows.Int32Rect * nativeint * int * int -&gt; unit" Usage="bitmapSource.CopyPixels (sourceRect, buffer, bufferSize, stride)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netcore-3.0">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceRect" Type="System.Windows.Int32Rect" />
<Parameter Name="buffer" Type="System.IntPtr" />
<Parameter Name="bufferSize" Type="System.Int32" />
<Parameter Name="stride" Type="System.Int32" />
</Parameters>
<Docs>
<param name="sourceRect">The source rectangle to copy. An <see cref="P:System.Windows.Int32Rect.Empty" /> value specifies the entire bitmap.</param>
<param name="buffer">A pointer to the buffer.</param>
<param name="bufferSize">The size of the buffer.</param>
<param name="stride">The stride of the bitmap.</param>
<summary>Copies the bitmap pixel data within the specified rectangle</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An empty `sourceRect` value (specified as all zeros) copies the entire bitmap.
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Create">
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Creates a new <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> that has the specified properties and options.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static System.Windows.Media.Imaging.BitmapSource Create (int pixelWidth, int pixelHeight, double dpiX, double dpiY, System.Windows.Media.PixelFormat pixelFormat, System.Windows.Media.Imaging.BitmapPalette palette, Array pixels, int stride);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Windows.Media.Imaging.BitmapSource Create(int32 pixelWidth, int32 pixelHeight, float64 dpiX, float64 dpiY, valuetype System.Windows.Media.PixelFormat pixelFormat, class System.Windows.Media.Imaging.BitmapPalette palette, class System.Array pixels, int32 stride) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.Create(System.Int32,System.Int32,System.Double,System.Double,System.Windows.Media.PixelFormat,System.Windows.Media.Imaging.BitmapPalette,System.Array,System.Int32)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Windows::Media::Imaging::BitmapSource ^ Create(int pixelWidth, int pixelHeight, double dpiX, double dpiY, System::Windows::Media::PixelFormat pixelFormat, System::Windows::Media::Imaging::BitmapPalette ^ palette, Array ^ pixels, int stride);" />
<MemberSignature Language="F#" Value="static member Create : int * int * double * double * System.Windows.Media.PixelFormat * System.Windows.Media.Imaging.BitmapPalette * Array * int -&gt; System.Windows.Media.Imaging.BitmapSource" Usage="System.Windows.Media.Imaging.BitmapSource.Create (pixelWidth, pixelHeight, dpiX, dpiY, pixelFormat, palette, pixels, stride)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.Imaging.BitmapSource</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pixelWidth" Type="System.Int32" />
<Parameter Name="pixelHeight" Type="System.Int32" />
<Parameter Name="dpiX" Type="System.Double" />
<Parameter Name="dpiY" Type="System.Double" />
<Parameter Name="pixelFormat" Type="System.Windows.Media.PixelFormat" />
<Parameter Name="palette" Type="System.Windows.Media.Imaging.BitmapPalette" />
<Parameter Name="pixels" Type="System.Array" />
<Parameter Name="stride" Type="System.Int32" />
</Parameters>
<Docs>
<param name="pixelWidth">The width of the bitmap.</param>
<param name="pixelHeight">The height of the bitmap.</param>
<param name="dpiX">The horizontal [!INCLUDE[TLA#tla_dpi](~/includes/tlasharptla-dpi-md.md)] of the bitmap.</param>
<param name="dpiY">The vertical [!INCLUDE[TLA#tla_dpi](~/includes/tlasharptla-dpi-md.md)] of the bitmap.</param>
<param name="pixelFormat">The pixel format of the bitmap.</param>
<param name="palette">The palette of the bitmap.</param>
<param name="pixels">An array of bytes that represents the content of a bitmap image.</param>
<param name="stride">The stride of the bitmap.</param>
<summary>Creates a new <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> from an array of pixels.</summary>
<returns>The <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> that is created from the specified array of pixels.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example demonstrates how to use this method in order to create a new <xref:System.Windows.Media.Imaging.BitmapSource>.
[!code-csharp[bitmapframeexample#1](~/samples/snippets/csharp/VS_Snippets_Wpf/BitmapFrameExample/CSharp/BitmapFrame.cs#1)]
[!code-vb[bitmapframeexample#1](~/samples/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb#1)]
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.PixelFormats" />
<altmember cref="T:System.Windows.Media.Imaging.BitmapPalette" />
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static System.Windows.Media.Imaging.BitmapSource Create (int pixelWidth, int pixelHeight, double dpiX, double dpiY, System.Windows.Media.PixelFormat pixelFormat, System.Windows.Media.Imaging.BitmapPalette palette, IntPtr buffer, int bufferSize, int stride);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Windows.Media.Imaging.BitmapSource Create(int32 pixelWidth, int32 pixelHeight, float64 dpiX, float64 dpiY, valuetype System.Windows.Media.PixelFormat pixelFormat, class System.Windows.Media.Imaging.BitmapPalette palette, native int buffer, int32 bufferSize, int32 stride) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.Create(System.Int32,System.Int32,System.Double,System.Double,System.Windows.Media.PixelFormat,System.Windows.Media.Imaging.BitmapPalette,System.IntPtr,System.Int32,System.Int32)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Windows::Media::Imaging::BitmapSource ^ Create(int pixelWidth, int pixelHeight, double dpiX, double dpiY, System::Windows::Media::PixelFormat pixelFormat, System::Windows::Media::Imaging::BitmapPalette ^ palette, IntPtr buffer, int bufferSize, int stride);" />
<MemberSignature Language="F#" Value="static member Create : int * int * double * double * System.Windows.Media.PixelFormat * System.Windows.Media.Imaging.BitmapPalette * nativeint * int * int -&gt; System.Windows.Media.Imaging.BitmapSource" Usage="System.Windows.Media.Imaging.BitmapSource.Create (pixelWidth, pixelHeight, dpiX, dpiY, pixelFormat, palette, buffer, bufferSize, stride)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netcore-3.0">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Media.Imaging.BitmapSource</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pixelWidth" Type="System.Int32" />
<Parameter Name="pixelHeight" Type="System.Int32" />
<Parameter Name="dpiX" Type="System.Double" />
<Parameter Name="dpiY" Type="System.Double" />
<Parameter Name="pixelFormat" Type="System.Windows.Media.PixelFormat" />
<Parameter Name="palette" Type="System.Windows.Media.Imaging.BitmapPalette" />
<Parameter Name="buffer" Type="System.IntPtr" />
<Parameter Name="bufferSize" Type="System.Int32" />
<Parameter Name="stride" Type="System.Int32" />
</Parameters>
<Docs>
<param name="pixelWidth">The width of the bitmap.</param>
<param name="pixelHeight">The height of the bitmap.</param>
<param name="dpiX">The horizontal [!INCLUDE[TLA#tla_dpi](~/includes/tlasharptla-dpi-md.md)] of the bitmap.</param>
<param name="dpiY">The vertical [!INCLUDE[TLA#tla_dpi](~/includes/tlasharptla-dpi-md.md)] of the bitmap.</param>
<param name="pixelFormat">The pixel format of the bitmap.</param>
<param name="palette">The palette of the bitmap.</param>
<param name="buffer">A pointer to the buffer that contains the bitmap data in memory.</param>
<param name="bufferSize">The size of the buffer.</param>
<param name="stride">The stride of the bitmap.</param>
<summary>Creates a new <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> from an array of pixels that are stored in unmanaged memory.</summary>
<returns>A <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> that is created from the array of pixels in unmanaged memory.</returns>
<remarks>To be added.</remarks>
<permission cref="T:System.Security.Permissions.SecurityPermission">Callers must have <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" /> permission to call this [!INCLUDE[TLA#tla_api](~/includes/tlasharptla-api-md.md)] because this code accesses a memory buffer by using a pointer reference. See <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" /> for more information.</permission>
</Docs>
</Member>
<Member MemberName="DecodeFailed">
<MemberSignature Language="C#" Value="public virtual event EventHandler&lt;System.Windows.Media.ExceptionEventArgs&gt; DecodeFailed;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1&lt;class System.Windows.Media.ExceptionEventArgs&gt; DecodeFailed" />
<MemberSignature Language="DocId" Value="E:System.Windows.Media.Imaging.BitmapSource.DecodeFailed" />
<MemberSignature Language="VB.NET" Value="Public Overridable Custom Event DecodeFailed As EventHandler(Of ExceptionEventArgs) " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual event EventHandler&lt;System::Windows::Media::ExceptionEventArgs ^&gt; ^ DecodeFailed;" />
<MemberSignature Language="F#" Value="member this.DecodeFailed : EventHandler&lt;System.Windows.Media.ExceptionEventArgs&gt; " Usage="member this.DecodeFailed : System.EventHandler&lt;System.Windows.Media.ExceptionEventArgs&gt; " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler&lt;System.Windows.Media.ExceptionEventArgs&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the image fails to load, due to a corrupt image header.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Windows.Media.Imaging.BitmapSource.DecodeFailed> is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](~/docs/framework/migration-guide/versions-and-dependencies.md).
<a name="xamlTextUsage_DecodeFailed"></a>
## XAML Text Usage
\<*object* DecodeFailed="*EventHandler*" .../>
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DownloadCompleted">
<MemberSignature Language="C#" Value="public virtual event EventHandler DownloadCompleted;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler DownloadCompleted" />
<MemberSignature Language="DocId" Value="E:System.Windows.Media.Imaging.BitmapSource.DownloadCompleted" />
<MemberSignature Language="VB.NET" Value="Public Overridable Custom Event DownloadCompleted As EventHandler " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual event EventHandler ^ DownloadCompleted;" />
<MemberSignature Language="F#" Value="member this.DownloadCompleted : EventHandler " Usage="member this.DownloadCompleted : System.EventHandler " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the bitmap content has been completely downloaded.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This event may not be raised for all types of bitmap content.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DownloadFailed">
<MemberSignature Language="C#" Value="public virtual event EventHandler&lt;System.Windows.Media.ExceptionEventArgs&gt; DownloadFailed;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1&lt;class System.Windows.Media.ExceptionEventArgs&gt; DownloadFailed" />
<MemberSignature Language="DocId" Value="E:System.Windows.Media.Imaging.BitmapSource.DownloadFailed" />
<MemberSignature Language="VB.NET" Value="Public Overridable Custom Event DownloadFailed As EventHandler(Of ExceptionEventArgs) " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual event EventHandler&lt;System::Windows::Media::ExceptionEventArgs ^&gt; ^ DownloadFailed;" />
<MemberSignature Language="F#" Value="member this.DownloadFailed : EventHandler&lt;System.Windows.Media.ExceptionEventArgs&gt; " Usage="member this.DownloadFailed : System.EventHandler&lt;System.Windows.Media.ExceptionEventArgs&gt; " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler&lt;System.Windows.Media.ExceptionEventArgs&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the bitmap content failed to download.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This event may not be raised for all types of bitmap content.
<a name="xamlTextUsage_DownloadFailed"></a>
## XAML Text Usage
\<*object* DownloadFailed="*EventHandler*" .../>
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DownloadProgress">
<MemberSignature Language="C#" Value="public virtual event EventHandler&lt;System.Windows.Media.Imaging.DownloadProgressEventArgs&gt; DownloadProgress;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1&lt;class System.Windows.Media.Imaging.DownloadProgressEventArgs&gt; DownloadProgress" />
<MemberSignature Language="DocId" Value="E:System.Windows.Media.Imaging.BitmapSource.DownloadProgress" />
<MemberSignature Language="VB.NET" Value="Public Overridable Custom Event DownloadProgress As EventHandler(Of DownloadProgressEventArgs) " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual event EventHandler&lt;System::Windows::Media::Imaging::DownloadProgressEventArgs ^&gt; ^ DownloadProgress;" />
<MemberSignature Language="F#" Value="member this.DownloadProgress : EventHandler&lt;System.Windows.Media.Imaging.DownloadProgressEventArgs&gt; " Usage="member this.DownloadProgress : System.EventHandler&lt;System.Windows.Media.Imaging.DownloadProgressEventArgs&gt; " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler&lt;System.Windows.Media.Imaging.DownloadProgressEventArgs&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the download progress of the bitmap content has changed.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This event may not be raised for all types of bitmap content.
<a name="xamlTextUsage_DownloadProgress"></a>
## XAML Text Usage
\<*object* DownloadProgress="*EventHandler*" .../>
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DpiX">
<MemberSignature Language="C#" Value="public virtual double DpiX { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 DpiX" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Imaging.BitmapSource.DpiX" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property DpiX As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property double DpiX { double get(); };" />
<MemberSignature Language="F#" Value="member this.DpiX : double" Usage="System.Windows.Media.Imaging.BitmapSource.DpiX" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the horizontal [!INCLUDE[TLA#tla_dpi](~/includes/tlasharptla-dpi-md.md)] of the image.</summary>
<value>The horizontal [!INCLUDE[TLA#tla_dpi](~/includes/tlasharptla-dpi-md.md)] of the image; that is, the [!INCLUDE[TLA#tla_dpi](~/includes/tlasharptla-dpi-md.md)] along the x-axis.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DpiY">
<MemberSignature Language="C#" Value="public virtual double DpiY { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 DpiY" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Imaging.BitmapSource.DpiY" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property DpiY As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property double DpiY { double get(); };" />
<MemberSignature Language="F#" Value="member this.DpiY : double" Usage="System.Windows.Media.Imaging.BitmapSource.DpiY" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the vertical [!INCLUDE[TLA#tla_dpi](~/includes/tlasharptla-dpi-md.md)] of the image.</summary>
<value>The vertical [!INCLUDE[TLA#tla_dpi](~/includes/tlasharptla-dpi-md.md)] of the image; that is, the [!INCLUDE[TLA#tla_dpi](~/includes/tlasharptla-dpi-md.md)] along the y-axis.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Format">
<MemberSignature Language="C#" Value="public virtual System.Windows.Media.PixelFormat Format { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Media.PixelFormat Format" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Imaging.BitmapSource.Format" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Format As PixelFormat" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property System::Windows::Media::PixelFormat Format { System::Windows::Media::PixelFormat get(); };" />
<MemberSignature Language="F#" Value="member this.Format : System.Windows.Media.PixelFormat" Usage="System.Windows.Media.Imaging.BitmapSource.Format" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.PixelFormat</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the native <see cref="T:System.Windows.Media.PixelFormat" /> of the bitmap data.</summary>
<value>The pixel format of the bitmap data.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the <xref:System.Windows.Media.Imaging.BitmapSource> is directly readable, this is the format that the pixels will be in when they are read.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.PixelFormat" />
</Docs>
</Member>
<Member MemberName="FreezeCore">
<MemberSignature Language="C#" Value="protected override bool FreezeCore (bool isChecking);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance bool FreezeCore(bool isChecking) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.FreezeCore(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function FreezeCore (isChecking As Boolean) As Boolean" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; override bool FreezeCore(bool isChecking);" />
<MemberSignature Language="F#" Value="override this.FreezeCore : bool -&gt; bool" Usage="bitmapSource.FreezeCore isChecking" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="isChecking" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="isChecking">
<see langword="true" /> if this instance should actually freeze itself when this method is called; otherwise, <see langword="false" />.</param>
<summary>Makes an instance of <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> or a derived class immutable.</summary>
<returns>If <paramref name="isChecking" /> is <see langword="true" />, this method returns <see langword="true" /> if this <see cref="T:System.Windows.Media.Animation.Animatable" /> can be made unmodifiable, or <see langword="false" /> if it cannot be made unmodifiable.
If <paramref name="isChecking" /> is <see langword="false" />, this method returns <see langword="true" /> if the if this <see cref="T:System.Windows.Media.Animation.Animatable" /> is now unmodifiable, or <see langword="false" /> if it cannot be made unmodifiable, with the side effect of having begun to change the frozen status of this object.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Windows.Freezable.FreezeCore(System.Boolean)" />
</Docs>
</Member>
<Member MemberName="GetAsFrozenCore">
<MemberSignature Language="C#" Value="protected override void GetAsFrozenCore (System.Windows.Freezable sourceFreezable);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void GetAsFrozenCore(class System.Windows.Freezable sourceFreezable) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.GetAsFrozenCore(System.Windows.Freezable)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub GetAsFrozenCore (sourceFreezable As Freezable)" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; override void GetAsFrozenCore(System::Windows::Freezable ^ sourceFreezable);" />
<MemberSignature Language="F#" Value="override this.GetAsFrozenCore : System.Windows.Freezable -&gt; unit" Usage="bitmapSource.GetAsFrozenCore sourceFreezable" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceFreezable" Type="System.Windows.Freezable" />
</Parameters>
<Docs>
<param name="sourceFreezable">The <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> object to clone and freeze.</param>
<summary>Makes this instance a clone of the specified <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, <xref:System.Windows.Freezable.GetAsFrozen%2A> will fail when trying to freeze the object and will throw an <xref:System.InvalidOperationException>.
This method is called by the <xref:System.Windows.Freezable.GetAsFrozen%2A> method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call <xref:System.Windows.Freezable.GetAsFrozen%2A> instead of calling this method directly.
For more information, see <xref:System.Windows.Freezable.GetAsFrozenCore%2A?displayProperty=nameWithType>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetCurrentValueAsFrozenCore">
<MemberSignature Language="C#" Value="protected override void GetCurrentValueAsFrozenCore (System.Windows.Freezable sourceFreezable);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void GetCurrentValueAsFrozenCore(class System.Windows.Freezable sourceFreezable) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.BitmapSource.GetCurrentValueAsFrozenCore(System.Windows.Freezable)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub GetCurrentValueAsFrozenCore (sourceFreezable As Freezable)" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; override void GetCurrentValueAsFrozenCore(System::Windows::Freezable ^ sourceFreezable);" />
<MemberSignature Language="F#" Value="override this.GetCurrentValueAsFrozenCore : System.Windows.Freezable -&gt; unit" Usage="bitmapSource.GetCurrentValueAsFrozenCore sourceFreezable" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceFreezable" Type="System.Windows.Freezable" />
</Parameters>
<Docs>
<param name="sourceFreezable">The <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> to copy and freeze.</param>
<summary>Makes this instance a frozen clone of the specified <see cref="T:System.Windows.Media.Imaging.BitmapSource" />. Resource references, data bindings, and animations are not copied, but their current values are.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is called by the <xref:System.Windows.Freezable.GetCurrentValueAsFrozen%2A> method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call <xref:System.Windows.Freezable.GetCurrentValueAsFrozen%2A> instead of calling this method directly.
For more information see <xref:System.Windows.Freezable.GetCurrentValueAsFrozenCore%2A?displayProperty=nameWithType>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public override double Height { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Height" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Imaging.BitmapSource.Height" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Height As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property double Height { double get(); };" />
<MemberSignature Language="F#" Value="member this.Height : double" Usage="System.Windows.Media.Imaging.BitmapSource.Height" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the height of the source bitmap in [!INCLUDE[TLA#tla_dipixel#plural](~/includes/tlasharptla-dipixelsharpplural-md.md)].</summary>
<value>The height of the bitmap in [!INCLUDE[TLA#tla_dipixel#plural](~/includes/tlasharptla-dipixelsharpplural-md.md)].</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsDownloading">
<MemberSignature Language="C#" Value="public virtual bool IsDownloading { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsDownloading" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Imaging.BitmapSource.IsDownloading" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property IsDownloading As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property bool IsDownloading { bool get(); };" />
<MemberSignature Language="F#" Value="member this.IsDownloading : bool" Usage="System.Windows.Media.Imaging.BitmapSource.IsDownloading" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether the <see cref="T:System.Windows.Media.Imaging.BitmapSource" /> content is currently downloading.</summary>
<value>
<see langword="true" /> if the bitmap source is currently downloading; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Metadata">
<MemberSignature Language="C#" Value="public override System.Windows.Media.ImageMetadata Metadata { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Windows.Media.ImageMetadata Metadata" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Imaging.BitmapSource.Metadata" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Metadata As ImageMetadata" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property System::Windows::Media::ImageMetadata ^ Metadata { System::Windows::Media::ImageMetadata ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Metadata : System.Windows.Media.ImageMetadata" Usage="System.Windows.Media.Imaging.BitmapSource.Metadata" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.ImageMetadata</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the metadata that is associated with this bitmap image.</summary>
<value>The metadata that is associated with the bitmap image.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Media.ImageMetadata" />
</Docs>
</Member>
<Member MemberName="Palette">
<MemberSignature Language="C#" Value="public virtual System.Windows.Media.Imaging.BitmapPalette Palette { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Windows.Media.Imaging.BitmapPalette Palette" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Imaging.BitmapSource.Palette" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Palette As BitmapPalette" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property System::Windows::Media::Imaging::BitmapPalette ^ Palette { System::Windows::Media::Imaging::BitmapPalette ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Palette : System.Windows.Media.Imaging.BitmapPalette" Usage="System.Windows.Media.Imaging.BitmapSource.Palette" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5">
<AttributeName>get: System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Media.Imaging.BitmapPalette</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the color palette of the bitmap, if one is specified.</summary>
<value>The color palette of the bitmap.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Media.Imaging.BitmapPalette" />
</Docs>
</Member>
<Member MemberName="PixelHeight">
<MemberSignature Language="C#" Value="public virtual int PixelHeight { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 PixelHeight" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Imaging.BitmapSource.PixelHeight" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property PixelHeight As Integer" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property int PixelHeight { int get(); };" />
<MemberSignature Language="F#" Value="member this.PixelHeight : int" Usage="System.Windows.Media.Imaging.BitmapSource.PixelHeight" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the height of the bitmap in pixels.</summary>
<value>The height of the bitmap in pixels.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PixelWidth">
<MemberSignature Language="C#" Value="public virtual int PixelWidth { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 PixelWidth" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Imaging.BitmapSource.PixelWidth" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property PixelWidth As Integer" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property int PixelWidth { int get(); };" />
<MemberSignature Language="F#" Value="member this.PixelWidth : int" Usage="System.Windows.Media.Imaging.BitmapSource.PixelWidth" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the width of the bitmap in pixels.</summary>
<value>The width of the bitmap in pixels.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public override double Width { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Width" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Imaging.BitmapSource.Width" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Width As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property double Width { double get(); };" />
<MemberSignature Language="F#" Value="member this.Width : double" Usage="System.Windows.Media.Imaging.BitmapSource.Width" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the width of the bitmap in [!INCLUDE[TLA#tla_dipixel#plural](~/includes/tlasharptla-dipixelsharpplural-md.md)].</summary>
<value>The width of the bitmap in [!INCLUDE[TLA#tla_dipixel#plural](~/includes/tlasharptla-dipixelsharpplural-md.md)].</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.