kernelUnitLengthX property

  • Article

kernelUnitLength indicates the intended distance in current filter units for dx and dy in the surface normal calculation formulas.

This property is read-only.

 

Syntax

HRESULT get_kernelUnitLengthX(
  [out] SVGAnimatedNumber **number(s)
);

Property values

Type: SVGAnimatedNumber

dx as described below.

Standards information

Remarks

For JavaScript, the kernelUnitLengthX property represents dx. For HTML, the kernelUnitLength attribute is used to set both dx and dy, as described next.

For the attribute kernelUnitLength = "<number optional-number>", the first number is the dx value. The second number is the dy value. If the dy value is not specified, it defaults to the same value as dx.

kernelUnitLength indicates the intended distance in current filter units (as determined by the value of the ISVGFilterElement::primitiveUnits attribute) for dx and dy, respectively, in the surface normal calculation formulas. By specifying value(s) for kernelUnitLength, the kernel becomes defined in a scalable, abstract coordinate system. If kernelUnitLength is not specified, the dx and dy values should represent very small deltas relative to a given (x, y) position.

For some level of consistency across display media and browsers, it is necessary that a value be provided for at least one of ISVGFilterElement::setFilterRes and kernelUnitLength.