Environment (IDE)

The Processing Environment includes a text editor, a compiler, and a display window. It enables the creation of software within a carefully designed set of constraints.

Overview

The Processing Development Environment (PDE) makes it easy to write Processing programs. Programs are written in the Text Editor and started by pressing the Run button. In Processing, a computer program is called a sketch. Sketches are stored in the Sketchbook, which is a folder on your computer.

Sketches can draw two- and three-dimensional graphics. The default renderer is for drawing two-dimensional graphics. The P3D renderer makes it possible to draw three-dimensional graphics, which includes controlling the camera, lighting, and materials. The P2D renderer is a fast, but less accurate renderer for drawing two-dimensional graphics. Both the P2D and P3D renderers are accelerated if your computer has an OpenGL compatible graphics card.

The capabilities of Processing are extended with Libraries and Tools. Libraries make it possible for sketches to do things beyond the core Processing code. There are hundreds of libraries contributed by the Processing community that can be added to your sketches to enable new things like playing sounds, doing computer vision, and working with advanced 3D geometry. Tools extend the PDE to help make creating sketches easier by providing interfaces for tasks like selecting colors.

Processing has different programming modes to make it possible to deploy sketches on different platforms and program in different ways. The Java mode is the default. Other programming modes may be downloaded by selecting "Add Mode..." from the menu in the upper-right corner of the PDE.

Processing Development Environment (PDE)

The Processing Development Environment (PDE) consists of a simple text editor for writing code, a message area, a text console, tabs for managing files, a toolbar with buttons for common actions, and a series of menus. The menus options change from mode to mode. The default Java mode is documented here.

Programs written using Processing are called sketches. These sketches are written in the text editor. It has features for cutting/pasting and for searching/replacing text. The message area gives feedback while saving and exporting and also displays errors. The console displays text output by Processing sketches including complete error messages and text output from sketches with the print() and println() functions. (Note that the console works well for occasional messages, but is not intended for high-speed, real-time output.)

The buttons on the toolbar can run and stop programs,

Run
Runs the sketch. In Java mode, it compiles the code and opens a new display window.
Stop
Terminates a running sketch.

Additional commands are found within the six menus: File, Edit, Sketch, Debug, Tools, Help. The menus are context sensitive which means only those items relevant to the work currently being carried out are available.

File

New
Creates a new sketch in a new window, named as the current date is the format `sketch_YYMMDDa`.
Open...
Open a sketch in a new window.
Open Recent
Select a sketch to open from the list of recently closed sketches.
Sketchbook...
Open a new window to show the list of sketches in the sketchbook.
Examples...
Open a new window to show the list of the examples.
Close
Close the sketch in the frontmost window. If this is the last sketch that's open, you will be prompted whether you would like to quit. To avoid the prompt, use Quit instead of Close when you want to exit the application.
Save
Saves the open sketch in it's current state.
Save as...
Saves the currently open sketch, with the option of giving it a different name. Does not replace the previous version of the sketch.
Export
Exports a Java application as an executable file and opens the folder containing the exported files.
Page Setup
Define page settings for printing.
Print (Ctrl+P)
Prints the code inside the text editor.
Preferences
Change some of the ways Processing works. (This item is located in the Processing menu on Mac OS X.)
Quit
Exits the Processing Environment and closes all Processing windows. (This item is located in the Processing menu on Mac OS X.)

Edit

