Smode Documentation >
Reference >
Elements >
Compositing >
Software Integrations >
Python

Python

Elements related to Python

python

python

python

python

Learn how to use Python scripts in Smode by reading the Python scripting section of the documentation.

Python Script

Write Python scripts inside Smode

Previous Substance PBR Surface

Next Python Script

Documentation

Search

Submenu User Guide User Guide
- Submenu Tutorials and How-Tos Tutorials and How-Tos
  - Submenu Getting Started Getting Started
    - Requirements
    - Installation
    - Submenu Licensing Licensing
    - Quickstart
    - Homepage
  - Submenu Content creation & Compositing Content creation & Compositing
    - Submenu Discover the user Interface Discover the user Interface
    - Submenu Create & composite content Create & composite content
      - Create Compositions
      - Create Layers
      - Submenu 2D Compositing 2D Compositing
        
        Basics of 2D Compositing
        
        Modifiers & Masks
        
        Using Shapes
        
        Submenu Using Text Layers Using Text Layers
        
        Insert your text into a rectangle
        
        Create a TC timecode visualizer
        
        Create a lyrics video
        
        Create a ticker
        
        Submenu Transcoding Transcoding
        
        Transcode a Video File
        
        Transcode image sequence
        
        Transcode an image in DDS
        
        Export in Hap from third party softwares
      - Submenu 3D Compositing 3D Compositing
        
        Basics of 3D Compositing
        
        Using 3D files
        
        Using 3D Masks
        
        Using Cameras
      - Submenu Software Integration Software Integration
        
        Submenu Integrate Unreal Engine content Integrate Unreal Engine content
        
        Expose an Unreal Actor
        
        Unreal Tool
        
        Submenu Unreal for XR Unreal for XR
        
        Simple Centralized Setup
        
        Dual Centralized Setup
        
        Decentralized Setup
        
        Switchboard
        
        Stage and Screen Orientation
        
        Unreal Color Viewport
        
        Unreal Key
        
        Unreal content in Smode
        
        Submenu Integrate Notch content Integrate Notch content
        
        Exposable Camera
        
        Notch Exposed Properties
        
        Notch XR
        
        Submenu Integrate TouchDesigner content Integrate TouchDesigner content
        
        Troubleshooting Tox Import Issues
        
        Integrate ISF shaders
        
        Submenu Integrate Substance files Integrate Substance files
        
        How to create your own .sbsar for Smode
        
        How to create your own PBR for Smode with Substance Painter
      - Submenu Other Other
        
        Submenu Use presets Use presets
        
        Save Presets
        
        Interpret Alpha of a Footage
        
        Create pre-compositions and share elements
    - Submenu Animate content Animate content
      - Break Points and Time markers
      - Submenu Exposing Parameters Exposing Parameters
        
        Expose Parameters as parameters
        
        Expose Parameters as percentage
        
        Expose as Starter parameters
      - How to edit video
      - Record live values in timelines
    - More tutorials
  - Submenu Set up a Project Set up a Project
    - Submenu Introduction to Show Introduction to Show
      - Bind the Show Timelines to Timecode
    - Submenu Introduction to Pipeline Introduction to Pipeline
    - Submenu Introduction to Stage Introduction to Stage
    - Submenu Introduction to Processors Introduction to Processors
    - Full Project
  - Submenu Connection & Interactivity Connection & Interactivity
    - Submenu How to connect devices How to connect devices
      - How to use Links in Smode
      - Learn
    - Video interactivity
    - Audio interactivity
    - Useful other softwares
    - Submenu Troubleshooting Troubleshooting
      - Local Clock differs too much from received time
  - Submenu Video Mapping Video Mapping
  - Output Artnet & sACN
  - Submenu Use a Tracking System Use a Tracking System
  - Submenu Setup an XR project Setup an XR project
  - Submenu Python scripting Python scripting
  - Submenu Multi server configuration (Smode Net) Multi server configuration (Smode Net)
  - Submenu Playback & Export Playback & Export
