Renderer API

Classes
class	Foundry::Katana::Render::CameraSettings
	A utility class which provides Katana's camera settings by parsing attribute data on camera scene graph locations. This class can be extended if renderer specific processing is required. More...
class	Foundry::Katana::Render::CopyAndConvertRenderAction
	A render action which renders to a temporary location and then performs a conversion based on the input parameters which include convert settings attributes. The converted file is then copied to the target location. More...
class	Foundry::Katana::Render::CopyRenderAction
	A render action which renders to a temporary location and then copies the rendered file to the target location. More...
class	Foundry::Katana::Render::DiskRenderOutputProcess
	Configures the render process for disk renders and defines how render outputs are managed. More...
class	Foundry::Katana::Render::GlobalSettings
	A utility class which provides a renderer's global settings from the Katana recipe if they are used. The attributes can be found on the root scene graph location at [rendererName]GlobalStatements. This class is a placeholder and can be extended to provide renderer specific parsing and access functions. More...
class	Foundry::Katana::Render::IdSenderInterface
	An interface for sending (ID, scene graph location name) pairs to Katana. This mapping is then used by the color picker to map a picked ID value in the monitor to the name of the corresponding scene graph location. More...
class	Foundry::Katana::Render::NoOutputRenderAction
	A render action which does not specify any output locations. More...
class	Foundry::Katana::Render::PostCommandsRenderAction
	A render action which renders to a temporary location and then runs post commands to process image and copy to target render location. More...
class	Foundry::Katana::Render::RenderAction
	A render action which renders directly to the target location. More...
class	Foundry::Katana::Render::RenderBase
	The base class for the render plug-in which takes a Katana recipe and converts it into the renderer's language. More...
class	Foundry::Katana::Render::RenderSettings
	A utility class which represents a collection of render settings which originate from the renderSettings attributes and other relevant modules. This class can be extended if renderer specific processing is required. More...
class	Foundry::Katana::Render::ScenegraphLocationDelegate
	Super-Class that enables the creation of user-defined sub-classes and plug-ins responsible for processing/rendering different location types. More...
class	Foundry::Katana::Render::TemporaryRenderAction
	A render action which renders to a temporary location. More...
class	Foundry::Katana::RendererInfo::RendererInfoBase
	The renderer info plug-in provides Katana with renderer specific information such as shaders and render outputs, as well as configuring how a render is launched. More...
class	Foundry::Katana::RendererInfo::RenderMethod
	... More...
class	Foundry::Katana::RendererInfo::DiskRenderMethod
	... More...
class	Foundry::Katana::RendererInfo::PreviewRenderMethod
	... More...
class	Foundry::Katana::RendererInfo::LiveRenderMethod
	... More...
class	Foundry::Katana::RendererInfo::ShaderInfoCache< TShaderInfoType >
	Caches a map of shader names and attributes for quick access by Renderer Info Plug-ins. More...
class	Foundry::Katana::RenderOutputUtils::CameraInfo
	CameraInfo. More...
struct	Foundry::Katana::RenderOutputUtils::ProceduralOutputContextInfo
struct	Foundry::Katana::RenderOutputUtils::Transform
class	Foundry::Katana::RenderOutputUtils::ShadingNodeConnectionDescription
	ShadingNodeConnectionDescription. More...
class	Foundry::Katana::RenderOutputUtils::ShadingNodeDescription
	ShadingNodeDescription. More...
class	Foundry::Katana::RenderOutputUtils::ShadingNodeDescriptionMap
	ShadingNodeDescriptionMap. More...
class	Foundry::Katana::RenderOutputUtils::XFormMatrix
	... More...
Modules
	RendererObjectDefinitions
	Supported renderer object definitions such as object and parameter types, renderer object key properties, and parameter value types.
	RenderOutputUtils
	A collection of utility functions and classes for processing the Katana recipe.
Functions
void	Foundry::Katana::RenderOutputUtils::flushProceduralDsoCaches (const std::string &apiName="")
int	Foundry::Katana::RenderOutputUtils::getPixelAreaThroughCamera (FnScenegraphIterator sgIterator, const std::string &cameraName, const std::string &resolution)
void	Foundry::Katana::RenderOutputUtils::findSampleTimesRelevantToShutterRange (std::vector< float > &sampleTimes, const std::set< float > &inputSamples, float shutterOpen, float shutterClose)
std::string	Foundry::Katana::RenderOutputUtils::getRenderResolution (FnScenegraphIterator rootIterator, int *width, int *height)
std::string	Foundry::Katana::RenderOutputUtils::getCameraPath (FnScenegraphIterator rootIterator)
void	Foundry::Katana::RenderOutputUtils::fillXFormListForLocation (std::vector< Transform > &xFormList, FnScenegraphIterator sgIterator, float shutterClose=0.0f)
bool	Foundry::Katana::RenderOutputUtils::fillXFormListFromAttributes (std::vector< Transform > &xFormList, const FnAttribute::GroupAttribute &xformAttr, float shutterClose=0.0f, bool invertMatrix=true)
FnAttribute::GroupAttribute	Foundry::Katana::RenderOutputUtils::convertTexturesToArbitraryAttr (const FnAttribute::GroupAttribute &texturesAttr)
FnAttribute::GroupAttribute	Foundry::Katana::RenderOutputUtils::getFlattenedMaterialAttr (FnScenegraphIterator sgIterator, const FnAttribute::StringAttribute &terminalNamesAttr)
void	Foundry::Katana::RenderOutputUtils::emptyFlattenedMaterialCache ()
CameraInfo	Foundry::Katana::RenderOutputUtils::getCameraInfo (FnScenegraphIterator sgIterator, const std::string &cameraInfoPath)
bool	Foundry::Katana::RenderOutputUtils::processLocation (FnScenegraphIterator sgIterator, const std::string &rendererName, const std::string &locationName, void *optionalInput, void **optionalOutput)
void	Foundry::Katana::RenderOutputUtils::fillDelegateHandledLocationTypesList (std::vector< std::string > &delegateHandledLocationTypesList, const std::string &renderer=std::string())
std::string	Foundry::Katana::RenderOutputUtils::buildTempRenderLocation (FnScenegraphIterator sgIterator, const std::string &outputName, const std::string &prefix, const std::string &fileExtension, const float frameTime)
std::string	Foundry::Katana::RenderOutputUtils::buildTileLocation (FnScenegraphIterator sgIterator, const std::string &outputPath)

