IImageSink::PushPixelData (Compact 2013)

3/26/2014

This feature is being deprecated for this release. Refer to this component: Windows Imaging Component.

This method is used by an image source to pass pixel data for an image to the image sink.

Use this method if the source has already allocated memory for the image.

A source should only call this method if the negotiated format returned from IImageSink::BeginSink was the image format identifier ImageFormatMemoryBMP. For more information, see Imaging GUIDs.

If the source has not allocated memory for the image, call the IImageSink::GetPixelDataBuffer method to ask the sink to allocate memory for the data transfer.

Syntax

HRESULT PushPixelData(
  const RECT* rect,
  const BitmapData* bitmapData,
  BOOL lastPass
);

Parameters

• rect
  [in] A pointer to a RECT structure, specifying the dimensions of the image in pixels.

• bitmapData
  [in] A pointer to a BitmapData object containing the pixel data for the image.

• lastPass
  [in] A BOOL value that tells the sink whether this is the last pass over the specified image area.

  Set this value to TRUE if this call to IImageSink::PushPixelData is the last pass; otherwise, set to FALSE.

Return Value

If successful, this method returns S_OK.

This method may return E_NOTIMPL if it fails.

Remarks

You must call IImageSink::SetPalette prior to sending data to the sink.

Requirements

See Also

Reference

IImageSink
IImageSink::BeginSink
Imaging GUIDs
IImageSink::GetPixelDataBuffer
BitmapData

Other Resources

RECT