Display Driver Host API

Classes
class	Foundry::Katana::CloseMessage
	The CloseMessage class encapsulates the message sent to Katana instructing it that there is no more data for the specified channel. More...
class	Foundry::Katana::DataMessage
	The DataMessage class encapsulates the message sent to the Katana Catalog Server (KCS) which actually contains image data for a given channel. More...
class	Foundry::Katana::EndOfRenderMessage
	The EndOfRenderMessage class encapsulates the message sent to Katana instructing it that there is no more data for the specified channel and it can clear up any data structures that it maintains for this channel. More...
class	Foundry::Katana::KatanaPipe
	The KatanaPipe is used to send messages to the specified Katana Catalog Server. More...
class	Foundry::Katana::PipeSingleton
	The PipeSingleton provides a singleton wrapper around the KatanaPipe. More...
class	Foundry::Katana::Message
	This is the base class against which all Messages sent to Katana should inherit from. More...
class	Foundry::Katana::NewChannelMessage
	The NewChannelMessage class encapsulates the message sent to the Katana Catalog Server (KCS) to specify that a new channel should be reserved in the Catalog for a given frame. More...
class	Foundry::Katana::NewChannelMessage_v2
	The NewChannelMessage_v2 class encapsulates the message sent to Katana indicating that a new channel should be reserved in the Catalog for a given frame. More...
class	Foundry::Katana::NewFrameMessage
	The NewFrameMessage class encapsulates the message sent to the Katana Catalog Server (KCS) to specify that a new frame should be reserved in the Catalog. More...
Functions
void	Foundry::Katana::encodeLegacyName (const std::string &legacyFrameName, int legacyFrameNumber, std::string &buffer)
	This is a utility function to allow the simple encoding of legacy frameNames and frame numbers to be used with the latest Render Data Protocol.

---

Function Documentation

void Foundry::Katana::encodeLegacyName	(	const std::string &	legacyFrameName,
		int	legacyFrameNumber,
		std::string &	buffer
	)

This is a utility function to allow the simple encoding of legacy frameNames and frame numbers to be used with the latest Render Data Protocol.

Parameters:

[in]	legacyFrameName	the frame name to be encoded.
[in]	legacyFrameNumber	the frame number to be encoded.
[out]	buffer	where the encoding can be found.