Skip to content
Clarisse 5.0 SP10 Reference Guide
script
Initializing search
Clarisse 5.0 SP10 Reference Guide
Legal
About this reference guide
Installing and Licensing
Installing and Licensing
Installing Clarisse
Licensing Clarisse
Isotropix License Manager
Isotropix License Manager
Using Isotropix License Manager
Installing Licenses
Installing Licenses
Node locked license
Floating license
ilise License Server
Using Clarisse
Using Clarisse
Personal Learning Edition (PLE)
First Steps in Clarisse
Understanding the Workflow
Understanding the Workflow
Working with items
Contexts, Objects and Classes
Importing Assets
Managing Items
Editing Items
Selecting Items
Grouping Items
Exporting Assets
Build Assembly
Build Assembly
Introduction to build assembly
What is the Vizroot?
Scene Assembly Nodes
Selection Nodes
Rendering Nodes
Compositing Nodes
Build Layout Nodes
Process Nodes
User Interface
User Interface
Application Window
Selection Toolbar
Shelf
Custom Layouts
Viewport and Widgets
Using Widgets
Using Widgets
3D View
AOV Editor
Attribute Editor
Build View
Browser
Explorer
Hierarchy View
File Browser
Color Picker
Image View
Image Gallery
Image Buffer Editor
Image History
Layer Editor
Graph Editor
Material Editor
Material Linker
Path Manager
Property Editor
Render Manager
Resource View
Shading Layer Editor
Script Editor
Timeline
Texture View
Variable Editor
Tools
Using Tools
Using Tools
Picker
Select
Translate Item
Rotate Item
Scale Item
Transform Item
Snapping
Clone Stamp 3D
Particle Paint
Property Paint
Pick Fit
Render Region
Ruler
Working with Scene Items
Working with Scene Items
Introduction to Scene Items
Cameras
Constraints
Geometries
Geometries
Implicits
Particles
Polymesh
Fur
Volumes
Displacements
Deformers
Combiner
Scatterer
Geometry Bundle
Working with Textures Operators
Working with Textures Operators
What are texture operators
Image Maps
Triplanar
Reorder
Scope
Instance Color
Vertex Color Map
Support Color and Fur Support Color
Occlusion
Point Cloud
Normal To Color
Extract Property
Utility
Curve Utility
Ray Switch
Switch
Get Emission Color/Weight
OSL
Global Variables
Using Expressions
Color Management
Rendering in Clarisse
Rendering in Clarisse
Render Scenes in Clarisse
Rendering with the Raytracer
Using the Raytracer
Using the Raytracer
Anti Aliasing
Transparency/Opacity
Motion Blur
Depth of Field
Item Render Flags
Tone Mapping
AOVs
Integrators
Integrators
Path Tracer
Path Tracer
Introduction
Emission Importance Sampling
Clamping
Fireflies Filtering
Roughness Noise Optimization
Optimizing Render Times
Ambient Occlusion
Utility
Lighting
Lighting
Common Lighting Attributes
Light Linking
Plane
Cylinder
Sphere
Spot
Distant
Environment
Geometry
Materials
Materials
Common Materials Attributes
Autodesk Standard Surface
Standard
Disney Principled
Shadow Catcher
Emitter
Dielectric
Diffuse
Reflection
Transmission
SSS (Subsurface Scattering)
Iridescent
Hair Fiber
Volume
Switch
Layers
Working with the Layer 3d
Working with the Layer 3d
What is a Layer 3D
UV Baking
Outline Rendering
Working with AOVs
Working with AOVs
AOV Workflow
AOV Store
Cryptomatte
Shading Layers
Shading Variables
OptiX Denoiser
Going Further with Clarisse
Going Further with Clarisse
Light Path Expressions (LPEs)
Light Path Expressions (LPEs)
Introduction to LPEs
LPEs in Clarisse
Token Reference
Useful Examples
Customizing Clarisse
Understanding Clarisse Files
SeExpr
SeExpr
SeExpr Language Reference
Functions
Operators
Clarisse Extensions
CNode
CNode
Using CNode
Using the Render Cache
Optional Arguments
Optional Arguments
info
interactive
crop
tile_rendering
script
search_path
print_expanded
process
vars
frames_list
image_frames_list
frames_order
threads
config_file
module_path
license_server
log_width
stats
verbose
enable_command_port
skip_existing
startup_script
fatal_level
Overridable Arguments
Overridable Arguments
image
output
deep_output
deep_output_max_samples
deep_output_merge
deep_output_precision
format
start_frame
end_frame
frame_step
gamma_correction
fps
motion_blur_sample
motion_blur_direction
motion_blur_length
texture_cache
application_preferences
Render Farm Deployment
CDenoise
CDenoise
Using CDenoise
CrCache
CrCache
Using CrCache
Appendix A
Appendix A
Disclaimer
End User License Agreement (EULA)
Reference
Reference
Module Class
Module Class
User Reference
User Reference
Create
Create
Camera
Camera
Fisheye
Orthographic
Panoramic
Perspective
Perspective Advanced
Geometry
Geometry
Bundle
Bundle
Alembic
Usd
Fur
Fur
File
Generator
Interpolate
Particle
Particle
Container
Point Array
Point Cloud
Point Uv Sampler
Point Volume
Scene Item Cloud
Polymesh
Polymesh
Polybox
Polycylinder
Polyfile
Polygrid
Polysphere
Volume
Volume
Box
File
Surface
Box
Cylinder
Sphere
Image
Image
Blur
Color Space
Constant
Diff
Grade
Info
Merge
Multiply
Offset
Optix Denoiser
Premult
Read
Reformat
Render
Reorder
Set
Unmult
Light
Light
Physical
Physical
Area
Area
Cylinder
Geometry
Plane
Sphere
Spot
Infinite
Infinite
Ambient
Distant
Environment
Material
Material
Physical
Physical
Autodesk Standard Surface
Blend
Dielectric
Diffuse
Disney Principled
Emitter
Hair
Hair Fiber
Iridescent
Layered
Multiblend
Reflection
Shadow Catcher
Sss
Standard
Switch
Transmission
Volume
Gradient
Matte
Normal
Random
Ray Switch
NodalItem
NodalItem
Backdrop
Dot
Note
Process
Process
Image Node Write
Image Node Write Deep
Merge
Variable Range
Variable Set
Write Abc
Write Usd
Aov Set
Aov Store
Combiner
Displacement
Group
Image
Light Path Expression
Light Path Expression Constant
Locator
Portal
Render Scene
Rule Set
Scatterer
Scope
Search Path
Shading Layer
Renderer
Renderer
Raytracer
SceneAssembly
SceneAssembly
Extract
Switch
Texture
Texture
Color
Color
Alpha To Rgb
Blend
Blur
Cdl
Color Correction
Color Model
Color Space
Constant Color
Contrast
Copy Alpha
Get Emission Color
Get Emission Weight
Hue
Multi Blend
Normal To Color
Premult
Rgb To Alpha
Saturation
Unmult
Map
Map
Map
Map File
Streamed Map File
Vertex Color Map
Math
Math
Absolute
Add
Clamp
Cross Product
Divide
Dot Product
Invert
Maximum
Minimum
Modulo
Multiply
Normalize
Power
Quantize
Rescale
Subtract
Vector To Euler
Vector To Scalar
Normal
Normal
Bump Map
Normal Map
OSL
OSL
File
Script
Procedural
Procedural
Cellular Noise
Checker
Fractal Noise
Grid
Perlin Noise
Raytrace
Raytrace
Occlusion
Utility
Utility
Black Body
Curvature
Curve Utility
Distance To Object
Distance To Uv
Extract Property
Fresnel
Fur Support Color
Gradient
Incidence
Instance Color
Object Switch
Point Cloud
Random
Randomize
Ray Switch
Remap
Reorder
Scalar Branch
Scope
Side Switch
Support Color
Switch
Triplanar
Utility
Vector Branch
Wireframe
Z Depth
Tools
Tools
Select
Select
Picker
Select
Transform
Transform
Translate Item
Rotate Item
Scale Item
Transform Item
Create
Create
Clone Stamp 3d
Particle Paint
Property Paint
View
View
Pick Fit
Render Region
Measure
Measure
Ruler
Windows
Windows
Animate
Animate
3d View
Graph Editor
Timeline
Edit
Edit
AOV Editor
Attribute Editor
Build View
Path Manager
Property Editor
Script Editor
Tool Options
Variable Editor
Explore
Explore
Browser
Class Explorer
Explorer
Hierarchy View
Image Gallery
Quick View
Search
Render
Render
Image History
Image View
Layer Editor
Material Editor
Material Linker
Render Manager
Shading Layer Editor
Texture View
History Editor
Log
Progress View
Resource View
Shelf
Tools
Technical Reference
Technical Reference
Generic
Generic
UsdExportUI
Language
Language
OSL
Parser
Python2
Python3
SeExpr
NodalGridLayouter
ProjectItem
ProjectItem
AovSet
AovStore
CAMSet
Constraint
Constraint
ConstraintMotPlayer
ConstraintOrient
ConstraintParent
ConstraintPoint
ConstraintScale
ConstraintSurface
ConstraintTarget
Deformer
Deformer
DeformerDisplacement
DeformerFlatten
DeformerMddPlayer
Displacement
Group
Group
GroupUvBake
Image
ImageFilter
ImageFilter
KernelFilter
KernelFilter
ImageFilterDefocusBlur
ImageFilterDenoiser
ImageFilterGaussianBlur
ImageFilterUVEdgePadding
PixelFilter
PixelFilter
ImageFilterAdd
ImageFilterAutoLevel
ImageFilterBrightness
ImageFilterCdl
ImageFilterColorSpace
ImageFilterContrast
ImageFilterCutOff
ImageFilterGamma
ImageFilterHueSaturation
ImageFilterInvert
ImageFilterMultiply
ImageFilterNan
ImageFilterNoise
ImageFilterRemap
ImageFilterSubtract
WholeImageFilter
WholeImageFilter
ImageFilterOptixDenoiser
ImageNode
ImageNode
ImageNodeBlur
ImageNodeColorSpace
ImageNodeConstant
ImageNodeDiff
ImageNodeGrade
ImageNodeInfo
ImageNodeMask
ImageNodeMerge
ImageNodeMultiply
ImageNodeOffset
ImageNodeOptixDenoiser
ImageNodePremult
ImageNodeRead
ImageNodeReformat
ImageNodeRender
ImageNodeReorder
ImageNodeSet
ImageNodeUnmult
Integrator
Integrator
IntegratorAmbientOcclusion
IntegratorPathtracer
IntegratorUtility
Layer
Layer
LayerColor
LayerFile
LayerImage
LayerImageNode
LayerReference
LayerScene
LayerScene
Layer3d
LightPathExpression
LightPathExpressionConstant
Material
Material
MaterialDefault
MaterialGlView
MaterialGradient
MaterialMatte
MaterialNormal
MaterialPhysical
MaterialPhysical
MaterialPhysicalAutodeskStandardSurface
MaterialPhysicalBlend
MaterialPhysicalDielectric
MaterialPhysicalDiffuse
MaterialPhysicalDisneyPrincipled
MaterialPhysicalEmitter
MaterialPhysicalHair
MaterialPhysicalHairFiber
MaterialPhysicalIridescent
MaterialPhysicalLayered
MaterialPhysicalLightGeometry
MaterialPhysicalMultiblend
MaterialPhysicalReflection
MaterialPhysicalShadowCatcher
MaterialPhysicalSss
MaterialPhysicalStandard
MaterialPhysicalSwitch
MaterialPhysicalTransmission
MaterialPhysicalVolume
MaterialRandom
MaterialSwitch
MaterialSwitch
MaterialRaySwitch
NodalItemBackdrop
NodalItemDot
NodalItemNote
OverrideSet
Process
Process
ProcessImageNodeWrite
ProcessImageNodeWriteDeep
ProcessMerge
ProcessScript
ProcessVariableRange
ProcessVariableSet
ProcessWriteAbc
ProcessWriteUsd
RenderScene
Renderer
Renderer
RendererRaytracer
RuleSet
SceneAssemblyExtract
SceneAssemblySwitch
SceneItem
SceneItem
Camera
Camera
CameraAlembic
CameraFisheye
CameraOrthographic
CameraPanoramic
CameraPerspective
CameraPerspectiveAdvanced
CameraUsd
Light
Light
LightPhysical
LightPhysical
LightPhysicalAmbient
LightPhysicalCylinder
LightPhysicalDistant
LightPhysicalEnvironment
LightPhysicalGeometry
LightPhysicalPlane
LightPhysicalSphere
LightPhysicalSpot
Locator
Locator
AbcXform
UsdXform
Portal
SceneObject
SceneObject
Geometry
Geometry
GeometryBox
GeometryCylinder
GeometryFur
GeometryFur
GeometryAbcFur
GeometryFurFile
GeometryFurGenerator
GeometryFurInterpolate
GeometryUsdFur
GeometryParticle
GeometryParticle
GeometryAbcPointCloud
GeometryParticleContainer
GeometryPointArray
GeometryPointCloud
GeometryPointUvSampler
GeometryPointVolume
GeometrySceneItemCloud
GeometryUsdPointCloud
GeometryUsdPointInstancerSupportGeometry
GeometryPolymesh
GeometryPolymesh
GeometryAbcMesh
GeometryPolybox
GeometryPolycylinder
GeometryPolyfile
GeometryPolygrid
GeometryPolysphere
GeometryUsdMesh
GeometrySphere
GeometryUsdCube
GeometryUsdCylinder
GeometryUsdSphere
GeometryVolume
GeometryVolume
GeometryVolumeBox
GeometryVolumeFile
GeometryVolumeSurface
GeometryBundle
GeometryBundle
GeometryBundleAlembic
GeometryBundleUsd
SceneObjectTree
SceneObjectTree
GeometryUsdPointInstancer
SceneObjectCombiner
SceneObjectScatterer
Scope
ScriptedClass
SearchPath
ShadingLayer
SubPixelFilter
SubPixelFilter
SubPixelFilterCryptomatte
SubPixelFilterForegroundBackground
SubPixelFilterMaxDiff
SubPixelFilterOutline
TextureOperator
TextureOperator
Texture
Texture
TextureAbsolute
TextureAdd
TextureAlphaToRgb
TextureBlackBody
TextureBlend
TextureBlur
TextureBumpMap
TextureCdl
TextureClamp
TextureColorCorrection
TextureColorModel
TextureColorSpace
TextureConstantColor
TextureContrast
TextureCopyAlpha
TextureCrossProduct
TextureCurvature
TextureCurveUtility
TextureDistanceToObject
TextureDistanceToUv
TextureDivide
TextureDotProduct
TextureExtractProperty
TextureFresnel
TextureFurSupportColor
TextureGetEmissionColor
TextureGetEmissionWeight
TextureGradient
TextureHue
TextureIncidence
TextureInstanceColor
TextureInvert
TextureMaximum
TextureMinimum
TextureModulo
TextureMultiBlend
TextureMultiply
TextureNormalMap
TextureNormalToColor
TextureNormalize
TextureObjectSwitch
TextureOcclusion
TexturePointCloud
TexturePower
TexturePremult
TextureQuantize
TextureRandomize
TextureRaySwitch
TextureRemap
TextureReorder
TextureRescale
TextureRgbToAlpha
TextureSaturation
TextureScalarBranch
TextureScope
TextureSideSwitch
TextureSpatial
TextureSpatial
TextureCellularNoise
TextureChecker
TextureFractalNoise
TextureGrid
TextureMap
TextureMapFile
TextureOsl
TextureOsl
TextureOslFile
TextureOslScript
TexturePerlinNoise
TextureRandom
TextureStreamedMapFile
TextureSubtract
TextureSupportColor
TextureSwitch
TextureTriplanar
TextureUnmult
TextureUtility
TextureVectorBranch
TextureVectorToEuler
TextureVectorToScalar
TextureVertexColorMap
TextureWireframe
TextureZDepth
ToolBrush
ToolEraser
ToolSnapper
Unknown
UvSlot
Scripting
Scripting
ScriptingPython3
Tool
Tool
ToolCloneStamp3d
ToolParticlePaint
ToolPickFit
ToolPicker
ToolPropertyPaint
ToolRenderRegion
ToolRotateItem
ToolRuler
ToolScaleItem
ToolSelect
ToolTransformItem
ToolTranslateItem
Widget
Widget
Shelf
Widget3dView
WidgetAOVEditor
WidgetAttributeEditor
WidgetBrowser
WidgetBuildView
WidgetClassExplorer
WidgetExplorer
WidgetGraphEditor
WidgetHierarchyView
WidgetHistoryEditor
WidgetImageGallery
WidgetImageHistory
WidgetImageView
WidgetLayerEditor
WidgetLog
WidgetMaterialEditor
WidgetMaterialLinker
WidgetPathManager
WidgetProgressView
WidgetPropertyEditor
WidgetQuickView
WidgetRenderManager
WidgetResourceView
WidgetScriptEditor
WidgetSearch
WidgetShadingLayerEditor
WidgetTextureView
WidgetTimeline
WidgetToolOptions
WidgetTools
WidgetVariableEditor
WidgetVariableHotbar
Scripting/API
script
#
-script script_path
Execute the specified python script.