Show Menu
TOPICS×

KnockoutBackgroundOptions

Mask (knock-out) the background for selected images. This lets you overlay them in other layers with a transparency outside of subject image. An optional parameter that is off by default.
KnockoutBackgroundOptions=[corner, tolerance, fill]

Parameters

Name Type Description
corner xsd:string Selects the corner you want to work with. corner accepts these values:
  • UpperLeft
  • BottomLeft
  • UpperRight
  • BottomRight
tolerance xsd:double An optional setting that removes white space from image edges based on transparency. Accepts a range of values from 0.0 to 1.0. Specify:
  • 0 to match colors exactly.
  • 1 to enable the most color differences.
fillMethod xsd:string
Control pixel transparency in the location specified by the corner variable. The fillMethod accepts these values:
  • FloodFill : Turns all pixels in the specified corner transparent.
  • MatchPixel : Turns all matching pixels transparent regardless of location.

Example

<complexType name="KnockoutBackgroundOptions">
        <sequence>
            <!-- corner one of UpperLeft, BottomLeft, UpperRight, BottomRight -->
            <element name="corner" type="xsd:string" minOccurs="1"/>
            <!-- Tolerance real value between 0.0 and 1.0 -->
            <element name="tolerance" type="xsd:double" minOccurs="0"/>
            <!-- one of FloodFill or MatchPixel is required -->
            <element name="fillMethod" type="xsd:string" minOccurs="1"/>
        </sequence>
    </complexType>

Used By

The KnockoutBackgroundOptions type is used by: