IPixelFilter::GetPixelsForImage method (filter.h)

Implemented by a search filter to supply pixel data for the image being indexed.

Syntax

HRESULT GetPixelsForImage(
  [in]  FLOAT      scalingFactor,
  [in]  const RECT *sourceRect,
  [in]  ULONG      pixelBufferSize,
  [out] BYTE       *pixelBuffer
);

Parameters

[in] scalingFactor

A FLOAT specifying the scaling factor with which the image should be scaled before populating pixelBuffer.

[in] sourceRect

A RECT specifying the region of the image for which pixels values should be included in pixelBuffer. If this value is nullptr, the entire image should be included.

[in] pixelBufferSize

The expected size of pixelBuffer, in bytes.

[out] pixelBuffer

The buffer containing the requested pixel values. This buffer is client-managed and must have the size specified in pixelBufferSize.

Return value

This method can return one of these values.

Remarks

The image data returned in pixelBuffer must be in the IMAGE_PIXELFORMAT format specified in the Format field of the IMAGE_INFO structure returned from the filter's implementation of IPixelFilter::GetImageInfo.

Requirements