Home › Support › Digital › Kb

Toon Boom Digital Pro Knowledgebase


Search the Knowledgebase Browse by Category


Print this page Email this page Post a comment

  Can I import bitmap effects from outside program? (External module)

DP0011: Can I import bitmap effects from outside program? (External module)

Glossary
External Program: This is where you enter the command line of the external module that you want to bring it in. This field can include a full or relative path to the executable file. For example:
mogrify -spread $NUM $IN1
where mogrify is the name of the program, spread is the option to be applied, and $NUM and $IN1 are the numerical parameter and first input file variable declared in the External Module.

Program First Input File ($IN1): This is the file name and the location where you store it temporary for the effects. It actually creates a bitmap file based on that name on that location. Note: It must not include the dot or the extension; the External Module will add these based on the Extension field. For example, if the Extension is selected as TGA, then the file is created as TGA format. Ex, c:/test. In This case, the file test.tga will be created under c:/ drive and it will be used for the effects.

Program Second Input File ($IN2): when processing two files through this module (such as an image and a matte), this is the name and location of the second temporary file that Toon Boom Digital Pro writes to the file system for the external program to read. It must not include the dot o r the extension; the External Module will add these based on the Extension field.

Program Output File ($OUT): This should be the same location file where you have set for Program First Input file. Then it uses the temporary file that the external program will write to the file system so that Toon Boom Digital Pro can read it back into the network.

Extension ($EXT): This is the the file type that will be processed by the external program.

Numerical Parameter ($NUM): a value passed to the external program as a file processing option. It can be attached to a function curve to change over time.


When you want to import some bitmap effects from the outside of Digital Pro, you can use the External module to access more variable choice for the effects that Digital Pro has provided.

You can find this external module from the module library in filter tab.

As other module, top right node is reserved the drawing and the top left node is reserved for the matte. Note that this top left node is only used when the option of the external program is needed so. For the program that supports External module, you need to find one that supports the same channel as the external module supports. Here is the example of the application called Imagemagick. It is free and many of the effects options are working fine with External module. It is up to you to find one, but in this exercise, we are only focusing how the External module works with external program (Imagemagick). Before stepping further, you need to install Imagemagick (www.imagemagick.org).

The command line for Imagemagick is ‘mogrify’.

mogrify [options ...] file [ [options ...] file ...]

If you type mogrify from the terminal or command prompt, you will see all options available.

Here I have used spread for example and I have entered this value in the External module.
External Program: mogrify -spread $NUM $IN1
Program First Input File ($IN1): c:/test
Program Second Input File ($IN2):
Program Output File ($OUT): c:/test
Extension ($EXT): TGA4
Numerical Parameter ($NUM): 5

I have left Program Second Input File ($IN2) as black since it is not going to be used for this. Similarly you can use the charcoal effects by entering –charcoal.

Ex, mogrify -charcoal $NUM $IN1



  User Opinions

100% 0% (1 vote)

How would you rate this answer? Helpful Not helpful
Thank you for rating this answer.



  Visitor Comments

No visitor comments posted. Post a comment



  Related Questions

No related questions were found.



  Attachments

No attachments were found.