Undo
Reverses the last command or the last entry typed. Cancel the Undo command by choosing Edit » Redo.
Redo
Reverses the action of the last Undo command. This option is only available if there has already been an Undo action.
Cut
Removes and copies selected text to the clipboard (an off-screen text buffer).
Copy
Copies selected text to the clipboard.
Copy as HTML
Formats code as HTML in the same way it appears in the Processing environment and copies it to the clipboard so it can be pasted somewhere else.
Paste
Inserts the contents of the clipboard at the location of the cursor, and replaces any selected text.
Select All
Selects all of the text in the file which is currently open in the text editor.
Auto Format
Attempts to format the code into a more human-readable layout. Auto Format was previously called _Beautify_.
Comment/Uncomment
Comments the selected text. If the selected text is already commented, it uncomments it.
Increase Indent
Indents the selected text two spaces.
Decrease Indent (Ctrl+[)
If the text is indented, removes two spaces from the indent.
Find...
Finds an occurence of a text string within the file open in the text editor and gives the option to replace it with a different text.
Find Next
Finds the next occurence of a text string within the file open in the text editor.
Find Previous
Finds the previous occurence of a text string within the file open in the text editor.
Use Selection for Find
Sets the currently selected text as the item to find with Find Next and Find Previous.

Sketch

Run
Runs the code (compiles the code, opens the display window, and runs the sketch inside)
Present
Runs the code in the center of the screen with a solid-color background. Click the "stop" button in the lower left to exit the presentation or press the Escape key. Change the background color in the Preferences.
Tweak
Runs the code in a way where some color and variable values can be changed while the code is running. The sketch needs to be saved before it can be run as a sketch to Tweak.
Stop
If the code is running, stops the execution. Programs written without using the draw() function are stopped automatically after they draw.
Import Library
Adds the necessary import statements to the top of the current sketch. For example, selecting Sketch » Import Library » pdf adds the statement "import processing.pdf.\*;" to the top of the file. These import statements are necessary for using Libraries. Select Add Libraries... to open the Library Manager to browse and install new libraries.
Show Sketch Folder
Opens the folder for the current sketch.
Add File...
Opens a file navigator window. Select an image, font, or other media files to add it to the sketch's "data" folder.

Debug

Enable Debugger
Activates the debugger. Note that the Run button will change to Debug. New Continue and Step buttons will appear, along with a separate window for viewing variable values.
Continue
Advances the code until the next breakpoint.
Step
Advances the code one line at a time. (Note that once the code reaches the end of the current function call, the debugger will rever to "continue.")
Step Into
Advances the debugger into the interior of a function call. This only works for user-defined functions in the sketch.
Step Out
Advances the debugger outside of a function to the calling area. This only works for user-defined functions in the sketch.
Toggle Breakpoint
Add or remove a breakpoint. When a breakpoint is added, the line number is replaced with the symbol: `<>`.

Tools

Create Font...
Converts fonts into the Processing font format (VLW) and adds to the current sketch. Opens a dialog box that gives options for setting the font, its size, if it is anti-aliased (smooth), and which characters to be generated. The amount of memory required for the font is determined by the size selected and the number of characters selected through the "Characters..." menu; Processing fonts are textures, so larger fonts require more image data. Fonts can also be created in the code with the createFont() function.
Color Selector...
Interface for selecting colors. For each color, the HSB, RBG, and Hex values are shown. The Hex value can be copied into the clipboard with the Copy button.
Archive Sketch
Archives a copy of the current sketch in .zip format. The archive is placed in the same folder as the sketch.
Install "processing-java"
Installs the processing-java program to make it possible to build and run Java mode sketches from the command line.
Movie Maker
Creates a QuickTime movie from a sequence of images. Options include setting the size, frame rate, and compression, as well as an audio file.
Add Tool...
Opens the Tool Manager to browse and install new Tools.

Help

Environment
Opens the reference for the Processing Development Environment (this page) in the default web browser.
Reference
Opens the reference in the default web browser. Includes references for the language, programming environment, and core libraries.
Find in Reference
Select an element of the Processing language in the text editor and select Find in Reference to open that page in the default web browser.
Libraries Reference
Select from the list to open the reference for compatiable Libraries.
Tools Reference
Select from the list to open the reference for compatiable Tools.
Getting Started
Opens the online Getting Started tutorial in the default browser.
Troubleshooting
Opens the online Troubleshooting wiki page in the default browser.
Frequently Asked Questions
Opens the online FAQ wiki page in the default browser.
The Processing Foundation
Opens the Foundation website in the default browser.
Visit Processing.org
Opens Processing website in the default browser.

Preferences

The Processing Development Environment (PDE) is highly configurable. The most common preferences can be modified in the Preferences window, located in the File menu on Windows and Linux and in the Processing menu on Mac Os X. The full list of preferences are stored in the "preferences.txt" file. This file can be opened and edited directly only when Processing is not running. You can find the location of this file on your computer by reading the bottom-left corner of the Preferences window.

Sketchbook location
Any folder can be used as the Sketchbook. Input a new location or select "Browse" to set the folder you want to use.
Language
Select the language to use for the menus. Processing needs to be restarted after making a new selection.
Editor and Console font
Select a different font to use for text in the Editor and Console. Note: the selected font should match the language used in the Text Editor. See the "Enable complex text input" preference below.
Editor font size
Sets the font size of the code in the text editor.
Console font size
Sets the font size of the text in the console.
Background color when Presenting
Defined the background color used when a sketch is run with Present.
Use smooth text in editor window
By default, the text in the editor is aliased. When checked, the editor switches to an anti-aliased (smoothed) font. Restart Processing after making this change.
Enable complex text input
Enables the Text Editor to display non-Latin fonts such as Japanese. Processing needs to be restarted after making this selection.
Continuously check for errors and Show warnings
Turn on and off the features that continuously check for and report potential code errors.
Code completion with Ctrl-space
Turn on and off code completion. Press Ctrl-space to activate code completion while typing.
Suggest import statements
When checked, Processing will try to suggest libraries to import when code from that library is detected.
Increase maximum available memory
Allocates more RAM to Processing sketches when they run. Sketches that use media files (images, audio, etc.) sometimes require more RAM. Increase the amount of RAM if a sketch is throwing Out of Memory Errors.
Delete previous folder on export
When checked (default behavior), Processing deletes the complete export folder before re-creating it and adding the new media.
Check for updates on startup
When checked (default behavior), you'll be informed of new Processing software releases as they become available through a small dialog box that opens as Processing starts.
Run sketches on display
If more than one monitor is attached, select the monitor on which to display the sketch.

Sketches and Sketchbook

All Processing projects are called sketches. Each sketch has its own folder. The main file for each sketch has the same name as the folder and is found inside. For example, if the sketch is named "Sketch_123", the folder for the sketch will be called "Sketch_123" and the main file will be called "Sketch_123.pde". The PDE file extension is an acronym for the Processing Development Environment

Processing sketches can be stored anywhere on your computer, but by default they are stored in the sketchbook, which will be in different places on your computer or network depending if you use PC, Mac, or Linux and how the preferences are set. To locate this folder, select the "Preferences" option from the File menu (or from the "Processing" menu on the Mac) and look for the"Sketchbook location."

A sketch folder sometimes contains other folders for media files and other code. When a font or image is added to a sketch by selecting "Add File..." from the Sketch menu, a "data" folder is created. Files may also be added to your Processing sketch by dragging them into the text editor. Image and sound files dragged into the application window will automatically be added to the current sketch's "data" folder. All images, fonts, sounds, and other data files loaded in the sketch must be in this folder.

Renderers

Processing has four built-in screen renderers. The default renderer is for drawing two-dimensional shapes. P2D is a faster, but less accurate renderer for drawing two-dimensional shapes. P3D is for three-dimensional geometry; it can also control the camera, lighting, and materials. The P2D and P3D renderers are accelerated if your computer has an OpenGL compatible graphics card. The smooth() function affects the amount of antialiasing for each renderer. Check the reference for smooth() for more information.

With the release of Processing 3.0, the FX2D renderer is included. Use it for fast 2D graphics on large and high resolution displays for more speed than the default renderer. This renderer is still experimental, but it useful for certain conditions.

The renderer used for each sketch is specified through the size() function. If a renderer is not explicitly defined in size(), it uses the default renderer as shown in the following program:

void setup() {
  size(200, 200);
}

void draw() {
  background(204);
  line(width/2, height/2, mouseX, mouseY);
}

To change the renderer, add a third parameter to size(). For example

void setup () {
  size(200, 200, P2D);
}

void  draw() {
  background(204);
  line(width/2, height/2, mouseX, mouseY);
}

A large effort has been made to make Processing code behave similarly across the different renderers, but there are currently some inconsistencies that are explained in the reference.

For more information, see the size() reference entry.

Coordinates

Processing uses a Cartesian coordinate system with the origin in the upper-left corner. If your sketch is 320 pixels wide and 240 pixels high, coordinate (0, 0) is the upper-left pixel and coordinate (320, 240) is in the lower-right. The last visible pixel in the lower-right corner of the screen is at position(319, 239) because pixels are drawn to the right and below the coordinate.

Using the three-dimension coordinate system of P3D, the z-coordinate is zero at the surface of the image, with negative z-values moving back in space. When drawing in 3D, the camera is positioned in the center of the screen.

Tabs, Multiple Files, and Classes

It can be inconvenient to write a long program within a single file. When Processing sketches grow to hundreds or thousands of lines, breaking them into modular units helps manage the different parts. Processing manages files with the Sketchbook and each sketch can have multiple files that are managed with tabs.

The arrow button to the right of the tabs in the Processing Development Environment is used to manage these files. Click this button to reveal options to create a new tab, rename the current tab, and delete the current tab. Tabs are intended for more advanced users, and for this reason, the menu that controls the tabs is intentionally made less prominent.

Advanced

When a program with multiple tabs is run, the code is grouped together and the classes in other tabs become inner classes. Because they're inner classes, they cannot have static variables. Simply place the "static" variable outside the class itself to do the same thing (it need not be explicitly named "static" once you list it in this manner). If you don't want code to be an inner class, you can also create a tab with a ".java" suffix, which means it will be interpreted as straight java code. It is also not possible to use static classes in separate tabs. If you do this, however, you'll need to pass the PApplet object to that object in that tab in order to get PApplet functions like line(), loadStrings() or saveFrame() to work.

Debug

The Processing Debugger is a tool for diagnosing problems with a sketch. Enable it to pause a sketch while running and advance through the code one line at a time. The debugger is enabled through the File menu (Debug > Enable Debugger) or by clicking the Debugger icon, the butterfly in the upper-right corner of the PDE.

When the Debugger is enabled, the program runs as normal, but stops at "breakpoints." To create a breakpoint, set the cursor at the line you want to pause the sketch and select Debug > Toggle Breakpoint. The keyboard shortcut is Command-B. To remove the breakpoint, select Toggle Breakpoint again. When a breakpoint is added, the line number is replaced with the symbol: <>.

Running the sketch in Debug mode causes the sketch to pause at any breakpoints. When paused, current variable values are visible in a separate pane. You can advance to the next breakpoint by selecting "Continue" or advance line by line through the code with "Step". Stepping only works within the scope of the current function being run.

Programming Modes

Processing has different programming modes to make it possible to deploy sketches on different platforms and program in different ways. The current default programming mode is Java mode. Other programming modes such as Android Mode and Python are added by selecting "Add Mode..." from the menu in the upper-right corner of the PDE.

Java Mode

This mode makes it possible to write short programs to draw to the screen, but also enables complex Java programs as well. It can be used simply by beginners, but it scales to professional Java software development. Sketches written in this mode can be exported as Java Applications to run on Linux, Mac OS X, and Windows operating systems.

Advanced

Java files with the extension .java can be included with a Java mode sketch. They may be created directly in the PDE or copied into the sketch folder through the "Add File..." item in the Sketch menu or dragged into the text editor. It's possible to write any Java code in files with the .java extension. In fact, complete Java code can be written from inside the Processing Environment by subclassing PApplet like this:

public class MyDemo extends PApplet {

This is for advanced developers only and is not really recommended. Using this technique means that any additional tabs will no longer be inner classes, meaning you'll have to do extra work to make them communicate properly with the host PApplet. It is not necessary to use this technique just to get features of the Java language. Advanced developers can also program with Processing in another Java Editor if higher-level code editing and tools are needed. Processing's core.jar can be used as a part of any Java project.

Adding Libraries, Tools, and Modes

Processing 3.0 includes a set of features to make it easier to install, update, and remove Libraries, Tools, Modes, and Examples.

Add a contributed library by selecting "Add Library..." from the "Import Library..." submenu within the Sketch menu. This opens the Library Manager. Next, select a library and then click on Install to download it.

Add a contributed tool by selecting "Add Tool..." from the Tools menu, then select a Tool to download from the Tool Manager.

Add contributed modes by selecting "Add Mode..." from the Mode menu in the upper-right corner of the PDE, then select a Mode to install.

Add contributed Examples by first opening the "Examples..." submenu from the File menu. Click on the Add Examples button to open the Examples Manager. Next, select an examples package and select Install to download.

Export

The Export information and Tips page on the Processing Wiki covers the details of exporting Applications from Java mode.