User Guide Cancel

Custom Filters | Substance 3D Sampler

  1. Substance 3D home
  2. Home
  3. Getting Started
    1. Getting Started overview
    2. Activation and licenses
    3. System requirements
    4. Shortcuts
    5. Importing Resources
    6. Report a bug
    7. Project Management
    8. Export
      1. Export overview
      2. Export Window
      3. Default Presets
        1. Default Presets overview
        2. Arnold 5
        3. Blender Cycles/Eevee
        4. Corona Renderer
        5. Enscape - Revit
        6. Keyshot9+
        7. Lens Studio
        8. Spark AR Studio
        9. Unity HDRP Standard
        10. Unity HDRP Specular
        11. Unity Standard
        12. Unity Specular
        13. Unreal Engine 4
        14. Redshift
        15. V-Ray Next
      4. Managing custom presets
      5. Managing Presets
  4. Interface
    1. Interface overview
    2. The Home Screen
    3. 2D and 3D Viewport
    4. Sidebars
    5. Panels
      1. Panels overview
      2. Project panel
      3. Assets panel
      4. Layers panel
      5. Properties panel
      6. Viewer Settings panel
      7. Shader Settings panel
      8. Channel Settings panel
      9. Metadata panel
      10. Export panel
      11. Physical Size Panel
      12. Exposed Parameters Panel
      13. Resources
    6. Tools and Widgets
      1. Tools and Widgets overview
      2. Sliders
      3. Color Picker
    7. Preferences
      1. Preferences overview
      2. Normal Format
      3. Layer Resolution
  5. Filters
    1. Filters overview
    2. Custom Filters
    3. Compound Filters
    4. Generators
      1. Generators overview
      2. Atlas Scatter
      3. Brickwall
      4. Cloth Weave
      5. Decal
      6. Embossing
      7. Embroidery
      8. Floor Tiles
      9. Gravel
      10. Panel
      11. Parquet
      12. Pattern
      13. Pavement
      14. Perforate
      15. Quilt Stitch
      16. Splatter
      17. Stonewall
      18. Surface Relief
      19. Weave
    5. Adjustments
      1. Adjustments overview
      2. Blur
      3. Brightness/Contrast
      4. Colorize
      5. Color Replace
      6. Color Variation
      7. Equalize
      8. Fill
      9. Hue/Saturation
      10. Invert
      11. Sharpen
      12. Vibrance
    6. Tools
      1. Tools overview
      2. Atlas Creator
      3. Atlas Splitter
      4. Channels Generation
      5. Channel Switch
      6. Clone Stamp
      7. Crop tool
      8. Delight (AI Powered)
      9. Height to AO
      10. Height to Normal
      11. Image To Material
      12. Make it Tile
      13. Match
      14. Multiangle To Material
      15. Normal to Height
      16. Paint Wrap *missing*
      17. PBR Validate
      18. Perspective Correction
      19. Tiling
      20. Transform
      21. Warp
      22. Warp Transform
      23. Upscale
    7. HDRI Tools
      1. HDRI Tools overview
      2. Color Temperature Adjustment
      3. Exposure
      4. Exposure Preview
      5. HDR Merge
      6. Line Light
      7. Nadir Extract
      8. Nadir Patch
      9. Panorama Patch
      10. Plane Light
      11. Shape Light
      12. Sphere Light
      13. Straighten Horizon
    8. Wear and Finish
      1. Wear and Finish overview
      2. Corrode
      3. Cracks
      4. Dirt
      5. Discarded Gums
      6. Dust
      7. Erode
      8. Metal Finish
      9. Moss
      10. Oxidate
      11. Paint
      12. Rust
      13. Scratch
      14. Snow
      15. Water
      16. Varnish
  6. Technical Support
    1. Technical Support overview
    2. Exporting the log file
    3. Configuration
      1. Configuration overview
      2. Retrieving the installation path
      3. Update Checker
      4. NVIDIA Driver Settings
      5. 3D Capture set-up on Linux  
    4. Technical Issues
      1. Technical Issues overview
    5. Data or project issues
      1. Data or project issues overview
      2. Import Substance Alchemist projects in Substance 3D Sampler
    6. Filter issues
      1. Filter issues overview
      2. Image to Material and Delighter are missing
    7. Interface issues
      1. Interface issues overview
      2. Fonts are not displayed correctly
      3. Main interface is transparent
    8. Performance issues
      1. Performance issues overview
      2. Color picker takes long time to open the first time
      3. Interface lags when interacting with the layer stack or other elements
    9. Stability issues
      1. Stability issues overview
      2. Crash when exporting a material
      3. Crash when using the Image to Material or Delighter
    10. Startup issues
      1. Startup issues overview
      2. Application doesn't start on Linux
  7. Features and workflows
    1. Features and workflows overview
    2. 3D Capture
    3. Export parametric assets
    4. End to end Physical Size Workflow
    5. Texture Import
    6. Texture Generators
    7. Use As Bitmap
    8. Adobe Standard Material
  8. Pipeline and integrations
    1. Pipeline and integrations overview
    2. Environment variables
  9. Scripting and Development
    1. Scripting and Development overview
    2. Manage installed plugins and scripts
    3. Create a Plugin with Python and QML
    4. Create a Script with Python
      1. Create a Script with Python overview
      2. Example Scripts
  10. Release Notes
    1. Release Notes overview
    2. All Changes
    3. Beta
    4. Version 4.3
    5. Version 4.2
    6. Version 4.1
    7. Version 4.0
    8. Version 3.4
    9. Version 3.3
    10. Old Versions
      1. Version 3.2
      2. Version 3.1
      3. Version 3.0
      4. Version 2020.3 (2.3)
      5. Version 2020.2 (2.2)
      6. Version 2020.1 (2.1)
      7. Version 2019.1
      8. Version 0.8.1
      9. Version 0.8.0
      10. Version 0.7.0
      11. Version 0.6.1
      12. 0.6.0
      13. 0.5.4
      14. 0.5.3
      15. 0.5.2
      16. 0.5.1
      17. 0.5.0
  11. FAQ
    1. FAQ  Overview