- Submenu Troubleshooting Troubleshooting
Submenu Reference Reference
- Submenu Elements Elements
  - Submenu Compositing Compositing
    - Submenu 2D Elements 2D Elements
      - Submenu 2D Layer 2D Layer
        
        Submenu 2D Generator 2D Generator
        
        Submenu File Based Generators File Based Generators
        
        Image Layer
        
        Exr Image Layer
        
        Video File
        
        AVStreamer
        
        Cube Map File
        
        Reference
        
        Submenu Gradient Generators Gradient Generators
        
        Gradient
        
        Linear Gradient
        
        Radial Gradient
        
        N-Points Gradient
        
        Submenu Procedural Noise Generators Procedural Noise Generators
        
        Noise layer
        
        White Noise layer
        
        Submenu Shader Based Generators Shader Based Generators
        
        Uniform
        
        Checker Board
        
        Brick
        
        Mandelbrot Fractals
        
        Dots
        
        Shader Generator
        
        Video Scope
        
        Submenu Function Based Generators Function Based Generators
        
        Function Curve
        
        Radial Function
        
        Submenu Lens flare Generators Lens flare Generators
        
        Lens Flare
        
        Submenu Text Generators Text Generators
        
        2D Text
        
        Submenu Signal Testing Signal Testing
        
        Glitch
        
        Test Pattern
        
        April Tag
        
        April Tag Grid
        
        Visualize Smart Lut
        
        Submenu Texture retrieval from inputs Texture retrieval from inputs
        
        Video Input
        
        Parent Input layer
        
        Compo
        
        Submenu 2D Renderer 2D Renderer
        
        Single 2D Renderer
        
        3D Renderer for 2D Layers
        
        Group 2D Renderer
        
        Mapper Item Renderer
        
        Full Mapper Item
        
        Area Mapper Item
        
        Warp to Geometry
        
        Unproject 3D
        
        Submenu 2D Renderer Effect 2D Renderer Effect
        
        Border
        
        Frame Edges
        
        Drop Shadow
        
        Submenu 2D Modifier 2D Modifier
        
        Submenu Color Modifiers Color Modifiers
        
        Temperature
        
        Vibrance
        
        Color Balance
        
        Exposure
        
        Grayscale
        
        Invert
        
        Tritone
        
        Red Green Blue
        
        Brightness Contrast Gamma
        
        Hue Saturation Luminance
        
        Color Function
        
        Colorize
        
        Color Lookup Table
        
        Smart Lut
        
        OCIO
        
        Submenu Distort Modifiers Distort Modifiers
        
        Flip
        
        Kaleidoscope
        
        2D Transform
        
        Displace
        
        Polar Coordinates
        
        Droste
        
        Swirl
        
        Warp
        
        Radial Distortion
        
        Submenu Stylize modifiers Stylize modifiers
        
        Ambient Occlusion
        
        Chromatic Aberration
        
        RGB Separate
        
        Sparkles
        
        Pixelate
        
        Sharpen
        
        Emboss
        
        Sobel
        
        Tiles
        
        Submenu Blur Modifiers Blur Modifiers
        
        Blur
        
        Depth of Field
        
        Feedback
        
        Depth of Field (Legacy)
        
        Anti Aliasing
        
        Legacy Blur
        
        Denoise
        
        Submenu Utility Modifiers Utility Modifiers
        
        Mask
        
        Discard Alpha
        
        Alpha Choker
        
        Freeze
        
        Rasterize
        
        Upscale
        
        Overlay
        
        Compo Based
        
        Depth To Normal
        
        Color Space Converter
        
        Frame Delay
        
        Optical Flow
        
        April Tag detector modifier
        
        April Tag Detection
        
        Matte
        
        2D Modifiers Group
        
        Submenu 2D Mask 2D Mask
        
        Placement mask
        
        Linear mask
        
        Radial mask
        
        Noise mask
        
        Polygonal mask
        
        Gradient mask
        
        Color mask
        
        Depth mask
        
        Function mask
        
        Layer mask
        
        2D Group mask
        
        Display Angle Mask
        
        Position in Shape
        
        People Mask
        
        2D Group
      - Submenu Shape layer Shape layer
        
        Submenu Shape Generator Shape Generator
        
        Point
        
        Line
        
        Circle
        
        Rectangle
        
        N-Sides
        
        Star
        
        Text
        
        Bezier
        
        Control Point
        
        Group of shapes
        
        Merger
        
        Submenu Shape Modifier Shape Modifier
        
        Edge Thickness
        
        Edge Centering
        
        Edge Color
        
        Fill Color
        
        Stroke
        
        Instantiate
        
        Transform
        
        Distort
        
        Expand
        
        Rasterize
        
        Reference Modifier
      - Submenu Text layer Text layer
        
        Submenu Text Generator Text Generator
        
        Group Text Generator
        
        Text Renderer
        
        Submenu Text Modifier Text Modifier
        
        2D Transform
        
        Capitalize
        
        Character Offset
        
        Color
        
        Color Gradient
        
        Opacity
        
        Font
        
        Bold
        
        Italic
        
        Append
        
        Insert
        
        Repeat
        
        Select
        
        Group of modifiers
        
        Submenu Text Masks Text Masks
        
        Character
        
        Random
        
        Range
        
        Words
      - Submenu 2D Placement 2D Placement
        
        Fit
        
        Parametric
        
        Perspective
        
        Bilinear
        
        Perspective Interpolation
        
        Perspective Remapping
        
        Bezier
        
        Bezier Patch
    - Submenu 3D Elements 3D Elements
      - Submenu 3D Objects 3D Objects
        
        Submenu 3D Layer 3D Layer
        
        Submenu 3D Generator 3D Generator
        
        Plane
        
        Box
        
        Capsule
        
        Cylinder
        
        Geosphere
        
        Sphere
        
        Torus
        
        Circle
        
        Function Spline
        
        Helix
        
        Star
        
        Knot
        
        Rectangle
        
        Segment
        
        3D Text
        
        Grid Points
        
        Random Points
        
        Svg File
        
        Tracking System
        
        3D File
        
        Stage Display
        
        Group Geometry
        
        Submenu 3D Renderer 3D Renderer
        
        Simple Points
        
        Sprite Points
        
        Ball Points
        
        Box Points
        
        Wireframe Lines
        
        Thick Lines
        
        Tube Lines
        
        Surface
        
        PBR Surface
        
        AutoIlluminate Surface
        
        Vertex Referential
        
        Triplanar Mapping
        
        Gradient Colorizer
        
        3D Texture
        
        Geometry Mask Preset
        
        Renderer Depth Settings
        
        Multiple Renderer
        
        Group 3D Renderer
        
        Submenu 3D Modifier 3D Modifier
        
        Submenu Attribute Modifiers Attribute Modifiers
        
        Colorize
        
        Colorize Function
        
        Colorize Layer
        
        Opacity
        
        Point Attributes
        
        Point Rotate
        
        Point Rotate Function
        
        Point Scale
        
        Point Scale Function
        
        UV Mapping
        
        UV Camera Mapping
        
        UV Transform
        
        Submenu Distort Modifiers Distort Modifiers
        
        Displace
        
        Position Noise
        
        Spherify
        
        Set Position
        
        Quantize
        
        3D Transform
        
        Transform Triangles
        
        Demultiply
        
        Boxify
        
        Submenu Operator Modifiers Operator Modifiers
        
        Connect Points
        
        Motion Lines
        
        Random Points
        
        Emit Particles
        
        Instantiate
        
        Repeat
        
        Triangulate
        
        Extrude Shape
        
        Solidify Path
        
        Central Symmetry
        
        Mirror
        
        Submenu Utility Modifiers Utility Modifiers
        
        Compute
        
        Invert Normals
        
        Submenu 3D Mask 3D Mask
        
        Full
        
        Random
        
        Group 3d Mask
        
        Age
        
        Velocity
        
        Noise
        
        Linear
        
        Sphere
        
        Cylinder
        
        Box
        
        Depth
        
        Normal
        
        Fresnel
        
        Texture Coordinate
        
        Color
        
        Function
        
        Texture Geometry Mask
        
        Tracking System
        
        Submenu Particles Particles
        
        Submenu Field Field
        
        Gravity
        
        Friction
        
        Attractor
        
        Vortex
        
        Turbulence
        
        Layer Intensity
        
        Normal Map Layer
        
        Lorenz Attractor
        
        Shader Field
        
        Tracking System
        
        Submenu Particle Rule Particle Rule
        
        Event Particle Rule
        
        Continuous Particle Rule
        
        Submenu Particle Condition Particle Condition
        
        Composite
        
        TextureMask
        
        Age
        
        Collision
        
        Color
        
        Random
        
        Group
        
        Submenu Particle Action Particle Action
        
        Kill
        
        Emit
        
        Colorize
        
        Change Group
        
        Age
        
        Bounce
        
        Submenu Light Light
        
        Ambient Light
        
        Directional Light
        
        Point Light
        
        Environment Light
        
        Spot Light
        
        Rectangular Light
        
        Area Light
        
        Projector Light
        
        Submenu Camera Camera
        
        Standard Camera
        
        Spherical Camera
        
        Stereoscopic Camera
        
        Oculus Camera
        
        VR Window Camera
        
        Physical Camera
        
        Content Map Current Camera
        
        CameraModel .optic
        
        Submenu Special Layers Special Layers
        
        Skybox
        
        Volumetric Light
        
        Volumetric Noise
        
        Constructive Solid Geometry
        
        Ray Traced Shader
        
        Volume Layer
        
        Submenu 3D Group 3D Group
        
        Group Generator
        
        Light Group
        
        3D modifier Group
        
        3D masks Group
      - Submenu 3D Properties 3D Properties
        
        Submenu 3D Placement 3D Placement
        
        Position
        
        Position Orientation
        
        Position Orientation Size
        
        Target Orientation Distance
        
        Position Target Roll
        
        Rail
        
        Position Quaternion
        
        Matrix
        
        Relative To Camera
        
        Mirror
        
        Link To Tracker
        
        3D Position
        
        Material Bank
        
        Submenu 3D Tools 3D Tools
        
        PC2 cache File
        
        Reflection Probe
    - Submenu Software Integrations Software Integrations
      - Submenu Unreal Engine Unreal Engine
        
        Unreal Device
        
        Unreal Level Layer
      - Submenu Notch Notch
        
        Notch 3D Layer
        
        Notch 2D Generator
        
        Notch 2D Modifier
      - Submenu ISF ISF
        
        ISF Generator
        
        ISF Modifier
      - Submenu Shader Toy Shader Toy
        
        Shader Toy Generator
      - Submenu Substance Substance
        
        Substance File
        
        Substance layer
        
        Substance PBR Surface
      - Submenu Python Python
        
        Python Script
      - Submenu TouchDesigner TouchDesigner
        
        Tox Component
        
        Tox 2D Layer
        
        Tox 2D Modifier
  - Submenu Animation Animation
    - Submenu Animation Elements Animation Elements
    - Submenu Parameters Parameters
    - Submenu Functions Functions
      - Function
      - Function Shape
      - Parametric Function
      - Midi Keyboard Function
      - Custom Function
      - Submenu Keyframe functions Keyframe functions
        
        Keyframe
        
        Keyframe Function
      - Submenu Color functions Color functions
        
        Color Gradient
        
        Uniform
        
        Bitone
        
        Tritone
        
        Quadritone
      - Noise Function
    - Submenu Links Links
      - Link
      - Link Bank
      - Submenu Link Source Link Source
        
        Link Source
        
        Audio Spectrum
        
        Parameter
        
        Single Precision
        
        Double Precision
        
        Clock
      - Submenu Link Target Link Target
        
        Link Target
        
        Parameter Target
        
        Element Target
        
        Single Precision
      - Submenu Link Modifiers Link Modifiers
        
        Link Modifier
        
        Function
        
        Delay Link Modifier
        
        Submenu Link Condition Link Condition
        
        If Equal
        
        If Not Equal
        
        If Less Than
        
        If Less Than Or Equal
        
        If Greater Than
        
        If Greater Than Or Equal
        
        If Crossed Threshold
        
        Submenu Number Based Number Based
        
        Set
        
        Offset
        
        Multiply
        
        Divide
        
        Modulo
        
        Invert
        
        Floor
        
        Power
        
        Math Inverse
        
        Absolute
        
        Minimum
        
        Maximum
        
        Clamp
        
        Remap
        
        Trig
        
        Toggle
        
        Enable
        
        Disable
        
        Submenu Converters Converters
        
        To String
        
        To Percentage
        
        To Real
        
        Submenu Dynamic Dynamic
        
        Derivative
        
        Smooth
        
        Bounce
        
        Inertia
        
        Extrapolate
        
        Interpret Speed
  - Submenu Project Project
    - Submenu Show Show
      - Scene
    - Submenu Stage Stage
      - Submenu Stage Elements Stage Elements
        
        Surface
        
        Stage Geometry
        
        Video Projector
        
        Led Screen
        
        Free Shape Led Screen
        
        Strip Led Screen
        
        Planar Led Screen
        
        Tiles Led Screen
        
        Single Fixture
        
        Led Fixture Type
        
        Strip Fixture Type
        
        Screen Fixture Type
        
        Fixture Definitions
        
        Mapping
        
        Tracking System
        
        Tracker
        
        Stage Elements Group
      - Submenu Mapping Elements Mapping Elements
        
        Mapper Generator
        
        Surface Mapper Item
        
        Video Projector Calibrator
        
        Video Projector Calibration
    - Submenu Pipeline Pipeline
      - Submenu Content Mapping Content Mapping
        
        2D Scene Mapping
        
        3D Camera Mapping
      - Submenu Content Map Content Map
        
        Content Area
      - Submenu Processor Processor
        
        Pipeline Layer
        
        Stage Preview
        
        Stage Simulation
        
        Stage Lights
        
        Soft Edge
      - Video Output
      - Submenu Modifier Stack Modifier Stack
        
        Modifier Stack Layer
        
        Modifier Stack Channel
      - Submenu Topology Topology
        
        Group topology
        
        Smode Server
        
        Smode Server device
  - Submenu Other Other
