Return to ImageFX page.
Return to home.

ImageFX CLI and Tooltypes


IMP "Variables"
There are some special identifiers you can place into an IMP prep or proc string that will be replaced when the batch is run. All identifiers begin with a "$" symbol. Case is not important.


$(<start>,<end>)
Calculates the value between <start> and <end> that corresponds to the current frame number. Used to vary an effect parameter over time. EG: "Sharpen $(10,128)" will vary the sharpen parameter from 10 to 128 over the course of the IMP batch.

$[<start>,<end>]
Almost identical to $(<start>,<end>) above, but in this format the <end> value is never reached. This is useful when constructing looping animations. EG: "Rotate $[0,360]" will create a 360-degree rotation over the course of the batch, without creating a "hitch" at the loop point.

$F
Current frame number.

$S
Starting frame number.

$E
Ending frame number.

$1
Source 1 name.

$2
Source 2 name.

$D
Destination name.




ImageFX Tool Types


ASPECTADJUST=<num>
Aspect ratio correction for aspect lock. Values greater than 1.0 adjust the image wider, values less than 1.0 adjust the image taller.

ASSIGN=<assign_name:>
Select the Assign name for the directory where ImageFX resides.

ASYNCHELP (2.1)
Enable asynchrounous help windows for the Workbench ImageFX.

DRAWMODEPATH=<directory>
Select the directory where draw modes reside.

FILETYPE=IMAGE
Identifies a file as an image that may be loaded automatically by Workbench extended selection.

FONTNAME=<name.font>
Name of font to use for ImageFX display. Must also use FONTSIZE.

FONTSIZE=<size>
Size of font to use for ImageFX display. Must also use FONTNAME.

GTCOMPLIANT
When specified, cycle gadgets perform exactly as GadTools cycle gadgets. (That is, clicking anywhere in the gadget cycles up, shift-clicking anywhere in the gadget cycles down.)

HELP=<directory>
Select the directory where help text is located.

HOOK=<file>
Automatically run the given hook upon starting ImageFX.

HOOKEXIT
Exit ImageFX upon completion of an automatically run hook. Generally not useful unless you also specify HOOKSYNC.

HOOKSYNC
Specify that the startup hook should be run synchronously (ie. ImageFX is suspended until the hook completes).

ICONIFY
Start ImageFX iconified.

INITVMEMLATE
Do not initialize virtual memory RAM buffers until they are first required.

LEFTEDGE=<coord>
Select left edge of Workbench ImageFX. Only useful in conjunction with the WORKBENCH tool type.

LOADERPATH=<directory>
Select the directory where loader modules are located.

MACRO=<file>
Launch the given Arexx macro automatically upon startup.

NOASYNCHELP
Disable asynchrounous help windows in the Workbench ImageFX. This is the default in ImageFX 2.1.

NOATTACHEDSCREENS
Under OS 3.x, opens all ImageFX screens separately instead of attached together.

NOSTARTUP
Do not start the default startup Arexx macro.

NOWBPREVIEW
Disable preview capability in the Workbench ImageFX.

PALETTE=<file>
Select the palette file to load upon startup.

PREFS=<file>
Select the prefs file to load upon startup.

PREVIEW=<file>
Select the preview module to load upon startup.

PRINTER=<file>
Select the printer module to load upon startup.

PUBSCREEN=<name>
Select the name of the public screen on which to open the Workbench version of ImageFX. Only useful in conjunction with the WORKBENCH tool type.

QUANTIZE=<file>
Select the quantize module to load upon startup.

QUIET
Disable the status indicator window on startup.

RENDER=<file>
Select the render module to load upon startup.

SAVERPATH=<directory>
Select the directory where saver modules are located.

SCANNER=<file>
Select the scanner module to load upon startup.

TEXT=<directory>
Select the directory where localization text is located.

TOOLCONFIG=<file>
Select the toolbox configuration file to load upon startup.

TOPEDGE=<coord>
Select top edge of Workbench ImageFX. Only useful in conjunctionwith the WORKBENCH tool type.

WORKBENCH
Open ImageFX on Workbench instead of on its own screen.



ImageFX Command Line Arguments


Image, Prefs/K, Macro/K, NoStartup/S, WB/S, Iconify/S, Scanner/K,Render/K, Preview/K, Printer/K, Quantize/K, PubScreen/K, Text/K, Hook/K,HookExit/S, Assign/K, Quiet/S, NoWBPrev/S


Image
Select initial image to load.

Prefs/K
Select the prefs file to load upon startup.

Macro/K
Run an Arexx macro upon startup.

NoStartup/S
Disable startup Arexx macro.

WB/S
Run ImageFX on Workbench.

Iconify/S
Start ImageFX iconified.

Scanner/K
Select scanner module to load upon startup.

Render/K
Select render module to load upon startup.

Preview/K
Select preview module to load upon startup.

Printer/K
Select printer module to load upon startup.

Quantize/K
Select quantize module to load upon startup.

PubScreen/K
Name of public screen on which to open Workbench ImageFX.

Text/K
Directory where localization text resides.

Hook/K
Hook to execute upon startup.

HookExit/S
Exit ImageFX upon completion of startup hook.

Assign/K
Select the Assign name for the directory where ImageFX resides.

Quiet/S
Disable the status indicator window on startup.

NoWBPrev/S (2.1)
Disable preview capability in the Workbench ImageFX.



ImageFX Browser Tool Types


CYBERGRAPHICS (2.1)
Open Browser on a Cybergraphics screen. Requires Cybergraphics software.

DRAWER=<directory>
Initial drawer to scan.

GREYSCALE
Select a greyscale screen.

IMAGEFX=<command>
Select the command and arguments to run ImageFX.

MPEG=<command>
Select the command and arguments to run the MPEG player.

NOVERIFY
Disable verification requesters (eg. "are you sure you want to quit?").

RETINA (2.1)
Open Browser on a Retina screen. Requires RetinaEmu.

REXXDIR=<directory>
Select the directory where browser Arexx commands are found.

SCREENDEPTH=<bitplanes>
Screen depth, in bitplanes (eg. 4 is 16 colors, 8 is 256 colors).

SIZEGADGET (2.1)
Provide a sizing gadget when opened on a custom screen.

VIEWTEK=<command>
Select the command and arguments to run Viewtek.

WORKBENCH
Open browser on Workbench.



ImageFX Browser CLI Arguments

Drawer, ScreenDepth/N, Grey/S, ImageFX/K, Viewtek/K, Mpeg/K, WB/S, NoVerify/S


Drawer
Initial drawer to scan.

ScreenDepth/N
Screen depth, in bitplanes (eg. 4 is 16 colors, 8 is 256 colors).

Grey/S
Select a greyscale screen.

ImageFX/K
Select the command and arguments to run ImageFX.

Viewtek/K
Select the command and arguments to run Viewtek.

Mpeg/K
Select the command and arguments to run the MPEG player.

WB/S
Open browser on Workbench.

NoVerify/S
Disable verification requesters (eg. "are you sure you want to quit?").



CineMorph Tool Types and CLI Arguments

(There are none.)








(end of file)