Custom Filters

Substance Custom Filters

You can import filters made with Adobe Substance 3D Designer via the Import button in the Layer Stack actions.

Create a Substance Filter

Filters must be built in a specific way in Designer to work correctly once imported in Sampler.

The input and output nodes of the filter must have the identifier or usage defined.

Note:

It is possible to use either the usage or the identifier (the usage has the priority).

Format

Export your filter as a Substance Archive file (.sbsar)

Note:

You can expose filter parameters to control the filter directly in Sampler. See how-to here

Create a filter to modify images

Images name Usage
Scan1 scan1
Scan2 scan2
... ...

Create a filter to modify channels

Channel name Usage
Base Color basecolor 
Diffuse diffuse
Specular specular
Specular Level specularlevel
Metallic metallic
Roughness roughness
Glossiness glossiness
Normal normal
Height height
Ambient Occlusion ambientOcclusion
Opacity opacity
Alert:

When creating a custom filter for Sampler, you need to add the following userdata in your Substance graph:

alchemist::type=filter;
Alert:

If in your package, you have one graph to process images (scan1 to scanX) and one graph to process material (PBR channels), Sampler is able to choose the correct graph depending where the filter is inserted in the layer stack.

On your "image" graph, add the following userdata:

alchemist::type=filter;alchemist::variation::type=multi

On your "material" graph, add the following userdata:

alchemist::type=filter;alchemist::variation::type=material

Specific parameters

Specific parameters are globally managed by the application. It's a way to use global parameters of the application, the project, the layer stack in your custom filters.

Normal format

Control of the normal format over the application. Set to DirectX in Sampler 

parameter identifier: normalformat, normal_format, $normalformat, $normal_format 

Input Count

When you want to modify images (scan1 to scanX), you can use the number of images in the layer stack by using the Image Count parameter.

parameter identifier: input_count

parameter type: integer1

Material Input

If you want to display a material slot in the layer stack like the atlas scatter or the splatter:

  • Add a new set of Input nodes (Base Color, Normal, ... )
  • All Input nodes of the background (bottom material in the layer stack) should be in the Group Material1
  • All Input nodes of the first material you want to add on top should be in the Group Material2 and etcetera if you want several material slots.
  • Add a material input parameter:
    • parameter identifier: material_input
    • parameter type: integer1

Workflow Type

If you want to display/hide some parameters based on the workflow of your project (PBR Metalic/Roughness or PBR Specular/Glossiness), you can the Workflow Type parameter

parameter identifier: workflow_type

parameter_type: integer1, dropdown list

options:

  • 0: PBR Metallic/Roughness
  • 1: PBR Specular/Glossiness

 Adobe

Get help faster and easier

New user?