pymel.core.rendering.glRender

static rendering.glRender(*args, **kwargs)

This command provides access to the Hardware Render Manager (HRM). There is one-and-only-one HRM in maya. The HRM controls the rendering performed in the hardware render buffer window. This command allows shell scripts, to modify the render state, and to initiate a render request. In query mode, return type is based on queried flag.

Flags:
Long name (short name) Argument Types Properties
accumBufferPasses (abp) int ../../../_images/query.gif ../../../_images/edit.gif
 
Set the number of accum buffer render passes.
alphaSource (alphaSource) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Control the alpha source when writing image files. Valid values include: off, alpha, red, green, blue, luminance, clamp, invClamp.
antiAliasMethod (aam) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Set the method used for anti-aliasing polygons: off, uniform, gaussian.
cameraIcons (ci) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Set display status of camera icons.
clearClr (cc) float, float, float ../../../_images/query.gif ../../../_images/edit.gif
 
Set the viewport clear color (0 - 1).
collisionIcons (coi) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Set display status of collison model icons.
crossingEffect (ce) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Enable/disable image filtering with a convolution filter.
currentFrame (cf) bool ../../../_images/query.gif
 
Returns the current frame being rendered.
drawStyle (ds) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Set the object drawing style: boundingBox, points, wireframe, flatShaded, smoothShaded.
edgeSmoothness (es) float ../../../_images/query.gif ../../../_images/edit.gif
 

Controls the amount of edge smoothing. A value of 0.0 gives no smoothing, 1.0 gives default smoothing, and any other value scales the amount of default smoothing. Must enable the accumulation buffer.

emitterIcons (ei) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Set display status of emitter icons.
fieldIcons (fii) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Set display status of field icons.
flipbookCallback (fc) unicode ../../../_images/query.gif ../../../_images/edit.gif
 

Register a procedure to be called after the render sequence has completed. Used to build the flipbook pulldown menu. See the example section for more details about how to build this procedure.

frameEnd (fe) int ../../../_images/query.gif ../../../_images/edit.gif
 
Set the last frame to be rendered.
frameIncrement (fi) int ../../../_images/query.gif ../../../_images/edit.gif
 
Set the frame increment during rendering.
frameStart (fs) int ../../../_images/query.gif ../../../_images/edit.gif
 
Set the first frame to be rendered.
fullResolution (fr) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Enable/disable rendering to full image output resolution. Must set a valid image output resolution (-is).
grid (gr) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Set display status of the grid.
imageDirectory (id) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Set the directory for the image files.
imageName (imageName) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Set the base name of the image files.
imageSize (imageSize) int, int, float ../../../_images/query.gif ../../../_images/edit.gif
 

Set the image output size. Takes width, height and aspect ratio. Pass 0,0,0 to use current port size. The image size must be equal to or greater then the viewport size. Large images will be tiled if full resolution rendering has been enabled (-fr/fullResolution).

lightIcons (li) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Set display status of light icons.
lightingMode (lm) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Set the lighting mode used for rendering: all, selected, default.
lineSmoothing (ls) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Enable/disable anti-aliased lines.
offScreen (os) bool ../../../_images/query.gif ../../../_images/edit.gif
 
When set, this toggle allow HRM to use an offscreen buffer to render the view. This allows HRM to work when the application is iconified, or obscured
renderFrame (rf) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Render the current frame. Requires the name of the view in which to render.
renderSequence (rs) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Render the current frame sequence. Requires the name of the view in which to render.
sharpness (sh) float ../../../_images/query.gif ../../../_images/edit.gif
 
Control the sharpness level of the convolution filter.
shutterAngle (sa) float ../../../_images/query.gif ../../../_images/edit.gif
 

Set the shutter angle used for motion blur (0 - 1). A value of 0.0 gives no blurring, 0.5 gives correct blurring, and 1.0 gives continuous blurring. Must enable the accumulation buffer.

textureDisplay (txd) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Enable/disable texture map display.
transformIcons (ti) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Set display status of transform icons.
useAccumBuffer (uab) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Enable/disable the accumulation buffer.
viewport (vp) int, int, float ../../../_images/query.gif ../../../_images/edit.gif
 

Set the viewport size. Pass in the width, height and aspect ratio. This size will be used for all test rendering and image output size unless full resolution (-fr) has been set and a valid image output size (-is) has been set.

writeDepthMap (wdm) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Enable/disable writing of zdepth to image files. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.glRender

Example:

import pymel.core as pm

# Do a hardware render
pm.glRender(e=1)

Previous topic

pymel.core.rendering.frameBufferName

Next topic

pymel.core.rendering.glRenderEditor

Core

Core Modules

Other Modules

This Page