Katana Developer Guide
8.0v3

Application

  • CEL Reference
  • Attribute Conventions
  • Environment Variables
  • Args Files
    • Structure
    • Schema
    • Widgets and Hints
    • Args Files for Shaders
    • Args Files for Procedurals
    • Args Files for GenericAssign
  • External Software
  • Copyright Notices
  • Qt 5 to Qt 6 Migration Guide

Parameter Expressions

  • Overview
  • Python Expressions
  • Reference Expressions

Scripting in Katana

  • Working with Projects
  • Working with Nodes
  • Customizing Node Types
  • Customizing the User Interface
  • Rendering a Scene
  • Cooking a Scene
  • Callbacks and Events

Ops and OpScript

  • Asset API
  • Attributes
  • Attribute Function
  • Built-in Op Types
  • Configuration
  • Cook Interface
  • Cook Interface Utilities
  • Hints
  • Look Files
  • Material Resolve
  • Op Args Builders
  • Paths
  • Resolutions
  • Transformations
  • ExpressionMath
  • Imath
  • pystring
  • OpWrite

Writing Plug-ins

  • The Plug-in System
  • Native Plug-in Compatibility
  • Asset Plug-ins
  • Display Driver Plug-ins
  • Renderer Plug-ins
  • Default Attribute Producer Plug-ins
  • Utilities
  • Viewer Plug-ins
  • Hydra Render Delegates
  • Katana USD Plug-ins
  • Look File Baking
  • Material Soloing
  • Render Farm Plug-ins

Performance

  • Profile Results

Performance Optimization Guide

  • Profiling and Optimization Guide: Start Here
  • Designing Node Graphs for Optimal Performance
  • Improving Op Performance
  • Composing Concurrency-Friendly Scenes
  • Improving OpScript Performance

USD Processing Engine

  • Basic API Usage
  • USD Processing Engine API
  • USG Python API
  • Engines
  • KatanaToUsd
  • UsdLayerExport
  • UsdPythonWrite

API Reference

  • C++ Header Index
  • Python Module Index
  • Lua Module Index
Katana Developer Guide
  • Args Files
  • View page source

Args Files

Args files provide UI hints about how parameters are to be displayed in the user interface. Args files are used for shaders, renderer procedurals and GenericAssign; the format for each is similar but not identical.

  • Structure
    • Parameters
    • Pages and Groups
    • Help Text
    • Comments
  • Schema
  • Widgets and Hints
    • Hint Types
    • Common Hints
    • Pages and Groups
    • Basic Widgets
    • Pull-down Widgets
    • File Widgets
    • Array Widgets
    • Ramp Widgets
    • Conditional Visibility and Locking
  • Args Files for Shaders
    • Search Path
    • Typed Connection Checking
    • Co-Shaders
  • Args Files for Procedurals
    • Output Style
  • Args Files for GenericAssign
    • Top-level <args> Attributes
    • Forcing Parameters to be Arrays
Previous Next

© Copyright 2025 Foundry.

Built with Sphinx using a theme provided by Read the Docs.