This is a child page. You can use Parent in the quick nav bar at the top or the bottom of the page to navigate directly back to the parent of this page. Some child pages are more than one level deep, and in that case will require more than one Parent click to reach the outermost document level.

16.96.3 - Specific Script Commands to WinImages FX operators

In the command summaries that follow, when a parameter is in CAPITAL_LETTERS, this means that the parameter is a flag that is either zero or one, or possibly a range such as zero to four. If the latter is the case, the range is specified in square brackets.

If the parameter is in double quotes, then the parameter is a string.

All other parameters are numeric. If F/x needs a floating point number, then that's how the number will be treated. If F/x needs an integer, any fractional part of the number will be discarded. So 1.5 is the same as 1 for an integer number, and 1 is the same as 1.0 for a floating point number.

 a=ADD(MODE[0-3])

 See the Operator Documentation 
 a=ADDTEXTURE(intensity,TILE)

 See the Operator Documentation 
 a=ANNULAR(red,green,blue,saturation,ADDITIVE)

 See the Operator Documentation 
 a=ANTIQUE(ANTIQUE/UNANTIQUE)

 See the Operator Documentation 
 a=ASTERIZE(red,green,blue,center saturation,width,rotation,arms,CENTER_GLOW,ADDITIVE,TAPER)

 See the Operator Documentation 
 a=AURA(width,connect,radiate,seed,spokes,spoke variance,rings,ring variance,innerfade,r,g,b,outerfade,ro,go,bo)

 See the Operator Documentation 
 a=BALANCE(red,green,blue,FORCE_DYNAMIC)

 See the Operator Documentation 
 a=BANG(SCROLL[0-4], peaking, T-variance, min, max, detail, resolution, transparency, seed, depth, turb, CLASS[0-2], lo-thresh, hi-thresh, MAX_DYN, INVERT, overfill, PALETTE_LOCK)

 See the Operator Documentation 
 a=BEND(amount,base,WRAP,ALPHA)

 See the Operator Documentation 
 a=BLUEPRINT(P)

 See the Operator Documentation 
 a=BLUR(percentage)

 See the Operator Documentation 
 a=BRIGHT(percentage)

 See the Operator Documentation 
 a=BUILDPAL(CLEAR,ACCUMULATE,GENERATE,RENDER_TRANSPARENT_COLOR)

 See the Operator Documentation 
 a=CANVAS(radius/10,amount,TILE,transparency,emboss,BWEMBOSS)

 See the Operator Documentation 
 a=CARIC(percentage)

 See the Operator Documentation 
 a=CELL(red,green,blue,DISCRETE EDGE,TRANSPARENCY,width,height,fade in)

 See the Operator Documentation 
 a=CHANMAP(MODE[0-5],smooth)

 See the Operator Documentation 
 CIRCE

 See the Operator Documentation 
 a=CLIP(ASSIGN_AS_SOURCE,DISPLAY CLIP,REPLACE_IMAGE)

 See the Operator Documentation 
 a=CLIPALPHA(ASSIGN_AS_SOURCE,DISPLAY_CLIP,REPLACE_IMAGE)

 See the Operator Documentation 
 a=COLORFILL(red,green,blue)

 See the Operator Documentation 
 a=COLORIZE(hue,saturation,luma,APPLY SATURATION)

 See the Operator Documentation 
 a=COMBINE(MODE)

 See the Operator Documentation 
 a=CONCENTRIC(cycle,xbias,ybias,SMOOTH)

 See the Operator Documentation 
 a=CONTOUR(red, green, blue, b_red, b_green, b_blue, PLACE_BACKCOLOR, interval, EDGE_DETECTION)

 See the Operator Documentation 
 a=CONTRAST(percentage)

 See the Operator Documentation 
 a=CONVOLVE(tl,tc,tr,l,c,r,bl,bc,br,threshold,USE THRESHOLD,bias,TWO PASS)

 See the Operator Documentation 
 a=CRATER(impact,variance,seed,level,burrowing)

 See the Operator Documentation 
 a=DERIVATIVE(multiply level,SIGNED,ADDITIVE)

 See the Operator Documentation 
 a=DITHER(x,y,amount,seed,MONOCHROME)

 See the Operator Documentation 
 a=DOF(aperture)

 See the Operator Documentation 
 a=DOME(percentage)

 See the Operator Documentation 
 a=ENCRYPT("password") *[password must be 8 or more characters]

 See the Operator Documentation 
 a=ENTRAIN(precipitation,sea level,erosion,sediment)

 See the Operator Documentation 
 a=EXPBLUR(length,amount)

 See the Operator Documentation 
 a=EXFOLIATE(stress,amount)

 See the Operator Documentation 
 a=EXTEND(EDGETYPE,REPLACE,EDGEDIR[0-3],distance,red,green,blue)

 See the Operator Documentation 
 FALSEC

 See the Operator Documentation 
 a=FILMGRAIN(width,height,intensity,seed,POLYCHROMATIC)

 See the Operator Documentation 
 a=FIRE(length, direction, propogation, seed, lat structure, lat turbidity, lng structure, lng turbidity, wobbles, wobble amt, distortion, ADDITIVE, br, bg, bb, mr, mg, mb, er, eg, eb, tr, tg, tb)

 See the Operator Documentation 
 a=FLATMAP(cliff thresh,sea level)

 See the Operator Documentation 
 a=FLICKER(seed,prob(1/X),max,min)

 See the Operator Documentation 
 a=FLIP(H,V)

 See the Operator Documentation 
 FORCED

 See the Operator Documentation 
 a=FRATE(P1,P2,P3[0-2])

 See the Operator Documentation 
 a=GAMMA(P)

 See the Operator Documentation 
 a=GEL(RED,GREEN,BLUE)

 See the Operator Documentation 
 a=ELEVATIONS(sealevel,shading percentage,USE_LOADED_PALETTE)

 See the Operator Documentation 
 a=GLARE(REDUCE,amount)

 See the Operator Documentation 
 a=GOUACHE(radius,intensity)

 See the Operator Documentation 
 a=GRID(xwidth, ywidth, PRIORITY[0-2], lineweight, start, NUMBERPRIORITY, NEWIMAGE, NUMBER_EVERY_INTERSECTION, number r,g,b, grad r,g,b, background r,g,b, border r,g,b)

 See the Operator Documentation 
 a=HARDALPHA(threshold,amount)

 See the Operator Documentation 
 a=HISTO(GATHER)

 See the Operator Documentation 
 a=HUE(P)

 See the Operator Documentation 
 a=HREMOVE(MODE,R/H,G/S,B/V,1/A)

 See the Operator Documentation 
 INVALPHA

 See the Operator Documentation 
 a=JITTER(seed,DIRECTION[0-2],probablility,spoke interval,max spokes,interstitial width,R,G,B,A)

 See the Operator Documentation 
 a=JULIA(p1,p2,zoom,xpan,ypan,palette offset,LAMBDA)

 See the Operator Documentation 
 a=KALEIDO(mirrors,ROTATIONAL,angle)

 See the Operator Documentation 
 a=KEYIN(red,green,blue,rdev,gdev,bdev,KEY ON SOURCE,INVERSE,SOFT)

 See the Operator Documentation 
 a=KEYTOALPHA(INVERT,SOFT,red,green,blue,rdev,gdev,bdev)

 See the Operator Documentation 
 a=LANDCLIFF(CLIFFING,steepness)

 See the Operator Documentation 
 a=LANDHAZE(hazelevel,fog linearity)

 See the Operator Documentation 
 a=LANDROT(x,y,z,lx,ly,lz)

 See the Operator Documentation 
 a=LANDSCALE(x,y,z)

 See the Operator Documentation 
 a=LANDSCAPE(elevation,palette_mix,grid_scale,WIREFRAME)

