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

Synopsis

sampleImage([fastSample=boolean], [resolution=[int, name]])

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

sampleImage is undoable, NOT queryable, and NOT editable.

The sampleImage command is used to control parameters of sample images, such as swatches in the multilister. The fast option turns on or off some rendering cheats which speed up the render but may cause edges to look ragged. The resolution option specifies the width in pixels of the image which will be rendered for the specified node. Note that the width of the image is also the height of the image since sample images are square.

Return value

None

Flags

fastSample, resolution
Long name (short name) Argument types Properties
fastSample(f) boolean create
If fast but rough rendering for sampleImage is to be used
resolution(r) [int, name] create
The first argument to this flag specifies a resolution in pixels. The second argument specifies a dependency node. The effect of this flag is that further sample image renderings for the specified node will be made at the specified resolution.
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

# From now on, render sample images at high quality.
#
cmds.sampleImage( f=False )

# Render the sample image associated with lambert1 at a resolution of
# 128 pixels by 128 pixels.
#
cmds.sampleImage( r=(128, 'lambert1') )