/gmic-8bf

An 8bf filter plug-in that interacts with G'MIC-Qt

Primary LanguageC++MIT LicenseMIT

gmic-8bf

A filter plug-in for Adobe® Photoshop®* and other compatible software that interacts with G'MIC-Qt.

The latest version can be downloaded from the Releases tab.

System Requirements

  • Windows* 7, 8, 10 or 11.
  • A compatible 32-bit (x86) or 64-bit (x64 or ARM64) host application.

Installation

  1. Close your host application.
  2. Place GmicPlugin.8bf and gmic folder in the folder that your host application searches for filter plug-ins.
  3. Restart your host application.
  4. The plug-in will now be available as the G'MIC-Qt menu item in the GMIC category.

Installing in Specific Hosts

The gmic-8bf project wiki provides installation instructions for several popular hosts.

Affinity Photo: Installing in Affinity Photo
Photoshop: Installing in Photoshop
XnView: Installing in XnView

Updating

Follow the installation instructions above and allow any existing files to be replaced.

Usage

To start the plug-in select the G'MIC-Qt item in the filter list of your host application. The following image shows the menu location in Adobe Photoshop.

Menu Location

G'MIC-Qt

When the G'MIC-Qt menu item is clicked it will start the G'MIC-Qt user interface.

G'MIC-Qt UI

While the plug-in supports the Grayscale image modes, many G'MIC effects will only work correctly in the RGB image modes (e.g. the various Colorize effects).

You can "layer" multiple G'MIC effects in a single session by clicking the Apply button. Note that only the most recently applied effect will be used when the plug-in is invoked through the "Last Filter" or "Repeat Filter" commands.

Filters that require multiple input images can only be used if the input settings have been configured to provide a second input image or the document has multiple layers and the host supports providing layers to the plug-in. Document layers are provided to plug-ins by Adobe Photoshop CS (8.0) and later (and possibly other Adobe applications), but 3rd-party hosts will most likely not support this feature due to the license restrictions added to the Photoshop SDK after version 6.0.

If the user has not configured a default output folder the plug-in will prompt the user to save the modified images after the G'MIC-Qt dialog has been closed in the following cases:

  1. When a filter produces multiple output images the plug-in will prompt the user for a folder to copy them into.
  2. When a filter changes the image size the plug-in will prompt the user to save the resized image.

Color Management

The G'MIC-Qt preview image will be color managed if the 8bf plug-in host software provides the image color profile to its plug-ins.

Note that there may still be some differences between the G'MIC-Qt filter preview and the output shown in the 8bf plug-in host.
The G'MIC-Qt preview uses Little CMS for color management, and the color management software used by the 8bf plug-in host may produce different colors.

Photoshop Actions

The plug-in will show the name of the G'MIC effect and the Input Mode in the actions palette.

Photoshop Actions palette

The Photoshop Actions support has a few compatibility issues:

  • G'MIC effects that produce multiple images or resize the image will save the results to external files, these files will have to be manually imported into Photoshop.
  • If you use the G'MIC-Qt ability to "layer" multiple effects in a single session, Actions will only remember the settings of the most recently applied effect.
  • The plug-in will always show its user interface.

Input/Output Settings for G'MIC-Qt

When the Input/Output Settings for G'MIC-Qt menu item is clicked it will start the Input/Output Settings for G'MIC-Qt user interface.

G'MIC-Qt Input/Output settings UI

Input Settings

This section allows a second input image to be sent to G'MIC-Qt for the filters that require one. The settings in this section will be ignored if the document has multiple layers and the host supports providing layers to plug-ins.

You can choose from one of the following options:

  • None (default)
    • The plug-in will only use the document layers for additional input images.
  • Clipboard
    • The plug-in will look for a second input image on the operating system clipboard.
  • File
    • The plug-in will use the specified image as the second input image.

Output Settings

This section allows users to set a default output folder for filters that produce multiple output images or resizes the output image. The output folder should default to a G'MIC-Qt folder in your Pictures folder, but it can be changed to any folder.
When this option is configured the plug-in will copy the output image(s) to the specified folder without prompting the user. A prompt will still be shown if there was an error loading the default folder setting.

License

This project is licensed under the terms of the MIT License.
See License.txt for more information.

Source code

Prerequisites

  • Visual Studio 2022
  • vcpkg
    • The dependencies listed in vcpkg.json will be installed as part of the build.
  • The Adobe Photoshop SDK, see the read-me in the ext folder for more details.

Building the plug-in

  • Open the solution in the vs folder
  • Update the post build events to copy the build output to the filters folder of your host application
  • Build the solution
* Adobe and Photoshop are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.
 Windows is a registered trademark of Microsoft Corporation in the United States and other countries.   
 All other trademarks are the property of their respective owners.