setStdDeviation method

Sets the standard deviation values used in calculating a Gaussian blur.

 

Syntax

HRESULT retVal = object.setStdDeviation(stdDeviationX, stdDeviationY);

Parameters

• stdDeviationX [in]
  Type: float

  The standard deviation in the x-direction, specified by the ISVGFEGaussianBlurElement::stdDeviationX property.

• stdDeviationY [in]
  Type: float

  The standard deviation in the y-direction, specified by the ISVGFEGaussianBlurElement::stdDeviationY property.

Return value

Type: HRESULT

This method can return one of these values.

S_OK

Standards information

• Scalable Vector Graphics: Filter Effects, Section 15.25.19

Remarks

If two values are provided, the first value represents a standard deviation value along the x-axis of the coordinate system established by the ISVGFilterElement::primitiveUnits attribute on the filter element. The second value represents a standard deviation along the y-axis.

If one number is provided, then that value is used for both stdDeviationX and stdDeviationY.

Negative values are not allowed.

A value of zero disables the effect of the given filter primitive (that is, the result is the filter input image). If the ISVGFEGaussianBlurElement::setStdDeviation method is zero in only one of stdDeviationX or stdDeviationY, then the effect is that the blur is applied only in the direction that has a non-zero value.

If the ISVGFEGaussianBlurElement::setStdDeviation method is not specified, then the effect is as if a value of zero were specified.