Scripting API

<<AutosaveSettings Main Index Backlighting>>
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

BackgroundEraser

Script Name: BackgroundEraser
Name: BackgroundEraser
Library: ToolPaint
Description: Erases the background of the image.
Status bar text: Background Eraser Tool: Use to erase the background of the image
Tool tip text: Background Eraser Tool
Undo text: Background Eraser
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
BrushTipParameter RepositoryTempLinkNo
BrushParameter RepositoryTempLinkNo
Auto ToleranceAutoToleranceEnumeration (Boolean)Indicates whether the algorithm should automatically determine the best toleranceNoTrue
Ignore LightnessIgnoreLightnessEnumeration (Boolean)Ignore lightness when considering if a pixel lies in a tolerance limitNoFalse
LimitsLimitsEnumeration (BackgroundEraserLimits)Determines amount of erasing dispersionNoContiguous
Sample MergeSampleMergeEnumeration (Boolean)Indicates whether the algorithm should work on the whole image rather than on the current layerNoFalse
SamplingSamplingEnumeration (BackgroundEraserSamplingMode)Determines the color being erasedNoContinuous
Simple erase/unerase modeSimpleModeEnumeration (Boolean)Indicates whether the algorithm should perform a calculation or use behavior similar to the paint eraser.NoFalse
SharpnessSharpnessIntegerSelects amount of sharpnessNo700100
Sharpness JitterSharpnessJitterIntegerPercentage by which the brush sharpness can varyNo001000
Sharpness Variance MethodSharpnessVarianceMethodEnumeration (VarianceMethod)Selects the amount of sharpness, varied over the stroke which dependent on the tablet parametersNoNone
ToleranceToleranceIntegerDetermines the toleranceNo200512
Tolerance JitterToleranceJitterIntegerPercentage by which the brush tolerance can varyNo001000
Tolerance Variance MethodToleranceVarianceMethodEnumeration (VarianceMethod)Selects the amount of tolerance, varied over the stroke which is dependant on the tablet parametersNoNone
PrimaryMaterialEnumeration (MaterialRef)TempLinkNoForeground
ForegroundMaterialParameter RepositoryTempLinkYes
BackgroundMaterialParameter RepositoryTempLinkYes
StrokeStrokeListThe path of the brush stroke.No0
General SettingsGeneralSettingsParameter RepositoryContains parameters that control the execution of the command.No
 
Command Attributes:
IsExternal: true
IsUndoable: true
NoRepeat: true
Has Random Seed: true
DisallowNullMaterial: true
UsesCachedMaterials: true
ProcessChanges: true
FinalizeTransient: true
 
Resource Attributes: