ogsRender

Go to: Synopsis. Return value. Keywords. Flags. Python examples.

Synopsis

ogsRender([activeMultisampleType=string], [activeRenderOverride=string], [activeRenderTargetFormat=string], [availableFloatingPointTargetFormat= boolean], [availableMultisampleType=boolean], [availableRenderOverrides=boolean], [camera=string], [currentFrame=boolean], [currentView=boolean], [enableFloatingPointRenderTarget= boolean], [enableMultisample=boolean], [frame=float], [height=uint], [layer=name], [noRenderView=boolean], [width=uint])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

ogsRender is NOT undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Keywords

Flags

Long name (short name)	Argument types	Properties
width(w)	uint
The width flag pass the width to the ogsRender command. If not used, the width is taken from the render globals settings.
height(h)	uint
The height flag pass the height to the ogsRender command. If not used, the height is taken from the render globals settings.
camera(cam)	string
Specify the camera to use. Use the first available camera if the camera given is not found.
currentView(cv)	boolean
When turned on, only the current view will be rendered.
layer(l)	name
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)	boolean
When turned on, the render view is not updated after image computation
frame(f)	float
Specify the frame to render.
currentFrame(cf)	boolean
Render the current frame.
availableRenderOverrides( aro)	boolean
Returns the names of available render overrides.
activeRenderOverride(cro)	string
Set or query the current active render override.
enableMultisample(ems)	boolean
Enable/disable multisample.
availableMultisampleType( amt)	boolean
Returns the names of available multisample type.
activeMultisampleType(mst)	string
Query the current active multisample type.
enableFloatingPointRenderTarget( efp)	boolean
Enable/disable floating point render target.
availableFloatingPointTargetFormat( afp)	boolean
Returns the names of available floating point render target format.
activeRenderTargetFormat( fpt)	string
Query the current active floating point target format.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

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