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