---

Function Documentation

Foundry::Katana::RenderOutputUtils::buildTempRenderLocation	(	FnScenegraphIterator	sgIterator,
		const std::string &	outputName,
		const std::string &	prefix,
		const std::string &	fileExtension,
		const float	frameTime
	)

Build a render location in the temporary directory for a render output.

Parameters:

sgIterator	The root scene graph iterator
outputName	The name of the render output
prefix	The filename prefix
fileExtension	The filename extension
frameTime	The current frame time

Returns:

The built temporary location for the render output

Foundry::Katana::RenderOutputUtils::buildTileLocation	(	FnScenegraphIterator	sgIterator,
		const std::string &	outputPath
	)

Build a tile location from the render settings for a given output path.

Parameters:

sgIterator	The root scene graph iterator
outputPath	The output path for the built tile filename

Returns:

The location to a tile location which consists of the output path and the built tile filename using the tile render settings

FnAttribute::GroupAttribute Foundry::Katana::RenderOutputUtils::convertTexturesToArbitraryAttr

(

const FnAttribute::GroupAttribute &

texturesAttr

)

convertTexturesToArbitraryAttr

void Foundry::Katana::RenderOutputUtils::emptyFlattenedMaterialCache

(

)

emptyFlattenedMaterialCache

Foundry::Katana::RenderOutputUtils::fillDelegateHandledLocationTypesList	(	std::vector< std::string > &	delegateHandledLocationTypesList,
		const std::string &	renderer = std::string()
	)

Returns a vector containing the location types for which there are registered ScenegraphLocationDelegate plugins. Specifying an empty string for the renderer forces a search for location types with ScenegraphLocationDelegate plugins for any renderer.

Parameters:

delegateHandledLocationTypesList	a reference to a vector that will be filled with location type names; one for each location type that is handled by a registered delegate.
renderer	The renderer name, can be empty to denote any-renderer

void Foundry::Katana::RenderOutputUtils::fillXFormListForLocation	(	std::vector< Transform > &	xFormList,
		FnScenegraphIterator	sgIterator,
		float	shutterClose = 0.0f
	)

fillXFormListForLocation

bool Foundry::Katana::RenderOutputUtils::fillXFormListFromAttributes	(	std::vector< Transform > &	xFormList,
		const FnAttribute::GroupAttribute &	xformAttr,
		float	shutterClose = 0.0f,
		bool	invertMatrix = true
	)

fillXFormListFromAttributes

void Foundry::Katana::RenderOutputUtils::findSampleTimesRelevantToShutterRange	(	std::vector< float > &	sampleTimes,
		const std::set< float > &	inputSamples,
		float	shutterOpen,
		float	shutterClose
	)

findSampleTimesRelevantToShutterRange

void Foundry::Katana::RenderOutputUtils::flushProceduralDsoCaches

(

const std::string &

apiName = ""

)

flushProceduralDsoCaches

CameraInfo Foundry::Katana::RenderOutputUtils::getCameraInfo	(	FnScenegraphIterator	sgIterator,
		const std::string &	cameraInfoPath
	)

getCameraInfo

std::string Foundry::Katana::RenderOutputUtils::getCameraPath

(

FnScenegraphIterator

rootIterator

)

getCameraPath

FnAttribute::GroupAttribute Foundry::Katana::RenderOutputUtils::getFlattenedMaterialAttr	(	FnScenegraphIterator	sgIterator,
		const FnAttribute::StringAttribute &	terminalNamesAttr
	)

getFlattenedMaterialAttr

int Foundry::Katana::RenderOutputUtils::getPixelAreaThroughCamera	(	FnScenegraphIterator	sgIterator,
		const std::string &	cameraName,
		const std::string &	resolution
	)

getPixelAreaThroughCamera

std::string Foundry::Katana::RenderOutputUtils::getRenderResolution	(	FnScenegraphIterator	rootIterator,
		int *	width,
		int *	height
	)

getRenderResolution

Foundry::Katana::RenderOutputUtils::processLocation	(	FnScenegraphIterator	sgIterator,
		const std::string &	rendererName,
		const std::string &	locationName,
		void *	optionalInput,
		void **	optionalOutput
	)

Process a scene graph location for given a location type and renderer name. Looks up a scene graph location delegate plug-in given a location type and renderer name. If a plug-in is found the rendering/processing for this location is delegated to the plug-in where it operates on the corresponding scene graph iterator.

Parameters:

sgIterator	A scene graph iterator for the location to process.
rendererName	The name of the processor/renderer that should be used (can be empty to signify any-renderer).
locationName	The location type as retrieved from Foundry::Katana::SceneGraphIterator::getType() (must not empty).
optionalInput	Optional input data for the plug-in.
optionalOutput	Optional pointer that will point to the result of the processing/rendering.

Returns:

true if a plug-in is found, false otherwise.