LANDSCAPE() is the command that actually runs the operator. Before you call LANDSCAPE(), you should call these functions that set up the other LANDSCAPE() variables:

LANDWATER(WAVES,level,skyreflect)
LANDTEXT(separation,tex depth,cam depth,TEXTURING,STEREO,PERSPECTIVE,ambient)
LANDSCALE(x,y,z)
LANDROT(x,y,z,lx,ly,lz)
LANDHAZE(hazelevel,fog linearity)
LANDCLIFF(CLIFFING,steepness)

These functions may be called in any order, except that LANDSCAPE() must be called last.

 See the Operator Documentation 
 a=LANDTEXT(separation,tex depth,cam depth,TEXTURING,STEREO,PERSPECTIVE,ambient)

 See the Operator Documentation 
 a=LANDWATER(WAVES,level,skyreflect)

 See the Operator Documentation 
 a=LIGHTNING(width,direction,branching,seed,zag,red,green,blue,saturation,glow,taper,ADDITIVE)

 See the Operator Documentation 
 a=LINED(red,green,blue,PLACE BACK,rback,gback,bback,height)

 See the Operator Documentation 
 a=LINFILL(angle,cycle,SMOOTH)

 See the Operator Documentation 
 a=MAKEALPHA(MASK WITH SOURCE LUMA,MASK_WITH_EXISTING_ALPHA,MODE,fill value)

 See the Operator Documentation 
 a=MAKEAREA(UPDATE_TIMELINE_WITH_AREA)

 See the Operator Documentation 
 a=MAKEFIELDS(DOMINANCE,REPLACE)

 See the Operator Documentation 
 a=MELT(amount,DIRECTION[0-3],start,end)

 See the Operator Documentation 
 a=MANDELBROT(p1,p2,zoom,xpan,ypan,palette offset)

 See the Operator Documentation 
 a=MAXIMUM(MODE[0-6],AFFECT_ONLY_ALPHA)

 See the Operator Documentation 
 a=MERGE(WARP,REFLECT,TILE)

 See the Operator Documentation 
 a=MINIMUM(MODE[0-6],AFFECT_ONLY_ALPHA)

 See the Operator Documentation 
 a=MIRROR(angle)

 See the Operator Documentation 
 a=MONOCHROME(MODE)

 See the Operator Documentation 
 a=MOTIONBLUR(length,direction,amount)

 See the Operator Documentation 
 MULTIPLY

 See the Operator Documentation 
 a=NEGATIVE(MODE[0-5],CHAN1(r/h/c),CHAN2(g/s/m),CHAN3(b/v/l/y),CHAN4(k))

 See the Operator Documentation 
 a=NET(red,green,blue,width,height,hori move, vert move,line width)

 See the Operator Documentation 
 a=NLOG(exp)

 See the Operator Documentation 
 a=NTSC(FILTER,LIMIT)

 See the Operator Documentation 
 a=OIL(P)

 See the Operator Documentation 
 a=OUTFILL(width,generations,cycles,INSIDE,SMOOTH,REPEAT,CRYSTAL)

 See the Operator Documentation 
 a=PAGECURL(shadow,v-priority,corner[0-3],transparency,exr,exg,exb,hir,hig,hib,ALPHA)

 See the Operator Documentation 
 a=PARTICLES("root:\path\filename.psy")

 See the Operator Documentation 
 a=PERSPECTIVE(xrot,yrot,zrot,xpos,ypos,zpos,hzoom,vzoom)

 See the Operator Documentation 
 a=PIXELIZE(red,green,blue,width,height,edge)

 See the Operator Documentation 
 a=PLACE(MODE)

 See the Operator Documentation 
 Plug-Ins

