Skip to content

Latest commit

 

History

History
179 lines (128 loc) · 4.95 KB

nf-vfw-icdrawbegin.md

File metadata and controls

179 lines (128 loc) · 4.95 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:vfw.ICDrawBegin
ICDrawBegin function (vfw.h)
The ICDrawBegin function initializes the renderer and prepares the drawing destination for drawing.
ICDrawBegin
ICDrawBegin function [Windows Multimedia]
_win32_ICDrawBegin
multimedia.icdrawbegin
vfw/ICDrawBegin
multimedia\icdrawbegin.htm
Multimedia
52a43888-9839-45a3-b139-e84943c345c2
12/05/2018
ICDrawBegin, ICDrawBegin function [Windows Multimedia], _win32_ICDrawBegin, multimedia.icdrawbegin, vfw/ICDrawBegin
vfw.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
Vfw32.lib
Msvfw32.dll
Windows
19H1
ICDrawBegin
vfw/ICDrawBegin
c++
APIRef
kbSyntax
DllExport
Msvfw32.dll
ICDrawBegin

ICDrawBegin function

-description

The ICDrawBegin function initializes the renderer and prepares the drawing destination for drawing.

-parameters

-param hic

Handle to the decompressor to use.

-param dwFlags

Decompression flags. The following values are defined.

Value Meaning
ICDRAW_ANIMATE Application can animate the palette.
ICDRAW_CONTINUE Drawing is a continuation of the previous frame.
ICDRAW_FULLSCREEN Draws the decompressed data on the full screen.
ICDRAW_HDC Draws the decompressed data to a window or a DC.
ICDRAW_MEMORYDC DC is off-screen.
ICDRAW_QUERY Determines if the decompressor can decompress the data. The driver does not decompress the data.
ICDRAW_UPDATING Current frame is being updated rather than played.

-param hpal

Handle to the palette used for drawing.

-param hwnd

Handle to the window used for drawing.

-param hdc

DC used for drawing.

-param xDst

The x-coordinate of the upper right corner of the destination rectangle.

-param yDst

The y-coordinate of the upper right corner of the destination rectangle.

-param dxDst

Width of the destination rectangle.

-param dyDst

Height of the destination rectangle.

-param lpbi

Pointer to a BITMAPINFOHEADER structure containing the format of the input data to be decompressed.

-param xSrc

The x-coordinate of the upper right corner of the source rectangle.

-param ySrc

The y-coordinate of the upper right corner of the source rectangle.

-param dxSrc

Width of the source rectangle.

-param dySrc

Height of the source rectangle.

-param dwRate

Frame rate numerator. The frame rate, in frames per second, is obtained by dividing dwRate by dwScale.

-param dwScale

Frame rate denominator. The frame rate, in frames per second, is obtained by dividing dwRate by dwScale.

-returns

Returns ICERR_OK if the renderer can decompress the data or ICERR_UNSUPPORTED otherwise.

-remarks

The ICDRAW_HDC and ICDRAW_FULLSCREEN flags are mutually exclusive. If an application sets the ICDRAW_HDC flag in dwFlags, the decompressor uses hwnd, hdc, and the parameters defining the destination rectangle (xDst, yDst, dxDst, and dyDst). Your application should set these parameters to the size of the destination rectangle. Specify destination rectangle values relative to the current window or DC.

If an application sets the ICDRAW_FULLSCREEN flag in dwFlags, the hwnd and hdc parameters are not used and should be set to NULL. Also, the destination rectangle is not used and its parameters can be set to zero.

The source rectangle is relative to the full video frame. The portion of the video frame specified by the source rectangle is stretched or shrunk to fit the destination rectangle.

The dwRate and dwScale parameters specify the decompression rate. The integer value specified for dwRate divided by the integer value specified for dwScale defines the frame rate in frames per second. This value is used by the renderer when it is responsible for timing frames during playback.

-see-also

Video Compression Functions

Video Compression Manager