IDXEffect::Progress Property

This topic documents a feature of Visual Filters and Transitions, which is deprecated as of Windows Internet Explorer 9 and obsolete as of Internet Explorer 10.

Retrieves the setting of the transform's IDXEffect::Progress property. Sets the requested progress made on the transform.

Syntax


HRESULT IDXEffect::get_Progress(float *pVal);HRESULT IDXEffect::put_Progress(float newVal);

Parameters

pVal
Pointer to a value that indicates the progress setting of the transform.
newVal
Value from zero to one that indicates how much of the transition should be completed.

Return Value

Returns an HRESULT value that depends on the implementation of the interface.

Remarks

The return value is a float from zero to one, with one signifying completion.

Effects use this value to determine what output to generate. For example, an image 1 to image 2 fade transform produces an output of image 1 at IDXEffect::Progress = 0 and an output of image 2 at IDXEffect::Progress = 1. For IDXEffect::Progress = 0.5, the resulting image is a blend of 50 percent image 1 and 50 percent image 2.

A user doesn't need to modify the IDXEffect::Progress property in a linear fashion, as it is possible to go through a random sequence of values for this parameter. If not initialized by this method, the value of IDXEffect::Progress is undefined and could produce unexpected output.

Community Additions

ADD
Show:
© 2014 Microsoft