Since a plug-in may have up to 67 parameters (though this is unlikely), we use a fairly flexible approach to get at individual parameters without getting too complex with function arguments.

With the exception of the radio button sets, the various types of plug-in settings are arranged either left to right or top to bottom. The "which" parameters below specify which unit, left to right or top to bottom. For instance, a=PUCHECK(2,1) checks the second checkmark from the left.

The radio buttons are arranged as the set of 8, the two sets of four, and the two sets of two. Left-to right ordering applies to both the sets of four and the sets of two.

The following functions may be used to set up any portion of a plug-in function:

a=LOADPLUG("path_and_file.wis")
a=PUPALNC(Number_of_Colors_In_Palette[2-1024])
a=PUSTRING(which_string[0-1],"string")
a=PURADIO(which_radio[0-4],selection[0-7])
a=PUCHECK(which_check[0-7],VALUE)
a=PUFLOAT(which_float[0-7],value)
a=PUINTEGER(which_int[0-7],value)
a=PUPROFILE(which_profile[0-11],index[0-200],value[0-255])
a=PURGBA(which_rgba[0-3],r,g,b,a)
a=PUPALRGB(which_palette[0-1],index[0-1023],r,g,b)
a=PUCMD(command_number[0-29]) (immediately executes command button)

Once the plug-in function is set up, call this to run it:

