This class provides access to the Maya Render View. The class allows plugins to send image data to the Render View in the same way that the Maya renderer does. Either a "full render" or a "region
render" can be performed. In a full render, the Render View expects to receive pixel data that fills the entire image, while a region render expects only updates to a specified image region.
Usage
To send an image to the Render View, use the following sequence of calls:
Call doesRenderEditorExist() to make sure that a Render View exists. If this returns false, then Maya is operating in batch mode.
Call setCurrentCamera() to specify the name of the camera that is being rendered.
Call startRender() or startRegionRender() to inform the Render View that you are about to start sending either a full image or a region update. When region rendering, the getRenderRegion() method can be used to retrieve the currently selected marquee region in the Render View.
The image or image region is sent to the Render View as a series of one or more tiles. For each tile, send the tile's image data using the updatePixels() method. Call the refresh() method to refresh the Render View after each tile has been sent.
Call endRender() to signal the Render View that all image data has been sent.
startRegionRender (unsigned int imageWidth, unsigned int imageHeight, unsigned int regionLeft, unsigned int regionRight, unsigned int regionBottom, unsigned int regionTop, bool doNotClearBackground=false, bool immediateFeedback=false)
Informs the Render View that a region render is about to begin. More...
updatePixels (unsigned int left, unsigned int right, unsigned int bottom, unsigned int top, RV_PIXEL *pPixels, bool isHdr=false, const unsigned int numberOfAOVs=0, const RV_AOV *const pAOVs=NULL)
Sends a block of pixels to the Render View. More...
Retrieves the currently selected Render Region in Maya's Render View.
The region extends from the bottom-left corner (left,bottom) to the upper-right corner (right,top) inclusive (i.e. the row y=top and column x=right are part of the region).
Parameters
[out]
left
receives the left extent of the region
[out]
right
receives the right extent of the region
[out]
bottom
receives the bottom extent of the region
[out]
top
receives the top extent of the region
Returns
MS::kSuccess Operation was successful, returned values are valid.
MS::kFailure Operation failed because no Render View existed.
Informs the Render View that a region render is about to begin.
The specified region will be cleared in anticipation of receiving new image data for it. The specified region must lie within the image region (0,0)->(imageWidth-1,imageHeight-1). The region 'left' coordinate must be less than the region 'right' coordinate, and the region 'bottom' coordinate must be less than the region 'top' coordinate.
Parameters
[in]
imageWidth
width of the image in which the region is embedded. (must be greater than zero).
[in]
imageHeight
height of the image in which the region is embedded (must be greater than zero).
[in]
regionLeft
left extent of the region.
[in]
regionRight
right extent of the region. The column x=regionRight is considered part of the region.
[in]
regionBottom
bottom extent of the region.
[in]
regionTop
top extent of the region. The row y=regionTop is considered part of the region.
[in]
doNotClearBackground
When true, the Render View is not cleared before starting to draw. Default (false) is to clear the Render View.
[in]
immediateFeedback
When true, each call to refresh() will immediately redraw the Render View. Default (false) is to wait at least two seconds between redraws.
Pixel colors are represented as 4-channel floating point values. For low dynamic range images, color values are in standard RGB (sRGB) colorspace, and in the range (0,255.0). For high dynamic range (HDR) images, the range is unbounded, and values are in linear CIE XYZ color space, with the X, Y, and Z values stored respectively in the R, G and B fields of the RV_PIXEL structure. Alpha values for HDR images are expected to be in the range (0,1). Out of range alpha values are not clamped, and may behave unexpectedly.
Parameters
[in]
left
left extent of the update region.
[in]
right
right extent of the update region. The column x=right is considered part of the region.
[in]
bottom
bottom extent of the update region.
[in]
top
top extent of the update region. The row y=regionTop is considered part of the region.
[in]
pPixels
buffer containing the pixel data for the image. The buffer should contain (right-left+1)*(top-bottom+1) pixels.
[in]
isHdr
indicates whether the image has high dynamic range
[in]
numberOfAOVs
indicates the number of arbitrary output variable (AOV) buffers (not yet implemented).
[in]
pAOVs
array of RV_AOV objects. The height and width of each AOV must match pPixels (not yet implemented).