Sapphire Plug-ins v2023.0 for Photoshop, General User Info
- Mocha Improvements
- Metal Support for Aurora
- Metal Support for Median
- New LensFlares
- New UltraGlow presets
- Sometimes Sapphire will open with a previous node graph. If this happens, simply delete the nodes in the node graph and create a new one.
- For best results, please convert for Smart Filters before applying Sapphire.
- Time-based parameters aren't currently available.
In v2019, LensFlares using MutliSpot and MultiStreak elements would look different inside the Flare Designer across operating systems. In v2019.5 this was fixed, but as a result LensFlares may look different from v2019 when loaded through the Flare Designer. Old projects will continue to look the same as they did in v2019 when loaded into the host or rendered, but may look different after loading in the Flare Designer.
To load a plug-in in Photoshop, go to the Effects menu and open one of the Sapphire folders. You can double click on an effect to insert it into your current layer's effects, or drag it onto the desired location in your current layer.
All OpenColorIO information below applies both to Color Management within the Sapphire Preset Browser, Sapphire Effect and Transition Builder, and Sapphire Flare Designer as well as to the new OCIOTransform effect in Sapphire 2020.
To use OpenColorIO in Sapphire, there are three ways to specify the OpenColorIO configuration file.
- By default, Sapphire will use the config.ocio file found in Sapphire's installation directory.
To set OCIO system wide, set the OCIO environment variable to point to the desired config.ocio.
This will ensure that all host applications and plugins that use OCIO will use the same OCIO settings.
- We strongly suggest working with an IT department or IT professional to help setup environment variables, as there can be underlying conflicts with pre-existing settings.
- Open "File Explorer"
- Right-click on "This PC" and select "Properties"
- On the left, navigate to "Advanced system settings"
- At the bottom, click on "Environment Variables"
- In the top section labelled "User variables for...", click "New"
- In the dialog that pops up, enter "OCIO" in the "Variable name" box, and the full path to the config.ocio file in the "Variable value" box.
- Open a Terminal - This can be found using Spotlight
- Type: "launchctl setenv OCIO /full/macos/pathway/config.ocio" (without quotes). Note: this will not remain set after a reboot.
- To set the environment variable so that it persists through a reboot, the above command needs to be called through a .plist file in /Library/LaunchDaemons.
To set OCIO for Sapphire only, set the ocio_config flag inside the s_config
file that shipped with Sapphire and can be found in the Sapphire installation
- Windows: C:\Program Files\GenArts\SapphirePS\s_config.text
- Mac OS: /Applications/GenArtsSapphirePS/config/s_config.text
Loading:In the preset browser you'll see all the presets available for the current plug-in, both Boris FX-supplied presets and the ones you've created yourself. You can filter by tags on the left side to quickly find the look you're interested in.
The main top window shows the preset on your footage (unless the plug-in can't access the PS layer for some reason, in which case you'll see a poster frame) and various information about the preset.
At the bottom you see all the presets; you can enlarge or shrink them with the slider at the bottom. You can also switch to a table view there, as well as viewing the preset on your source, over black, or over the sample footage. You can also see the source all by itself for comparison.
If you are using the S_Effect plug-in, you can browse all the Sapphire presets at once. See S_Effect for more information.
Saving:Clicking Save Preset brings up the Save Preset dialog. Here you can name the preset, and add various other information. Particularly important is the tagging system; you can apply as many tags as you want to your presets. You can even create new tags. Tags are grouped into categories, so all the color names appear under Colors, for instance.
You can create new categories as well, by typing into the Category drop-down menu after clicking Add New Tag.... Boris FX recommends sticking to the shipped categories when possible, for compatibility. But adding your own tags within categories (new color names, for example) is encouraged.
While the preset browser, save dialog, or flare designer are open, the main PS window will be unresponsive. This is normal. Close the preset browser or flare designer and PS will wake up again.
Certain parameters, like Lens Flare hotspot, are not saved in presets; we thought it would be less than useful for the flares to jump around as you load presets.
It may take a few seconds to load the preset browser if a plug-in has many presets. Be patient.
The Preset Browser has a "Use Static Thumbnails" checkbox in certain effects. When checked, the thumbnails use a pre-rendered image to improve performance. If "Use Static Thumbnails" is not checked, the thumbnails will render on the footage the Sapphire effect has been applied to back in the host.
If playing through the preview window in the Preset Browser, Flare Editor, or Effect Builder, is using too much memory, "Render on Still" is available in the view menu. This will reduce the memory usage of the preview window by rendering all frames using the same host frame.
The preset browser may be configured to load presets from and/or save presets to user specified locations. The load location and save location may be different. If the locations are different, load will show presets from both the load location and the save location. Save will only use the specified save location.
There are three options for setting the load and save paths:
- To set load and save paths per user, use the "Browser Settings" dialog. To do this: open the preset browser, go to the Edit menu and select "Browser Settings".
To set the load and save paths for all users of the machine, use the INI file. To do this, edit the
sapphire-app-settings.ini file in the Sapphire directory:
- Windows: C:\Program Files\GenArts\SapphirePS\sapphire-app-settings.ini
- MacOS: /Applications/GenArtsSapphirePS/config/sapphire-app-settings.ini
- To set the load and save paths in a script, use the Sapphire environment variables: SAPPHIRE_LOAD_PRESET_PATH and SAPPHIRE_SAVE_PRESET_PATH.
The Flare Designer lets you completely customize a lens flare. You can add or remove elements, copy them, customize how each element looks, and even how it reacts to the center or edge of the image. You can also interactively move the flare around to see how it will look as it moves.
All the panels of the Flare Designer are movable, so you can adjust the user interface itself to suit your work flow. The main panels are the view window, where you see the flare you're working on, the Elements panel which lists all the elements of the flare, and the Properties panel, which lets you adjust the properties of the currently selected element (or elements). There's also a toolbar of element templates at the top.
View PanelThe main view window is where you see how your flare will look; you can click and drag to move the flare around. You can see it over the background or just over black, adjust the gamma, and Solo only the selected elements. Use Plug-in Settings makes the flare designer import the plug-in settings currently active in the host app. If you have that selected, the flare will look the same back in the host app when you're done designing it. On the other hand, if you want to create a "reusable" flare preset, it's probably a good idea to un-check Use Plug-in Settings so the flare will look good with default settings in the plug-in.
Elements PanelThe Elements panel shows you all the elements, with thumbnails. If you mouse over them, an overlay shows where they are in the main view window. When you click on an element to select it, it also flashes brighter in the main window to help you find the element you're looking for. Clicking Identify in the Properties panel does the same flashing.
To add new elements, just click the element template picture in the top toolbar. You can then rename the element, move it in the list by dragging and dropping, or hide it by un-checking the checkbox.
To delete an elements, select it and click the trash can icon at the bottom of the Elements panel, or click Delete. There is full undo, so feel free to experiment!
You can also duplicate an element using standard copy/paste operations, or select it and click the two pages icon at the bottom of the Elements panel. You can then adjust the copy's parameters in the Parameters panel.
The gear-looking element is the "advanced element" type; it has lots of controls and is very customizable, but it's recommended for advanced users only. The other types get you most of the same looks with simpler parameters.
Along with all the standard element types, you can import your own images to use as elements. Click the picture frame to import an image file. The image data will become part of the flare, so it doesn't need to keep a reference to the original file.
To combine two flares into one, or add many elements at once, you can import another flare into your current flare; this will add all the other flare's elements to your current flare. You can also just open that flare, which replaces your current flare with that one. To import and add to your flare, use Insert Flare (down-right pointing arrow in the toolbar), or File... Insert Flare. To import and replace, use Open Flare (folder icon in the toolbar), or use File... Open Flare.
Parameters PanelThe Parameters panel is where you adjust all the details of a single element -- or multiple elements together, if you select multiple elements in the Elements panel. (Use Shift-click or Control-click to select multiple elements.)
There are a few common control types. Sliders with numbers to the left control numeric params; you can drag the slider thumb, but you can also drag in the number text field to increase or decrease the value. You can also click in the number field and type any value you want.
Color controls are just a swatch of color; click to bring up a standard color picker.
Some elements have a Gradient; there's a special gradient control to adjust those. The stops are below the color swatch; you can drag them left and right to move them. Drag down to delete. Click in the color gradient to add a stop there. Control-drag to "stretch" neighboring colors, and shift-drag to push neighboring colors. The triangles above the color gradient allow you to control the interpolation of the colors between stops. Ring Thickness lets you easily turn a spot or fan of rays into a ring; turning Ring Thickness down from 1 hollows out the center. This lets you still have fine control of the colors within the ring, even if it's very thin.
Different element types will have various parameters you can adjust, but here are some common ones:
- Where the element occurs, along the line between the hotspot and pivot point. Position 1.0 is at the hotspot, 0.0 is at the pivot. Note that you don't have to stay in that range; you can use any value you like. Bigger than 1 will be past the hotspot, and less than zero will look like a reflection because it's on the other side of the pivot point.
- How big the image is.
- Rel Width, Rel Height
- Use these to squash and stretch.
- Rotates the element around, in degrees.
More InformationIf you open the flare designer from the plug-in, you can just click OK to close the window when you're done; your current flare will be used in your project and saved with it. But you can do more than that; you can save the flare definition to disk separately, so you can recall it later, or use it in other flares. You can also open the flare designer directly from the Start menu or Applications folder to create flares independent of your host product. In this case, use File...Save Lens As... to save the flare definition. That dialog will allow you to name the lens and tag it so it's easy to find later.
Note that saving a lens this way does not save your plug-in settings; it only saves the lens flare definition itself (the things you can change in the flare designer). You can save a preset in the host application to save everything -- the flare and all the regular plug-in parameters.
While the preset browser, save dialog, or flare designer are open, the main PS window will be unresponsive. This is normal. Close the preset browser or flare designer and PS will wake up again.
Starting BuilderTo use the Effect Builder, apply S_Effect or S_Transition (both in the Sapphire Builder category) to a clip, or between two clips in the case of S_Transition. Then press the Edit Effect button to bring up the Builder interface. Create the effect in the builder interface, then when you return to Photoshop your new effect will be there, with all of its published parameters. You can also load effects you've defined before, using the Load Preset button in these effects. The builder interface is composed of several panels, described below.
PanelsThe builder interface is where you create and customize your new effect. All the panels are movable and resizable so you can customize the layout for your particular work style.
ComponentsThe Components panel lists all the Sapphire effects. They're listed by category, and you can search for any one you want; you can also organize them alphabetically. To add an effect to your workspace, double-click it or drag it onto a line on the node graph, or onto another node to add it after that one.
The Tools category contains tools that are only available in Builder:
- creates a solid color
- a simple premultiplied composite. Use when the foreground clip already has an alpha channel.
- dissolve between two clips using a Matte input. Use when the foreground clip does not have an alpha channel.
- crop to a rectangular area
- crop input to an arbitrary shape, given by a Matte input. The Matte multiplies with any alpha channel that's already present.
- add an alpha channel to a clip which doesn't have one, and premultiply.
- Sticky Note
- write notes in the workspace
Preview WindowThe preview window is where you see the result of the effect you're creating. It has a play bar so you can see any animation in the nodes you've added. You can also play through transitions if you're using S_Transition.
The Node Graph is where you build the new effect. Processing flows from the Source node to the Result node; you add whatever effects you want in between to build a processing pipeline. Using multi-input effects like S_Layer or S_MathOps, you can also combine the outputs of two effects (or stacks of effects) into a single result.
In the node graph you can move, connect, disconnect, disable and preview nodes. Right-clicking on a node brings up a context menu of useful items.
To connect a node to the graph, drag it onto any line. If it was previously connected somewhere else, this will move it. You can also drag a node onto another node, which will connect it after the other node. Shift-drag a node to disconnect it.
The Parameters panel is where all the parameters for the currently selected node can be edited and published back to Photoshop. It only shows parameters for one node at a time; to edit params for a different node, just select it in the node graph. You can rename the current node here; just type a new name into the Node Name box. You can also load a preset for the current effect from the Parameters panel, choosing from the Boris FX-provided set of thousands of presets or ones you've created yourself.
The checkboxes on the right side are used to publish params to Photoshop; published params show up as params in the final effect where users can make further changes or add animation. Non-published params don't appear in Photoshop at all; this can be useful to simplify the params of the effect you're creating, or prevent users from accidentally changing important parameters. They will still take on their correct values, but users who just apply your S_Effect preset won't be able to see or change them.
You can adjust params using the slider, by dragging directly on the numbers, or by clicking in the number text and typing a new value. Shift-dragging on the numbers goes faster, and Ctrl-dragging on the numbers goes slower.
The master checkbox at the top publishes or
Each parameter has an animation button that allows you to define animations. In Transition mode, most nodes will have a predefined parameter already animated in a way that makes sense for a transition, but you can change these. There are various animations you can choose from:
- Ramp Up or Down (starting from zero or one)
- increase or decrease the value of the parameter as the transition progresses. Use this, for instance, to blur the outgoing and incoming clips oppositely to get a blur dissolve.
- Up/Down (starting from zero or one)
- increase to the midpoint, and then decrease again. Use this, for instance, to add a "hit" of brightness or glow in the middle of a transition to get a flash-frame transition.
You can further adjust the shape of each curve by dragging the sliders for Slow In, Slow Out, Start Time, End Time, Mid Time, and Slow Middle.
You can add nodes to the graph by double-clicking them in the Components panel or dragging them from that panel into the graph. If you double-click, the new node will go after the currently selected node, or just before the result if no node is selected.
To connect two nodes, drag the connecting output arrow from the source to the destination, or drag from the destination's input circle up to the source's output. To connect multiple nodes to the same source node, you have to use the latter method, dragging from the destination to the source.
You can neaten the layout of the graph at any point by using Edit -> Clean Up All.
Previewing nodesTo preview a node anywhere in your graph, i.e. to see what that node's output looks like, click Preview selected node at the bottom of the node graph, then select the node you want to examine. Its output will appear in the large preview window above.
Matte/secondary inputsMany Sapphire nodes have secondary inputs; these appear as small circles on the left or right side of the node. Mousing over that circle will show the name of the input. The most common secondary input is a matte. A simple way to use these is to create a matte using S_Vignette (set to Vignette Only mode) or S_Shape. Connect the output of that node to the matte input of the desired node to use it as a matte for that node.
Starting with Sapphire 10 Builder has a Mask node which represents the clip (or path) connected to the Mask input in the host. Connecting the Mask node in Builder to an input of an effect will pass the clip from the host to the effect. The Mask (and Background) nodes are only visible in Effect Builder, not in Transition Builder.
Layering with S_LayerOften you will want to combine two images. S_Layer and S_MathOps are good ways to do that. S_Layer composites with alpha by default, while S_MathOps adds the two inputs by default. S_Layer can also be used to combine two images using a matte: connect the matte to its side Matte input, leave it set to Normal mode, and turn off its Comp Premult parameter.
You can use Builder to create transitions as well as effects; just start with S_Transition. In this case, the node graph will start with a default dissolve transition between the outgoing and incoming clips. You can play through the transition to see how it looks.
You have tremendous flexibility when designing transitions; you can add effects to the outgoing and incoming clips, you can change the underlying transition, and you can add effects to the result.
You can also change the speed of the the underlying dissolve by selecting the Transition node and adjusting Dissolve Speed; if you increase that speed, the dissolve will happen more quickly in the middle of the overall transition.
Saving and Loading Effects
When you press OK to close the Builder interface, you will be taken back to Photoshop with the current effect as you've defined it. That effect will be stored with your project; to take it to a different machine you don't have to save any external files. (Pressing Cancel leaves the effect as it was before you started the builder UI.)
You can also save effect definitions as "presets", to share with other users or to define a look for a show or project. These presets are simple text files, so you can send them via email or put them on a shared drive. They are cross-platform, meaning they work on all video systems which support Sapphire and Builder, for instance Avid Media Composer. These presets can be loaded back into Builder for further editing, and they also appear in the preset browser when loading presets for S_Effect or S_Transition.
RestrictionsThere are a few restrictions on what you can create with Sapphire Builder.
- Popup params
- Popup params (params that have a menu of choices) can't be published to your Adobe product. You have to set them as desired within the builder interface.
- Too many params
- If you publish too many params, we may not be able to show all of them in Photoshop. Builder will warn you in that case; you can simply un-publish all the params of one or more nodes. That will free up space for publishing something else. You can use the master checkbox at the top to un-publish all the params of any node.
- Param groups
- Some Sapphire effects collect their params into groups. In Builder, the groups are used for effects within the composite builder effect, so the lower level groups are removed.
- Temporal effects
- Some Sapphire effects can't be used as nodes in Builder, notably temporal effects (effects that modify time) such as S_TimeWarpRGB and S_Retime.
What is Mocha?
Mocha is a planar tracking and masking utility that can save time on the most difficult motion tracking and masking shots. It tracks the entire area of the mask, not just individual points, to significantly reduce the tedium of manual keyframing.
Mocha looks for 3-d planes in the image: pixels that move together. Screens and signs are clear candidates, but Mocha can also track faces. It can handle objects obscured by foreground elements, and can track unlimited layers all at once.
There's a lot more to Mocha than we can explain here; there are plenty of tutorials online at http://borisfx.com.
In Sapphire, Mocha works as a mask for the effect, similarly to the mask input, but with all the tracking features of Mocha. For instance, in S_DistortRGB, the mask affects the amount of RGB distortion. In S_Glow, the mask masks out the areas you want to emit glowing light, without chopping off the smooth edges of the glow.
How to use it
- Apply a Sapphire effect
- Click Edit Mocha to launch Mocha
- Create a spline
- Track it
- Save and exit back to host
- Adjust in Sapphire
- Moving masks between effects
- go into Mocha with Edit Mocha , then File > Export to export the Mocha project to a file.
- Exit Mocha and delete the old effect.
- Apply the new effect, Edit Mocha , and File > Merge the project from the file you saved.
Most Sapphire effects now feature Mocha planar tracking integrated within the effect. Certain effects were omitted because utilizing a mask made no logical sense; for example, none of the S_Transition effects incorporate S_Mocha, and the Z_effects which require a Z_depth matte to work were also skipped.
When you click the Edit Mocha button, you will launch the Mocha UI, which will allow you to create and track a mask for use back with the selected Sapphire effect in your host application.
You can create a shape to track within Mocha utilizing either an X-spline or Bezier splines. X-splines are recommended for most uses.
Draw one or more splines around the planar areas you would like to track.
You can use backwards and forward tracking from whatever frame you're parked on. You can often get a great result with default settings, but if you're getting a lot of drifts, try increasing the Min K Pixels Used .
For your mask to appear back in your host application, YOU MUST SAVE AND EXIT. If you exit without saving, all you current work will be lost. Always save and exit!
You can make additional fine tuning adjustments after tracking in Mocha by opening the "Mocha" pulldown in your selected Sapphire effect. Additional softness and position/scale paramters can be found here, as well as checkboxes for soloing/hiding/inverting the Mocha mask.
Sometimes you track a shot with Mocha in one Sapphire effect and would like to reuse the track in a different effect. The simplest way is to export it from the first effect and re-import into the second effect.
Alternatively, if you want to share a Mocha mask with several effects, track the mask in a simple Sapphire effect such as S_HueSatBright. In there, select Show Mocha Only . Then use that as the Mask input to the effects where you want the mask used. (Exactly how to do this varies with host app.) Since the Mocha mask acts just like a regular mask input, this will allow you to update the mask once and all the other effects will use it.
Online documentation is normally installed along with your software and can also be accessed directly. On Windows go to Start -> All Programs -> GenArts Sapphire PS -> Online Help (HTML) or (PDF). On Mac, go to the /Applications/GenArtsSapphirePS folder and double click on Online Help.html or .pdf.
If a plug-in is unable to render on the GPU, it will automatically fall back to the CPU and continue processing. The GPU status, including the type of error, is displayed in the Help dialog.
On machines with more than one GPU that supports CUDA, you can select which GPU Sapphire Plug-ins will use by changing the value of use_gpu in the s_config.text file.
Many Sapphire Plug-ins can simulate motion blur by rendering the effect at multiple times and averaging the results together. Motion blur is controlled by three parameters:
- Enable Motion Blur turns motion blur on or off.
- Shutter Angle controls the amount of time that the simulated shutter is open, and thus the overall amount of motion blur. The default value of 180 degrees will blur over an interval of half a frame, which is a common setting for real cameras. A value of 360 degrees will blur over an entire frame, which is the maximum amount of motion blur possible with a real camera. Values above 360 degrees will produce unrealistic results in which the motion of adjacent frames overlaps.
- Samples controls the number of individual renders that are averaged together. Increasing the number of samples will give smoother results, but will also increase render times. If too few samples are used, there can be visible aliasing or ghosting artifacts. Faster motion will require more samples to avoid artifacts.
Glint , Glow , Glare , and Rays , for example, take the main Source input and also an optional Matte input. For these, the source input is multiplied by the matte before generating the glints (or glows, glares), so where the matte is black no glints are generated, and where it is white they are generated as usual. This method prevents the glints or glows themselves from being partially cropped by the matte. In addition these effects use the RGB colors of the Matte input to selectively colorize the resulting glows, glints, or glares. The red areas of the matte will produce red glows, glints, or glares, and so on.
In Blur effects, the areas which are matted out are never blurred, so they do not blur into the matted-in regions. If a matte were instead applied afterward, the pixels behind the matte would be blurred over the edge of the matte and into the final image. As an example, say you have a clip with white text over a black background. If you put that clip into both the Source and Matte inputs of Blur, the black background will not be blurred into the text, since the black pixels are all matted out.
For a few compositing effects, Layer , DropShadow , EdgeFlash , MatteOpsComp , and RackDfComp , the Matte input instead indicates the opacity of the foreground clip. This can be used to give the plug-in different opacity values than the usual alpha channel of the main foreground input.
Alpha is processed as just another input channel like R, G, and
B. Effects in this category include: AutoPaint, Mosaic, Blur,
BlurMotion, RackDefocus, all Wipes, all Dissolves, Distort, DistortBlur,
DistortChroma, all Kaleidoscopes, all Warps, Shake, and MathOps.
Alpha is copied from the first input to the output. In this
case the effect doesn't use the Alpha channel, but it is passed
through unchanged from the first input to the output. Effects in this
category include: BandPass, BlurChroma, ClampChroma, DuoTone,
EdgeDetect, Embosses, Etching, HalfTones, Hotspots, DistortRGB,
Monochrome, Pseudo_Color, Psykos, Sharpen, Sketch, Sparkles, Streaks,
Threshold, and Zebrafy.
- Some other effects pass the input Alpha channel through, and also add some opacity where the effects are applied. An Affect Alpha parameter is included in these effects which allows adjusting the amount that the alpha channel is affected. The effects in this category are: LensFlare, all Glows, all Glints, Glare, EdgeRays, Rays, and all Zaps.
Most Sapphire Plug-ins include a Opacity parameter that also affects how alpha is processed. Normal Opacity indicates that the input images are "non-premultipled" or straight format which is typical for Photoshop.
If the Opacity parameter is set to All Opaque, the input alpha is ignored (it's treated as if it were fully opaque), and the output alpha is set to 1. This option is slightly faster, and is appropriate if your images should be fully opaque.
The Opacity parameter can also be set to AsPremult to indicate the input clips are in "premultiplied" format. In this case the RGB values of input images are assumed to be already scaled by their Alpha (opacity) values, and the output images are also generated in this format. This option is less commonly useful, but may be appropriate if the transfer mode of your layer is set to Luminescent Premult.
A few plug-ins such as the Clouds and Texture generators include both an Input Opacity and an Output Opacity parameter. The Input Opacity gives the Normal, All Opaque or AsPremult options as described above, and the Output Opacity allows selecting between copying the opacity directly from the input, or setting the output to all opaque.
On Mac the config file is located at /Applications/BorisFX/Sapphire 2023 Photoshop/config/s_config.text
On Windows the config file is located at C:\Program Files\BorisFX\Sapphire 2023 Photoshop\s_config.text .
Custom Lens Flare types can also be made by editing the s_lensflares.text file, in the same directory as the config file above. New flare types will automatically appear in the menu of the S_LensFlare plug-in.