a=PLUGIN()

 See the Operator Documentation 
 POLARREC

 See the Operator Documentation 
 a=PROMOTERGB(RED,GREEN,BLUE,GREY,INVERT)

 See the Operator Documentation 
 PSEUDO

 See the Operator Documentation 
 a=RADIAL(cycle,xbias,ybias,SMOOTH)

 See the Operator Documentation 
 a=RADWAVE(distortion,frequency,halfwaves,radius,phase,shading)

 See the Operator Documentation 
 a=RAYTRACE(ANTIALIAS,recursion levels,"tracepath","tracefile")

 See the Operator Documentation 
 a=REFRACT(rotation)

 See the Operator Documentation 
 a=RELIEF(percentage)

 See the Operator Documentation 
 a=REMAP(offset,nearness)

 See the Operator Documentation 
 a=REMOVE(samples)

 See the Operator Documentation 
 a=RIC(percentage, size)

 See the Operator Documentation 
 a=RIP(TL,TC,TR,L,R,BL,BC,BR,RTL,RTC,RTR,RL,RR,RBL,RBC,RBR,threshold,MODE[0-6],IGNORE WORST)

 See the Operator Documentation 
 a=RIS(v-percent, h-percent)

 See the Operator Documentation 
 a=ROLL(x,y,WARPSCROLL)

 See the Operator Documentation 
 a=ROTATE(degrees,IN-PLACE)

 See the Operator Documentation 
 a=RTILE(red,green,blue,h size,v size,x move,y move,size change,line width)

 See the Operator Documentation 
 a=RULER(ALIGN,offset,start,NUMPRI,NEWIMAGE,nr,ng,nb,na,gr,gg,gb,ga,bar,bag,bab,baa,bor,bog,bob,boa)

 See the Operator Documentation 
 a=SAMPLE(MAKE KEY COLOR,INCLUDE EXTREMES)

 See the Operator Documentation 
 a=SAMPLEA(MODE[0-2])

 See the Operator Documentation 
 a=SAT(percentage)

 See the Operator Documentation 
 a=SCANLINE(ODD,width)

 See the Operator Documentation 
 a=SHARPEN(percentage,width)

 See the Operator Documentation 
 a=SHAVE(severity,DIRECTION[0-2])

 See the Operator Documentation 
 a=SHAVEALPHA(percentage)

 See the Operator Documentation 
 a=SHEAR(amount,base,WRAP,ALPHA)

 See the Operator Documentation 
 a=SHINE(width,height,amount,threshold)

 See the Operator Documentation 
 a=SOFTENA(percentage)

 See the Operator Documentation 
 SOLARIZE

 See the Operator Documentation 
 a=SPERCENT(x%,y%,REPLACE,MODE)

 See the Operator Documentation 
 a=SPIRALBLUR(radius,rotation,amount)

 See the Operator Documentation 
 a=SPIXEL(x,y,REPLACE,MODE)

 See the Operator Documentation 
 a=STABILIZE(Poi X, Poi Y,Disp x,Disp y,EDGES SETTING,red,green,blue,alpha,TILE=0 or STRETCH=1) Note that only when the EDGES SETTING is set to 0 will the colors make a difference, but the scripting engine requires all parameters so these must be set.

 See the Operator Documentation 
 a=STAPP(ABS,HUE,SMOOTHING)

 See the Operator Documentation 
 a=STBARREL(pour,reseed,norep,reverse,zero,random,seed)

 See the Operator Documentation 
 a=STFADE(MODE[0-4])

 See the Operator Documentation 
 a=STFLIP(seed,RESEED,HMETHOD[0-2],VMETHOD[0-2])

 See the Operator Documentation 
 a=STPAL(SMOOTH,WRAP)

 See the Operator Documentation 
 a=STPOS(spacing,roughness,seed,RESEED,GHOSTWRITE)

 See the Operator Documentation 
 a=STROKE()

