CachedBitmap Constructor (BitmapSource, BitmapCreateOptions, BitmapCacheOption)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Initializes a new instance of CachedBitmap that has the specified source, bitmap create options, and bitmap cache option.

Namespace:   System.Windows.Media.Imaging
Assembly:  PresentationCore (in PresentationCore.dll)

public CachedBitmap(
	BitmapSource source,
	BitmapCreateOptions createOptions,
	BitmapCacheOption cacheOption
)

Parameters

source
Type: System.Windows.Media.Imaging.BitmapSource

The source bitmap that is being cached.

createOptions
Type: System.Windows.Media.Imaging.BitmapCreateOptions

Initialization options for the bitmap image.

cacheOption
Type: System.Windows.Media.Imaging.BitmapCacheOption

Specifies how the bitmap is cached to memory.

Exception Condition
ArgumentNullException

Occurs when source is null.

The following code example shows how to create and use a CachedBitmap in code.


CachedBitmap cachedSource = new CachedBitmap(
    scaledSource, 
    BitmapCreateOptions.None,
    BitmapCacheOption.OnLoad);


// Create a new BitmapSource using a different format than the original one.
FormatConvertedBitmap newFormatSource = new FormatConvertedBitmap();
newFormatSource.BeginInit();
newFormatSource.Source = cachedSource;
newFormatSource.DestinationFormat = PixelFormats.Gray32Float;
newFormatSource.EndInit();

.NET Framework
Available since 3.0
Return to top
Show: