Renderer Plug-ins

• Overview
  • What is a render plug-in?
  • Advertising render methods to start a render process
    • Batch rendering
    • Launching render methods in the UI
  • Starting a render
  • Key stages of the render process
  • Processing the Katana recipe and utility classes
    • Scene graph delegates
    • Scene graph utility classes
  • Disk Render: Rendering one or more render outputs to disk
  • Preview Render: Rendering directly to Katana’s Monitor tab
  • Generating a render debug output
    • Advertising debug output support
    • Creating a debug output in the render plug-in
  • Setting the plug-in as the default renderer in Katana
  • Linking the plug-in to its corresponding renderer info plug-in
  • Adding configuration nodes
    • Configuring global settings (<rendererName>GlobalStatements)
    • Configuring object settings (<rendererName>Statements)
  • Sending ID pass data to Katana
  • Setting the number of render threads
  • Customizing the Network Material Group Context Layered Menu
• Render API
  • LiveRenderFilterMode
    • LiveRenderFilterMode::kLiveRenderFilterMode_Append
    • LiveRenderFilterMode::kLiveRenderFilterMode_Replace
  • SceneGraphTraversalMode
    • SceneGraphTraversalMode::kSceneGraphTraversalMode_LocationOrigin
    • SceneGraphTraversalMode::kSceneGraphTraversalMode_RecursiveFromSelection
    • SceneGraphTraversalMode::kSceneGraphTraversalMode_SelectedLocations
    • SceneGraphTraversalMode::kSceneGraphTraversalMode_SelectedLocationsRecursive
  • ProceduralArgsType
    • ProceduralArgsType::kProceduralArgsType_Classic
    • ProceduralArgsType::kProceduralArgsType_ScenegraphAttr
  • buildProceduralArgsString()
  • flushProceduralDsoCaches()
  • getPixelAreaThroughCamera()
  • findSampleTimesRelevantToShutterRange()
  • getRenderResolution()
  • getCameraPath()
  • fillXFormListForLocation()
  • fillXFormListFromAttributes()
  • convertTexturesToArbitraryAttr()
  • getFlattenedMaterialAttr()
  • emptyFlattenedMaterialCache()
  • getCameraInfo()
  • processLocation()
  • fillDelegateHandledLocationTypesList()
  • buildTempRenderLocation()
  • buildTileLocation()
  • CameraSettings
    • CameraSettings::Ptr
    • CameraSettings::CameraSettings()
    • CameraSettings::~CameraSettings()
    • CameraSettings::initialise()
    • CameraSettings::getName()
    • CameraSettings::getProjection()
    • CameraSettings::getFov()
    • CameraSettings::getClipping()
    • CameraSettings::getScreenWindow()
    • CameraSettings::getTransforms()
    • CameraSettings::_iterator
    • CameraSettings::_cameraName
    • CameraSettings::_projection
    • CameraSettings::_fov
    • CameraSettings::_orthographicWidth
    • CameraSettings::_clipping
    • CameraSettings::_screenWindow
    • CameraSettings::_transforms
  • CopyAndConvertRenderAction
    • CopyAndConvertRenderAction::CopyAndConvertRenderAction()
    • CopyAndConvertRenderAction::~CopyAndConvertRenderAction()
    • CopyAndConvertRenderAction::buildAttribute()
    • CopyAndConvertRenderAction::setAdditionalExrAttrs()
    • CopyAndConvertRenderAction::setOffsetForOverscan()
    • CopyAndConvertRenderAction::_clampOutput
    • CopyAndConvertRenderAction::_colorConvert
    • CopyAndConvertRenderAction::_computeStats
    • CopyAndConvertRenderAction::_convertSettings
    • CopyAndConvertRenderAction::_additionalExrAttrs
    • CopyAndConvertRenderAction::_offsetForOverscan
  • CopyRenderAction
    • CopyRenderAction::CopyRenderAction()
    • CopyRenderAction::~CopyRenderAction()
    • CopyRenderAction::buildAttribute()
    • CopyRenderAction::_tempRenderLocation
  • DiskRenderOutputProcess
    • DiskRenderOutputProcess::UniquePtr
    • DiskRenderOutputProcess::RenderActionPtr
    • DiskRenderOutputProcess::DiskRenderOutputProcess()
    • DiskRenderOutputProcess::~DiskRenderOutputProcess()
    • DiskRenderOutputProcess::setRenderAction()
    • DiskRenderOutputProcess::addPreCommand()
    • DiskRenderOutputProcess::addPostCommand()
    • DiskRenderOutputProcess::buildRenderOutputAttribute()
  • GlobalSettings
    • GlobalSettings::GlobalSettings()
    • GlobalSettings::~GlobalSettings()
    • GlobalSettings::initialise()
    • GlobalSettings::getGlobalSettingsAttr()
    • GlobalSettings::getAttribute()
    • GlobalSettings::_rootIterator
    • GlobalSettings::_globalSettingsAttr
  • IdSenderInterface
    • IdSenderInterface::~IdSenderInterface()
    • IdSenderInterface::getIds()
    • IdSenderInterface::send()
  • NoOutputRenderAction
    • NoOutputRenderAction::NoOutputRenderAction()
    • NoOutputRenderAction::~NoOutputRenderAction()
  • PostCommandsRenderAction
    • PostCommandsRenderAction::PostCommandsRenderAction()
    • PostCommandsRenderAction::~PostCommandsRenderAction()
    • PostCommandsRenderAction::buildAttribute()
    • PostCommandsRenderAction::addCleanupFile()
    • PostCommandsRenderAction::_postCommands
    • PostCommandsRenderAction::_cleanupFiles
  • RenderAction
    • RenderAction::RenderAction()
    • RenderAction::~RenderAction()
    • RenderAction::buildAttribute()
    • RenderAction::setRenderTargetLocation()
    • RenderAction::setLoadOutputInMonitor()
    • RenderAction::setForceOverwriteTarget()
    • RenderAction::setCreateDestinationDirectories()
    • RenderAction::_renderTargetLocation
    • RenderAction::_loadOutputInMonitor
    • RenderAction::_forceOverwriteTarget
    • RenderAction::_createDestinationDirectories
  • RenderBase
    • RenderBase::RenderBase()
    • RenderBase::~RenderBase()
    • RenderBase::setup()
    • RenderBase::cleanup()
    • RenderBase::setRootIterator()
    • RenderBase::start()
    • RenderBase::pause()
    • RenderBase::resume()
    • RenderBase::stop()
    • RenderBase::startLiveEditing()
    • RenderBase::stopLiveEditing()
    • RenderBase::processControlCommand()
    • RenderBase::queueDataUpdates()
    • RenderBase::applyPendingDataUpdates()
    • RenderBase::hasPendingDataUpdates()
    • RenderBase::configureDiskRenderOutputProcess()
    • RenderBase::_configureDiskRenderOutputProcess()
    • RenderBase::setHost()
    • RenderBase::getHost()
    • RenderBase::createSuite()
    • RenderBase::newRenderHandle()
    • RenderBase::_apiVersion
    • RenderBase::_apiName
    • RenderBase::getRootIterator()
    • RenderBase::getRenderMethodName()
    • RenderBase::findArgument()
    • RenderBase::applyRenderThreadsOverride()
    • RenderBase::getKatanaBasePath()
    • RenderBase::getKatanaTempDirectory()
    • RenderBase::getKatanaHost()
    • RenderBase::getRenderTime()
    • RenderBase::useRenderPassID()
    • RenderBase::getRenderOutputFile()
    • RenderBase::isExpandProceduralActive()
    • RenderBase::getRenderPluginDirectory()
    • RenderBase::getEnvironmentVariable()
    • RenderBase::getAttrValue()
    • RenderBase::getStringAttrValue()
  • RenderSettings
    • RenderSettings::ChannelBuffers
    • RenderSettings::Settings
    • RenderSettings::AttributeSettings
    • RenderSettings::CameraMap
    • RenderSettings::RenderOutputs
    • RenderSettings::RenderSettings()
    • RenderSettings::~RenderSettings()
    • RenderSettings::initialise()
    • RenderSettings::isValid()
    • RenderSettings::getCameraName()
    • RenderSettings::getCameraSettings()
    • RenderSettings::getAdditionalCameras()
    • RenderSettings::getCropWindow()
    • RenderSettings::getSampleRate()
    • RenderSettings::getResolutionName()
    • RenderSettings::getResolutionX()
    • RenderSettings::getResolutionY()
    • RenderSettings::getDisplayWindow()
    • RenderSettings::getOverscan()
    • RenderSettings::getDataWindow()
    • RenderSettings::getRegionOfInterest()
    • RenderSettings::getRegionOfInterest()
    • RenderSettings::getRenderer()
    • RenderSettings::applyRenderThreads()
    • RenderSettings::getInteractiveOutputs()
    • RenderSettings::getChannelBuffers()
    • RenderSettings::getRenderOutputs()
    • RenderSettings::getRenderOutputNames()
    • RenderSettings::getNumberOfRenderOutputs()
    • RenderSettings::getRenderOutputByName()
    • RenderSettings::getMaxTimeSamples()
    • RenderSettings::getShutterOpen()
    • RenderSettings::getShutterClose()
    • RenderSettings::isTileRender()
    • RenderSettings::getWindowOrigin()
    • RenderSettings::getDisplayWindowSize()
    • RenderSettings::getDataWindowSize()
    • RenderSettings::getRenderFinishedFilename()
    • RenderSettings::CameraMapPtrs
    • RenderSettings::calculateCropWindow()
    • RenderSettings::processColorOutput()
    • RenderSettings::_rootIterator
    • RenderSettings::_valid
    • RenderSettings::_camera
    • RenderSettings::_additionalCameras
    • RenderSettings::_renderer
    • RenderSettings::_cameraName
    • RenderSettings::_resolution
    • RenderSettings::_overscan
    • RenderSettings::_displayWindow
    • RenderSettings::_finalDisplayWindow
    • RenderSettings::_dataWindow
    • RenderSettings::_finalDataWindow
    • RenderSettings::_cropWindow
    • RenderSettings::_regionOfInterest
    • RenderSettings::_finalRegionOfInterest
    • RenderSettings::_xRes
    • RenderSettings::_yRes
    • RenderSettings::_sampleRate
    • RenderSettings::_useTileRender
    • RenderSettings::_tileRender
    • RenderSettings::_renderThreadsAttr
    • RenderSettings::_maxTimeSamples
    • RenderSettings::_shutterOpen
    • RenderSettings::_shutterClose
    • RenderSettings::_interactiveOutputs
    • RenderSettings::_buffers
    • RenderSettings::_renderOutputs
    • RenderSettings::_renderOutputNames
    • RenderSettings::_enabledRenderOutputNames
    • RenderSettings::_tempDir
    • RenderSettings::_renderFinishedFilename
    • RenderSettings::ChannelBuffer
      • RenderSettings::ChannelBuffer::channelName
      • RenderSettings::ChannelBuffer::bufferId
    • RenderSettings::RenderOutput
      • RenderSettings::RenderOutput::type
      • RenderSettings::RenderOutput::locationType
      • RenderSettings::RenderOutput::renderLocation
      • RenderSettings::RenderOutput::rendererSettings
      • RenderSettings::RenderOutput::colorSpace
      • RenderSettings::RenderOutput::channel
      • RenderSettings::RenderOutput::fileExtension
      • RenderSettings::RenderOutput::cameraName
      • RenderSettings::RenderOutput::convertSettings
      • RenderSettings::RenderOutput::clampOutput
      • RenderSettings::RenderOutput::colorConvert
      • RenderSettings::RenderOutput::computeStats
      • RenderSettings::RenderOutput::tempRenderLocation
      • RenderSettings::RenderOutput::tempRenderId
      • RenderSettings::RenderOutput::enabled
  • ScenegraphLocationDelegate
    • ScenegraphLocationDelegate::~ScenegraphLocationDelegate()
    • ScenegraphLocationDelegate::bootstrap()
    • ScenegraphLocationDelegate::process()
    • ScenegraphLocationDelegate::getSupportedRenderer()
    • ScenegraphLocationDelegate::fillSupportedLocationList()
    • ScenegraphLocationDelegate::createSuite()
    • ScenegraphLocationDelegate::setHost()
    • ScenegraphLocationDelegate::newLocationHandle()
    • ScenegraphLocationDelegate::_apiVersion
    • ScenegraphLocationDelegate::_apiName
  • TemporaryRenderAction
    • TemporaryRenderAction::TemporaryRenderAction()
    • TemporaryRenderAction::~TemporaryRenderAction()
    • TemporaryRenderAction::buildAttribute()
  • RendererInfoBase
    • RendererInfoBase::OpDefinition
    • RendererInfoBase::OpDefinitionQueue
    • RendererInfoBase::RendererInfoBase()
    • RendererInfoBase::~RendererInfoBase()
    • RendererInfoBase::configureBatchRenderMethod()
    • RendererInfoBase::fillRenderMethods()
    • RendererInfoBase::fillRendererObjectTypes()
    • RendererInfoBase::getRendererObjectDefaultType()
    • RendererInfoBase::fillLiveRenderTerminalOps()
    • RendererInfoBase::fillRenderTerminalOps()
    • RendererInfoBase::fillRendererObjectNames()
    • RendererInfoBase::getRegisteredRendererName()
    • RendererInfoBase::getRegisteredRendererVersion()
    • RendererInfoBase::isPresetLocalFileNeeded()
    • RendererInfoBase::isNodeTypeSupported()
    • RendererInfoBase::isPolymeshFacesetSplittingEnabled()
    • RendererInfoBase::fillShaderInputNames()
    • RendererInfoBase::fillShaderInputTags()
    • RendererInfoBase::fillShaderOutputNames()
    • RendererInfoBase::fillShaderOutputTags()
    • RendererInfoBase::fillRendererShaderTypeTags()
    • RendererInfoBase::getRendererCoshaderType()
    • RendererInfoBase::buildLiveRenderControlModules()
    • RendererInfoBase::buildRendererObjectInfo()
    • RendererInfoBase::flushCaches()
    • RendererInfoBase::getPluginPath()
    • RendererInfoBase::getPluginRootPath()
    • RendererInfoBase::setPluginPath()
    • RendererInfoBase::setPluginRootPath()
    • RendererInfoBase::setKatanaPath()
    • RendererInfoBase::getKatanaPath()
    • RendererInfoBase::setTmpPath()
    • RendererInfoBase::getTmpPath()
    • RendererInfoBase::_getRenderMethods()
    • RendererInfoBase::_getBatchRenderMethod()
    • RendererInfoBase::_getRendererObjectNames()
    • RendererInfoBase::_getRendererObjectTypes()
    • RendererInfoBase::_getRendererShaderTypeTags()
    • RendererInfoBase::_getRendererCoshaderType()
    • RendererInfoBase::_getRegisteredRendererName()
    • RendererInfoBase::_getRegisteredRendererVersion()
    • RendererInfoBase::_getRendererObjectDefaultType()
    • RendererInfoBase::_getShaderInputNames()
    • RendererInfoBase::_getShaderInputTags()
    • RendererInfoBase::_getShaderOutputNames()
    • RendererInfoBase::_getShaderOutputTags()
    • RendererInfoBase::_getRendererObjectInfo()
    • RendererInfoBase::_setTypeTagNameFilter()
    • RendererInfoBase::_addObjectLocation()
    • RendererInfoBase::_clearObjectLocations()
    • RendererInfoBase::_flushCaches()
    • RendererInfoBase::_getLiveRenderTerminalOps()
    • RendererInfoBase::_getRenderTerminalOps()
    • RendererInfoBase::configureBasicRenderObjectInfo()
    • RendererInfoBase::EnumPair
    • RendererInfoBase::EnumPairVector
    • RendererInfoBase::ObjectLocationsMap
    • RendererInfoBase::addRenderObjectParam()
    • RendererInfoBase::setShaderParameterMapping()
    • RendererInfoBase::setShaderParameterMapping()
    • RendererInfoBase::getTypeTagsUsingNameFilters()
    • RendererInfoBase::findTypeTagsInObjectTypeTags()
    • RendererInfoBase::getAdditionalObjectLocations()
    • RendererInfoBase::getAdditionalObjectLocations()
  • RenderMethod
    • RenderMethod::RenderMethod()
    • RenderMethod::~RenderMethod()
    • RenderMethod::getType()
    • RenderMethod::buildAttribute()
    • RenderMethod::setName()
    • RenderMethod::getName()
    • RenderMethod::setLabel()
    • RenderMethod::getLabel()
    • RenderMethod::setCreateCatalogItem()
    • RenderMethod::isCreateCatalogItem()
    • RenderMethod::setReportRenderMessages()
    • RenderMethod::isReportRenderMessages()
    • RenderMethod::setRegisterRender()
    • RenderMethod::isRegisterRender()
    • RenderMethod::setDebugOutputSupported()
    • RenderMethod::isDebugOutputSupported()
    • RenderMethod::setSceneGraphDebugOutputSupported()
    • RenderMethod::isSceneGraphDebugOutputSupported()
    • RenderMethod::setDebugOutputFileType()
    • RenderMethod::getDebugOutputFileType()
    • RenderMethod::setVisible()
    • RenderMethod::isVisible()
    • RenderMethod::_name
    • RenderMethod::_label
    • RenderMethod::_debugOutputFileType
    • RenderMethod::_createCatalogItem
    • RenderMethod::_reportRenderMessages
    • RenderMethod::_registerRender
    • RenderMethod::_debugOutputSupported
    • RenderMethod::_sceneGraphDebugOutputSupported
    • RenderMethod::_visible
  • DiskRenderMethod
    • DiskRenderMethod::DiskRenderMethod()
    • DiskRenderMethod::DiskRenderMethod()
    • DiskRenderMethod::~DiskRenderMethod()
    • DiskRenderMethod::getType()
    • DiskRenderMethod::buildAttribute()
    • DiskRenderMethod::setAllowWaitingForRenderCompletion()
    • DiskRenderMethod::isAllowWaitingForRenderCompletion()
    • DiskRenderMethod::kType
    • DiskRenderMethod::kDefaultLabel
    • DiskRenderMethod::kDefaultName
    • DiskRenderMethod::kBatchName
    • DiskRenderMethod::_allowWaitingForRenderCompletion
  • PreviewRenderMethod
    • PreviewRenderMethod::PreviewRenderMethod()
    • PreviewRenderMethod::PreviewRenderMethod()
    • PreviewRenderMethod::~PreviewRenderMethod()
    • PreviewRenderMethod::getType()
    • PreviewRenderMethod::buildAttribute()
    • PreviewRenderMethod::kType
    • PreviewRenderMethod::kDefaultLabel
    • PreviewRenderMethod::kDefaultName
  • LiveRenderMethod
    • LiveRenderMethod::LiveRenderMethod()
    • LiveRenderMethod::LiveRenderMethod()
    • LiveRenderMethod::~LiveRenderMethod()
    • LiveRenderMethod::getType()
    • LiveRenderMethod::buildAttribute()
    • LiveRenderMethod::kType
    • LiveRenderMethod::kDefaultLabel
    • LiveRenderMethod::kDefaultName
  • ShaderInfoCache
    • ShaderInfoCache::Iterator
    • ShaderInfoCache::isEmpty()
    • ShaderInfoCache::flush()
    • ShaderInfoCache::addShaderInfo()
    • ShaderInfoCache::getShaderInfo()
    • ShaderInfoCache::begin()
    • ShaderInfoCache::end()
    • ShaderInfoCache::setNullValue()
  • CameraInfo
    • CameraInfo::CameraInfo()
    • CameraInfo::~CameraInfo()
    • CameraInfo::CameraInfo()
    • CameraInfo::operator=()
    • CameraInfo::isValid()
    • CameraInfo::getFov()
    • CameraInfo::getNear()
    • CameraInfo::getFar()
    • CameraInfo::getLeft()
    • CameraInfo::getRight()
    • CameraInfo::getTop()
    • CameraInfo::getBottom()
    • CameraInfo::getOrtho()
    • CameraInfo::getOrthoWidth()
    • CameraInfo::getXForm()
    • CameraInfo::acceptHandle()
  • ProceduralOutputContextInfo
    • ProceduralOutputContextInfo::ProceduralOutputContextInfo()
    • ProceduralOutputContextInfo::_frameNumber
    • ProceduralOutputContextInfo::_shutterOpen
    • ProceduralOutputContextInfo::_shutterClose
    • ProceduralOutputContextInfo::_cropWindowXMin
    • ProceduralOutputContextInfo::_cropWindowXMax
    • ProceduralOutputContextInfo::_cropWindowYMin
    • ProceduralOutputContextInfo::_cropWindowYMax
    • ProceduralOutputContextInfo::_xres
    • ProceduralOutputContextInfo::_yres
  • Transform
    • Transform::transformList
    • Transform::sampleTimes
  • ShadingNodeConnectionDescription
    • ShadingNodeConnectionDescription::ShadingNodeConnectionDescription()
    • ShadingNodeConnectionDescription::~ShadingNodeConnectionDescription()
    • ShadingNodeConnectionDescription::ShadingNodeConnectionDescription()
    • ShadingNodeConnectionDescription::operator=()
    • ShadingNodeConnectionDescription::isValid()
    • ShadingNodeConnectionDescription::getName()
    • ShadingNodeConnectionDescription::getConnectedNodeName()
    • ShadingNodeConnectionDescription::getConnectedPortName()
    • ShadingNodeConnectionDescription::acceptHandle()
  • ShadingNodeDescription
    • ShadingNodeDescription::ShadingNodeDescription()
    • ShadingNodeDescription::~ShadingNodeDescription()
    • ShadingNodeDescription::ShadingNodeDescription()
    • ShadingNodeDescription::operator=()
    • ShadingNodeDescription::isValid()
    • ShadingNodeDescription::getName()
    • ShadingNodeDescription::getType()
    • ShadingNodeDescription::getNumberOfParameterNames()
    • ShadingNodeDescription::getParameterName()
    • ShadingNodeDescription::getParameter()
    • ShadingNodeDescription::getNumberOfConnectionNames()
    • ShadingNodeDescription::getConnectionName()
    • ShadingNodeDescription::getConnection()
    • ShadingNodeDescription::acceptHandle()
  • ShadingNodeDescriptionMap
    • ShadingNodeDescriptionMap::ShadingNodeDescriptionMap()
    • ShadingNodeDescriptionMap::ShadingNodeDescriptionMap()
    • ShadingNodeDescriptionMap::~ShadingNodeDescriptionMap()
    • ShadingNodeDescriptionMap::isValid()
    • ShadingNodeDescriptionMap::getShadingNodeDescriptionByName()
  • XFormMatrix
    • XFormMatrix::XFormMatrix()
    • XFormMatrix::XFormMatrix()
    • XFormMatrix::getValues()
    • XFormMatrix::invert()
• Profiling Mock Renderer
  • RendererInfoPlugin
    • RendererInfoPlugin::RendererInfoPlugin()
    • RendererInfoPlugin::~RendererInfoPlugin()
    • RendererInfoPlugin::configureBatchRenderMethod()
    • RendererInfoPlugin::fillRenderMethods()
    • RendererInfoPlugin::fillRendererObjectTypes()
    • RendererInfoPlugin::fillRendererObjectNames()
    • RendererInfoPlugin::getRegisteredRendererName()
    • RendererInfoPlugin::getRegisteredRendererVersion()
    • RendererInfoPlugin::buildRendererObjectInfo()
    • RendererInfoPlugin::fillLiveRenderTerminalOps()
    • RendererInfoPlugin::create()
    • RendererInfoPlugin::flush()
  • RenderPlugin
    • RenderPlugin::RenderPlugin()
    • RenderPlugin::~RenderPlugin()
    • RenderPlugin::start()
    • RenderPlugin::stop()
    • RenderPlugin::configureDiskRenderOutputProcess()
    • RenderPlugin::queueDataUpdates()
    • RenderPlugin::hasPendingDataUpdates()
    • RenderPlugin::applyPendingDataUpdates()
    • RenderPlugin::create()
    • RenderPlugin::flush()
    • RenderPlugin::liveRenderingLogLoop()
    • RenderPlugin::m_pendingUpdates
    • RenderPlugin::m_thread
    • RenderPlugin::m_stopped
    • RenderPlugin::m_conditionVariable
    • RenderPlugin::m_mutex
    • RenderPlugin::m_processedLiveUpdates
    • RenderPlugin::m_processedLocationUpdates
    • RenderPlugin::m_updateTimestamp