STROKE() is the command that actually runs the operator. Before you call STROKE(), you should call these functions that set up the other STROKE() variables:

STAPP(ABS,HUE,SMOOTHING)
STBARREL(pour,reseed,norep,reverse,zero,random,seed)
STFADE(MODE[0-4])
STFLIP(seed,RESEED,HMETHOD[0-2],VMETHOD[0-2])
STPAL(SMOOTH,WRAP)
STPOS(spacing,roughness,seed,RESEED,GHOSTWRITE)
STROTATE(rot1,rot2,seed,RESEED,METHOD[0-5])
STSHADOW(ON,level,soft,xo,yo)
STSIZING(size1,size2,seed,RESEED,METHOD[0-4])

 See the Operator Documentation 
 a=STROTATE(rot1,rot2,seed,RESEED,METHOD[0-5])

 See the Operator Documentation 
 a=STSHADOW(ON,level,soft,xo,yo)

 See the Operator Documentation 
 a=STSIZING(size1,size2,seed,RESEED,METHOD[0-4])

 See the Operator Documentation 
 a=SUBTRACT(MODE)

 See the Operator Documentation 
 a=SURFWARP(direction,amount,mid level,shading)

 See the Operator Documentation 
 a=SWAPRGBA(MODE[1-6])

 See the Operator Documentation 
 a=SWIRL(degrees)

 See the Operator Documentation 
 a=TEXTURE(type,SCROLL[0-4],ILLUMINATE,T-variance,detail,resolution,seed,depth,turb,CLASS[0-2],lo thresh,hi thresh,MAX DYNAMIC,INVERT,OVERWRITE)

 See the Operator Documentation 
 a=TILER(n,m,framex,framey,PRIORITY,scaling,ALIGN)

 See the Operator Documentation 
 TOONIZE

 See the Operator Documentation 
 a=TRANSITION(time[0.0-1.0],PRIORITY[0,1,2],SCALE,"path","filename")

 See the Operator Documentation 
 a=TRUNCATE(MODE[0-7],RED,GREEN,BLUE,ALPHA,value)

 See the Operator Documentation 
 a=TURBULENCE(swirls,swirliness,movement,seed)

 See the Operator Documentation 
 a=TURN90(MODE[0-3])

 See the Operator Documentation 
 a=VALUE(percentage)

 See the Operator Documentation 
 a=VARIANCE(multiply,width,ADDITIVE)

 See the Operator Documentation 
 a=VREMOVE(MODE,R/H,G/S,B/V,1/A)

 See the Operator Documentation 
 a=WATERCOLOR(percentage[0-100])

 See the Operator Documentation 
 a=WAVES(xwaves,xfront,xside,ywaves,yfront,yside,shading,xphase,yphase)

 See the Operator Documentation 
 WONK

 See the Operator Documentation 
Keyboard Navigation
, Previous Page . Next Page t TOC i Index o Operators g Glossary
WinImages F/x, Morph and all associated documentation
Copyright © 1992-2007 Black Belt Systems ALL RIGHTS RESERVED Under the Pan-American Conventions
WinImages F/x Manual Version 7, Revision 6, Level A

Valid HTML 4.01 Loose
 

This manual was generated with wtfm
wtfm uses aa_macro and SqLite
aa_macro uses python 2.7
Page 261