- Submenu User Interface User Interface
  - Workspace Selector
  - Submenu Workspace Components Workspace Components
    - Submenu Appication Components Appication Components
    - Submenu Document Components Document Components
    - Submenu Element Components Element Components
    - Submenu Advanced Components Advanced Components
    - Submenu Workspace leaf toolbar Workspace leaf toolbar
  - NETWORK
  - Submenu Toolbar Toolbar
- Submenu Preferences panel Preferences panel
  - Submenu Engine Preferences Engine Preferences
    - Submenu Devices Devices
      - Device Configuration
      - Device Identifier
      - Submenu Video Output Device Video Output Device
        
        Standard Output
        
        Spout Output
        
        DMX Output
        
        NDI Output
        
        BlackMagic Output
        
        10 bit colors Output
      - Submenu Video Input Device Video Input Device
        
        Direct Show
        
        DeltaCast
        
        BlackMagic
        
        NDI Input
        
        Spout Input
        
        OptiTrack
        
        2110 Rivermax Video input
        
        Multi Video Input Synchronizer
        
        Video input synchronisation
        
        Auto syncher
        
        Phase Wizard
      - Submenu Control Device Control Device
        
        Keyboard
        
        MIDI
        
        DMX
        
        ArtNet
        
        sACN
        
        OSC
        
        Kinesys
        
        Posital
        
        Blacktrax Device
        
        OptiTrack Device
        
        Trackmen
        
        Mouse
        
        Oculus Device
        
        Augmenta Tracking device
        
        Stype Tracking system
        
        FreeD Tracking system
        
        Posistage Net-PSN
      - Submenu Audio Device Audio Device
        
        Juce Audio
        
        Null Audio
      - Submenu Clock Device Clock Device
        
        Current Time Clock
        
        Manual Clock
        
        MIDI Clock
        
        Audio Clock Device Identifier
        
        Audio Clock
    - Submenu Other Engine Preferences Other Engine Preferences
      - Submenu Timing Timing
        
        GPU VSync
        
        Video Input Sync Provider
        
        Video Output Sync Provider
        
        Quadro Sync Time Provider
        
        System TimeProvider
        
        Device Time Provider
      - GPU settings
      - Auto Save
      - Smode Net Server
      - Http Server
  - Media
  - System
  - Shortcuts
  - Application
  - License
  - About
Submenu Changelog Changelog
- Submenu Smode 10.2 Smode 10.2
  - Smode 10.2 revision
- Submenu Smode 10.1 Smode 10.1
  - Smode 10.1 revision
- Submenu Smode 10.0 Smode 10.0
  - Smode 10.0 revision
- Submenu Smode 9.4 Smode 9.4
  - Smode 9.4 revision
- Submenu Smode 9.3 Smode 9.3
  - Smode 9.3 revision
- Submenu Smode 9.2 Smode 9.2
  - Smode 9.2 revision
- Submenu Smode 9.1 Smode 9.1
  - Smode 9.1 revision
- Smode 9.0
- Smode 8.6
- Smode 8.5

Language
Theme