rfm2.api.displays Namespace Reference

Functions
def	set_display_type
def	get_displays

Detailed Description

Scripting functions related to displays and display channels.

Function Documentation

def rfm2.api.displays.get_displays

(

as_json = False

)

Return a dict describing the current AOV settings. See example below.
- Message attributes return their connection or None if not connected.
- The 'filePath' field is un-substituted but contains the full path to the
  final image for that display (with proper slashes/backslashes depending
  on the current platform).
- The function will take into account:
  - the mode (interactive/batch)
  - the image destination (viewport/render/it/driver)
  - the 'enable' state of the displays/displayChannels.

This functions should be called at the begining of the render to get the
AOV configuration. The returned data can then be re-used accross frames,
and each display's 'filePath' field used to compute the final image
location.

{ 'channels': {
    u'Ci': { u'channelSource': { 'type': u'string', 'value': u'Ci'},
             u'channelType': { 'type': u'string', 'value': u'color'},
             u'enable': { 'type': u'int', 'value': True},
             u'lpeLightGroup': { 'type': u'string', 'value': None},
             u'remapBreakPoint': { 'type': u'float', 'value': 0.0},
             u'remapMaxValue': { 'type': u'float', 'value': 0.0},
             u'remapSmoothness': { 'type': u'float', 'value': 0.0}
           },
    u'a': { u'channelSource': { 'type': u'string', 'value': u'a'},
            u'channelType': { 'type': u'string', 'value': u'float'},
            u'enable': { 'type': u'int', 'value': True},
            u'lpeLightGroup': { 'type': u'string', 'value': None},
            u'remapBreakPoint': { 'type': u'float', 'value': 0.0},
            u'remapMaxValue': { 'type': u'float', 'value': 0.0},
            u'remapSmoothness': { 'type': u'float', 'value': 0.0}
          }
  },
  'displays': { u'rmanDefaultDisplay':
                  { 'driverType': u'd_openexr',
                    'filePath': u'<ws>/images/<scene>_<jobid>/<scene>_<layer>_<aov>.<f4>.<ext>',
                    'params': { u'enable': { 'type': u'int', 'value': True},
                                u'displayChannels': { 'type': u'message', 'value': [ u'Ci', u'a']},
                                u'displayType': { 'type': u'message', 'value': u'd_openexr'},
                                u'remapBreakPoint': { 'type': u'float', 'value': 0.0},
                                u'remapMaxValue': { 'type': u'float', 'value': 0.0},
                                u'remapSmoothness': { 'type': u'float', 'value': 0.0}
                              }
                  }
              }
}

Here is the call graph for this function:

def rfm2.api.displays.set_display_type	(		display_type,
			display = None
	)

Change the display type used by the specified display node.

Args:
- display_type (str): name of the type.
- display (str): name of the display node.  If not specified, all displays are set.

Returns:
- None