BitmapCacheBrush Class Home
This page is specific to:.NET Framework Version:4.0
.NET Framework Class Library
BitmapCacheBrush Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Paints an area with cached content.

Namespace:  System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
Syntax

'Usage

Dim instance As BitmapCacheBrush

'Declaration

Public NotInheritable Class BitmapCacheBrush _
    Inherits Brush
<BitmapCacheBrush .../>
Remarks

Use the BitmapCacheBrush class to reuse a cached element efficiently. This is useful when you need to paint complex content onto multiple elements. Use the BitmapCache class to cache a complex element.

Assign a Visual to the Target property and optionally assign a BitmapCache to the BitmapCache property. The CacheMode of the brush and the target Visual interact to produce different behaviors. The following table describes this interaction.

Target has no CacheMode

Target has CacheMode

Brush has no CacheMode

Target visual renders normally; brush uses default cache behavior.

Target visual renders into its own cache; brush uses target’s cache when rendering.

Brush has CacheMode

Target visual renders normally; brush renders target into its own cache and uses this to render.

Target visual renders into its own cache; brush renders target into brush's own cache and uses this to render.

The BitmapCacheBrush class is similar to the VisualBrush class, but BitmapCacheBrush always renders from a cache on the target element, or from a cache defined by the BitmapCache property. The BitmapCacheBrush class also supports dirty regions.

The following table shows the default bitmap cache settings for the BitmapCacheBrush class.

Bitmap Cache Property

Default Setting

SnapsToDevicePixels

false

EnableClearType

false

RenderAtScale

1

The SnapsToDevicePixels property is ignored by the BitmapCacheBrush class.

The BitmapCacheBrush class ignores the following properties on the root Visual. This behavior differs from the VisualBrush class.

Examples

The following code example shows how to associate a BitmapCache with a BitmapCacheBrush. You can use the BitmapCacheBrush resource on multiple elements and achieve good performance. For the complete code listing, see How to: Use a Cached Element as a Brush.

<Window.Resources>
    <!-- Set the Source property to a valid image path. -->
    <Image x:Key="cachedImage" Source="/BitmapCacheBrushDemo;component/space%20needle.jpg" >
        <Image.CacheMode>
            <BitmapCache EnableClearType="False" 
                                 RenderAtScale="1" 
                                 SnapsToDevicePixels="False"  />
        </Image.CacheMode>
    </Image>
    <BitmapCacheBrush x:Key="cachedImageBrush" Target="{StaticResource cachedImage}" />
</Window.Resources>
Inheritance Hierarchy

System..::.Object
  System.Windows.Threading..::.DispatcherObject
    System.Windows..::.DependencyObject
      System.Windows..::.Freezable
        System.Windows.Media.Animation..::.Animatable
          System.Windows.Media..::.Brush
            System.Windows.Media..::.BitmapCacheBrush
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4
See Also

Reference

Other Resources

© 2009 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View