BitmapEncoder.IsThumbnailGenerated | isThumbnailGenerated property

Applies to Windows and Windows Phone

Indicates whether or not a new thumbnail is automatically generated.

Syntax


var isThumbnailGenerated = bitmapEncoder.isThumbnailGenerated;
bitmapEncoder.isThumbnailGenerated = isThumbnailGenerated;

Property value

Type: Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++]

A value that indicates whether or not the bitmap encoder will automatically generate a new thumbnail. The default value is False.

Remarks

When this value is True, the bitmap encoder will generate a new thumbnail by downscaling the frame bitmap. The thumbnail size is determined by the GeneratedThumbnailWidth and GeneratedThumbnailHeight properties.

When this value is False, the bitmap encoder will leave any existing thumbnail data untouched if the BitmapEncoder was created using the CreateForTranscodingAsync method.

If there is no pre-existing thumbnail, then no thumbnail is written out. The application is responsible for ensuring that the thumbnail is consistent with the frame bitmap. For example, if the application alters the bitmap by setting a BitmapTransform or by editing the pixel data, and it sets IsThumbnailGenerated to false, then any pre-existing thumbnail data will be inconsistent.

If the image format does not support thumbnail, and you set this to True then call FlushAsync, it fails with HRESULT WINCODEC_ERR_UNSUPPORTEDOPERATION.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Graphics.Imaging
Windows::Graphics::Imaging [C++]

Metadata

Windows.winmd

See also

BitmapEncoder

 

 

Show:
© 2014 Microsoft