hwRender

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

Synopsis

hwRender([acceleratedMultiSampleSupport=boolean], [activeTextureCount=boolean], [camera=string], [currentFrame=boolean], [currentView=boolean], [edgeAntiAliasing=[uint, uint]], [fixFileNameNumberPattern=boolean], [frame=float], [fullRenderSupport=boolean], [height=uint], [imageFileName=boolean], [layer=name], [limitedRenderSupport=boolean], [lowQualityLighting=boolean], [noRenderView=boolean], [notWriteToFile=boolean], [printGeometry=boolean], [renderHardwareName=boolean], [renderRegion=[uint, uint, uint, uint]], [renderSelected=boolean], [textureResolution=uint], [width=uint], [writeAlpha=boolean], [writeDepth=boolean])

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

hwRender is NOT undoable, queryable, and NOT editable.

Return value

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

Keywords

Related

Flags

Long name (short name)	Argument types	Properties
acceleratedMultiSampleSupport(ams)	boolean
This flag when used with query will return whether the graphics supports hardware accelerated multi-sampling.
activeTextureCount(atc)	boolean
This flag when used with query will return the number of textures that have been bound to the graphics by the hardware renderer.
camera(cam)	string
Specify the camera to use. Use the first available camera if the camera given is not found.
currentFrame(cf)	boolean
Render the current frame.
currentView(cv)	boolean
When turned on, only the current view will be rendered.
edgeAntiAliasing(eaa)	[uint, uint]
Enables multipass rendering. Controls for the number of exposures rendered per frame are provided in the form of two associated flag arguments. The first specifies the sampling algorithm: 0 - Uniform Weighted Grid Sampling 1 - Rotated Grid Super Sampling (RGSS) 2 - Gaussian Weighted Sampling Use of a sampling method other than the others listed above, will result in use of the default sample method of Uniform Weighted Grid Sampling. The second argument specifies a number of samples to use. For each sampling algorithm there is a fixed set of sample counts available: 0 - Uniform Weighted Grid Sampling 1 Sample 3 Samples 4 Samples 5 Samples 7 Samples 9 Samples 16 Samples 25 Samples 36 Samples 1 - Rotated Grid Super Sampling (RGSS) 1 Sample 4 Samples 5 Samples 2 - Gaussian Weighted Sampling 1 Sample 3 Samples 4 Samples 5 Samples 7 Samples 9 Samples 16 Samples 25 Samples 36 Samples Using a sampling count other than the allowable options for the given sampling method will result in using the default sample count of 5. The values passed via the command will override settings stored in the hardwareRenderGlobals node.
fixFileNameNumberPattern(fnp)	boolean
This flag allows the user to take the hardwareRenderGlobals filename as the initial filename pattern, fix the frame number pattern in the filename in a unique way, returns the new filename pattern. This does not change the hardwareRenderGlobals's filename.
frame(f)	float
Specify the frame to render.
fullRenderSupport(frs)	boolean
This flag may be used in the create or query context. In the create context, it will force the renderer to abort and not render any frames if the hardware is not fully supported. In the query context, it will return whether full quality rendering is supported on the current graphics system. Please see the graphics card qualification charts for an explanation of limited support.
height(h)	uint
Height. If not used, the height is taken from the render globals settings.
imageFileName(ifn)	boolean
This flag let people query the image name for a specified frame. The frame can be specified using the "-frame" flag. When no "-frame" is used, the current frame number is used.
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.
limitedRenderSupport(lrs)	boolean
This flag when used with query will return whether limited rendering is supported on the current graphics system. Please see the graphics card qualification charts for the current definition of limited support.
lowQualityLighting(lql)	boolean
Disable lighting evaluation per pixel (fragment). Note: The values passed via the command will override settings stored in the hardware render globals node.
noRenderView(nrv)	boolean
When turned on, the render view is not updated after image computation
notWriteToFile(nwf)	boolean
This flag is set to true if the user does not want to write the image to a file. It is set to false, otherwise. The default value of the flag is "false".
printGeometry(pg)	boolean
Print the geomety objects as they get translated.
renderHardwareName(rhw)	boolean
This flag will create a graphics context and return the name of the graphics hardware being used. The graphics hardware is determined by creating an off screen buffer and querying the GL_RENDERER string from OpenGL. If the off screen buffer cannot be created an empty string is returned.
renderRegion(reg)	[uint, uint, uint, uint]
Render region. The parameters are 4 integers, indicating left right bottom top of the region.
renderSelected(rs)	boolean
Only renders the selected objects.
textureResolution(res)	uint
Specify the desired resolution of baked textures.
width(w)	uint
Width. If not used, the width is taken from the render globals settings.
writeAlpha(a)	boolean
Read the alpha channel of color buffer and return as tif file.
writeDepth(d)	boolean
Read the depth buffer and return as tif file.

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
cmds.hwRender()

# Render the region where left=20, right=50, bottom=30, top=60.
# And do not write the output to a file.
#
cmds.hwRender( renderRegion=(20, 50, 30, 60), notWriteToFile=True )

# Render with the specified width and height.
#
cmds.hwRender( width=100, height=200 )

# Returns the imageFileName for image frame 11.
#
cmds.hwRender( imageFileName=True, frame=11 )

# Returns the imageFileName for current frame.
#
cmds.hwRender( imageFileName=True )

# Returns a version of the image file name after its number pattern
# being represented in a unique way.
#
cmds.hwRender( query=True, fixFileNameNumberPattern=True )

# Render the specified render layer.
cmds.hwRender( layer='layer1' )