Foundry::Katana::NewChannelMessage_v2 Class Reference

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...

#include <NewChannelMessage.h>

Inheritance diagram for Foundry::Katana::NewChannelMessage_v2:

List of all members.

Public Member Functions
	NewChannelMessage_v2 (const uint8_t *frameID, uint16_t channelID=0, PixelLayout pixelLayout=ARGB, uint32_t height=0, uint32_t width=0, int xorigin=0, int yorigin=0, float sampleRate1=0.0, float sampleRate2=0.0, uint32_t dataSize=0)
	Create a new instance of a NewChannelMessage specifying a pointer to a 16 byte array that will contain a unique frame ID.
	NewChannelMessage_v2 (const NewFrameMessage &frame, uint16_t channelID=0, PixelLayout pixelLayout=ARGB, uint32_t height=0, uint32_t width=0, int xorigin=0, int yorigin=0, float sampleRate1=0.0, float sampleRate2=0.0, uint32_t dataSize=0)
	Create a new instance of NewChannelMessage_v2 message using an existing NewFrame object to obtain the unique frame ID.
virtual	~NewChannelMessage_v2 ()
	Destroy the NewChannelMessage_v2 instance.
void	setPixelLayout (PixelLayout pixelLayout)

---

Detailed Description

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.

The NewChannelMessage message should be sent down the KatanaPipe after a NewFrame message has been sent as the NewFrame message will reserve the frame in the Catalog.

A channel represents a given output pass by a renderer, such as the primary colour pass, id pass, depth pass P pass etc. The channel also defines the pixel layout of subsequent DataMessages.

Each NewChannelMessage object must be created with with reference to a valid unique frame ID so Katana will know which frame the channel belongs to.

---

Constructor & Destructor Documentation

Foundry::Katana::NewChannelMessage_v2::NewChannelMessage_v2	(	const uint8_t *	frameID,
		uint16_t	channelID = 0,
		PixelLayout	pixelLayout = ARGB,
		uint32_t	height = 0,
		uint32_t	width = 0,
		int	xorigin = 0,
		int	yorigin = 0,
		float	sampleRate1 = 0.0,
		float	sampleRate2 = 0.0,
		uint32_t	dataSize = 0
	)

Create a new instance of a NewChannelMessage specifying a pointer to a 16 byte array that will contain a unique frame ID.

The default for other values will create a new channel belonging to the specified frame with all values set to 0 and an empty string for the channel name.

Parameters:

[in]	frameID	a pointer to a 16 byte array containing a unique 128 bit frame ID.
[in]	channelID	an ID number to identify this channel within the frame. (This can just be sequential from zero).
[in]	pixelLayout	the order of components for all pixels.
[in]	height	the height of this channel in pixels.
[in]	width	the width of this channel in pixels.
[in]	xorigin	the x origin of this channel relative to the frame's x origin
[in]	yorigin	the y origin of this channel relative to the frame's y origin.
[in]	sampleRate1	sampleRate1
[in]	sampleRate2	sampleRate2
[in]	dataSize	the size - in bytes - of a single pixel of data for this channel.

See also:

setChannelName()

Foundry::Katana::NewChannelMessage_v2::NewChannelMessage_v2	(	const NewFrameMessage &	frame,
		uint16_t	channelID = 0,
		PixelLayout	pixelLayout = ARGB,
		uint32_t	height = 0,
		uint32_t	width = 0,
		int	xorigin = 0,
		int	yorigin = 0,
		float	sampleRate1 = 0.0,
		float	sampleRate2 = 0.0,
		uint32_t	dataSize = 0
	)

Create a new instance of NewChannelMessage_v2 message using an existing NewFrame object to obtain the unique frame ID.

The default constructor will create a new channel belonging to the specified frame with all values set to 0 and an empty string for the channel name.

Note: the NewChannelMessage_v2 object will NOT maintain a reference to NewFrameMessage or assume ownership of it.

Parameters:

[in]	frame	an existing NewFrameMessage object
[in]	channelID	an ID number to identify this channel within the frame. (This can just be sequential from zero).
[in]	pixelLayout	the order of components for all pixels.
[in]	height	the height of this channel in pixels.
[in]	width	the width of this channel in pixels.
[in]	xorigin	the x origin of this channel relative to the frame's x origin
[in]	yorigin	the y origin of this channel relative to the frame's y origin.
[in]	sampleRate1	sampleRate1
[in]	sampleRate2	sampleRate2
[in]	dataSize	the size - in bytes - of a single pixel of data for this channel.

See also:

setChannelName()

---

Member Function Documentation

void Foundry::Katana::NewChannelMessage_v2::setPixelLayout

(

PixelLayout

pixelLayout

)

Sets the pixel layout for all DataMessages that will be sent by the renderer for this channel/AOV.

Parameters:

pixelLayout

the pixel layout that will be sent.

---

The documentation for this class was generated from the following file:

• NewChannelMessage.h