RenderManAPI  24.0
RixDisplayChannel Struct Reference

Note that the same channel name may appear multiple times within a list of RixDisplayChannels. More...

#include <RixIntegrator.h>

Public Types

enum  ChannelStyle { k_ChannelName, k_ChannelExpression }
 
enum  ChannelType {
  k_FloatChannel, k_RGBChannel, k_PointChannel, k_NormalChannel,
  k_IntegerChannel
}
 

Public Attributes

RixChannelId id
 
enum RixDisplayChannel::ChannelStyle style
 
enum RixDisplayChannel::ChannelType type
 
RtUString channel
 

Detailed Description

Note that the same channel name may appear multiple times within a list of RixDisplayChannels.

This may be caused by either the "string source" parameter to DisplayChannel or the particular AOV being output multiple times.

For RixDisplayServices and RixSampleFilterContext, a single id value from any matching entry (e.g., the first) will suffice to affect all outputs. For RixDisplayFilterContext, you probably want to filter using the id values from all matching entries since each corresponds to a particular output.

Member Enumeration Documentation

◆ ChannelStyle

Enumerator
k_ChannelName 
k_ChannelExpression 

◆ ChannelType

Enumerator
k_FloatChannel 
k_RGBChannel 
k_PointChannel 
k_NormalChannel 
k_IntegerChannel 

Member Data Documentation

◆ channel

RtUString RixDisplayChannel::channel

◆ id

RixChannelId RixDisplayChannel::id

◆ style

enum RixDisplayChannel::ChannelStyle RixDisplayChannel::style

◆ type

enum RixDisplayChannel::ChannelType RixDisplayChannel::type

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