Product documentation · Current desktop UI

Ophanim image editor tools

Ophanim has five high-level Python API operations: api.ophanim.capture_viewport(...), api.ophanim.open_image(...), and api.ophanim.capture_and_open(...), plus api.ophanim.actions() and api.ophanim.invoke(action, ...). The latter two expose a controlled set of 32 actions on an already open editor tab. Invocation requires the desktop UI thread; it never opens a new window. Sharing to Jira or Discord and applying a fix back to a DCC are outside this general action list.

available = api.ophanim.actions().unwrap()["value"]
result = api.ophanim.invoke("add_new_layer")  # from the desktop UI thread

Opening an editor or capturing a viewport requires a desktop session and the relevant source application. Editor actions are not usable in headless CI.

Documents and layers

  • Open and save images and layered projects.
  • Add, duplicate, delete, lock, and mask layers.
  • Add and edit text layers.
  • Copy or paste a selection into a new layer; crop to a selection.
  • Undo and redo editor actions.

Color and effects

  • Adjust brightness and contrast, curves and levels, hue and vibrance, exposure and gamma, and color balance.
  • Apply gradient maps and drop shadows.
  • Apply cel shading, sketch, sepia, pixel art, and posterize effects.
  • Invert a layer's colors or flip a normal map's green channel.

Texture and review workflows

  • Import a PBR texture set and export a channel-packed ORM texture.
  • Inspect PBR channels and perspective guides.
  • Capture a connected DCC viewport into a new document tab.
  • Send an image to a configured Jira issue or Discord destination from the desktop editor; this is an external action and needs user approval.

For signatures of the five public Python operations, search the Python API reference. Image-editing tools require the Ophanim desktop widget and may show dialogs. They are not available from a headless process merely because they appear here.

Scriptable actions on an open editor

Call these through api.ophanim.invoke(action, ...). Some actions show dialogs or require an active layer or selection.

  1. add_drop_shadow_layer · Effects
  2. add_new_layer · Layers
  3. add_text_layer · Layers
  4. align_active_smart_layer · Layers
  5. apply_brightness_contrast_adjustment · Color
  6. apply_cel_shaded_filter · Effects
  7. apply_color_balance_adjustment · Color
  8. apply_curves_levels_adjustment · Color
  9. apply_exposure_gamma_adjustment · Color
  10. apply_gradient_map · Color
  11. apply_hsv_vibrance_adjustment · Color
  12. apply_notebook_sketch_filter · Effects
  13. apply_pixel_art_filter · Effects
  14. apply_posterize_threshold · Effects
  15. apply_sepia_vintage_filter · Effects
  16. clear_selection · Selection
  17. copy_selection_to_new_layer · Selection
  18. crop_to_selection · Selection
  19. delete_active_layer · Layers
  20. delete_selected_pixels · Selection
  21. duplicate_active_layer · Layers
  22. edit_active_text · Layers
  23. export_channel_packed_orm · Textures
  24. flip_normal_map_green_channel · Textures
  25. import_pbr_texture_set · Textures
  26. invert_active_layer_colors · Color
  27. invert_selection · Selection
  28. paste_image_as_layer · Selection
  29. redo · History
  30. toggle_active_layer_lock · Layers
  31. undo · History