IWICBitmapFrameEncode::WritePixels method

Copies scan-line data from a caller-supplied buffer to the IWICBitmapFrameEncode object.

Syntax


HRESULT WritePixels(
  [in]  UINT lineCount,
  [in]  UINT cbStride,
  [in]  UINT cbBufferSize,
  [in]  BYTE *pbPixels
);

Parameters

lineCount [in]

Type: UINT

The number of lines to encode.

cbStride [in]

Type: UINT

The stride of the image pixels.

cbBufferSize [in]

Type: UINT

The size of the pixel buffer.

pbPixels [in]

Type: BYTE*

A pointer to the pixel buffer.

Return value

Type: HRESULT

Possible return values include the following.

Return codeDescription
S_OK

Success.

WINCODEC_ERR_CODECTOOMANYSCANLINES

The value of lineCount is larger than the number of scan lines in the image.

 

Remarks

Successive WritePixels calls are assumed to be sequential scan-line access in the output image.

Requirements

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Wincodec.h

IDL

Wincodec.idl

Library

Windowscodecs.lib

DLL

Windowscodecs.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft