pymel.core.rendering.ogsRender

ogsRender(*args, **kwargs)

Renders an image or a sequence using the OGS rendering engine

Flags:
Long name (short name) Argument Types Properties
activeMultisampleType (mst) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Query the current active multisample type.
activeRenderOverride (cro) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Set or query the current active render override.
activeRenderTargetFormat (fpt) unicode ../../../_images/query.gif ../../../_images/edit.gif
 

Query the current active floating point target format.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

availableFloatingPointTargetFormat (afp) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Returns the names of available floating point render target format.
availableMultisampleType (amt) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Returns the names of available multisample type.
availableRenderOverrides (aro) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Returns the names of available render overrides.
camera (cam) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specify the camera to use. Use the first available camera if the camera given is not found.
currentFrame (cf) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Render the current frame.
currentView (cv) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
When turned on, only the current view will be rendered.
enableFloatingPointRenderTarget (efp) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Enable/disable floating point render target.
enableMultisample (ems) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Enable/disable multisample.
frame (f) float ../../../_images/create.gif ../../../_images/edit.gif
 
Specify the frame to render.
height (h) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The height flag pass the height to the ogsRender command. If not used, the height is taken from the render globals settings.
layer (l) PyNode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

Render the specified render layer. Only this render layer will be rendered, regardless of the renderable attribute value of the render layer. The layer name will be appended to the output image file name. The specified render layer becomes the current render layer before rendering, and remains as current render layer after the rendering.

noRenderView (nrv) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
When turned on, the render view is not updated after image computation
width (w) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The width flag pass the width to the ogsRender command. If not used, the width is taken from the render globals settings.

Derived from mel command maya.cmds.ogsRender

Example:

import pymel.core as pm

# Create a poly sphere.
pm.polySphere()
# Render it
# It will try to save the image with format according
# to the file name saved in render globals.
pm.ogsRender(w=480,h=270)
pm.ogsRender(w=480,h=270)

Previous topic

pymel.core.rendering.nodePreset

Next topic

pymel.core.rendering.orbit

Core

Core Modules

Other Modules

This Page