renderSettings

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

Synopsis

renderSettings [-camera string] [-customTokenString string] [-firstImageName] [-fullPath] [-fullPathTemp] [-genericFrameImageName string] [-imageGenericName] [-lastImageName] [-layer string] [-leaveUnmatchedTokens]

renderSettings is NOT undoable, NOT queryable, and NOT editable.

Return value

Keywords

Flags

Long name (short name)	Argument types	Properties
-camera(-cam)	string
Specify a camera that you want to replace the current renderable camera
-customTokenString(-cts)	string
Specify a custom key-value string to use to replace custom tokens in the file name. Use with firstImageName or lastImageName. Basic tokens (Scene, Layer, RenderLayer, Camera, Version, Extension) will be automatically expanded. Any other tokens must be specified here to be expanded. The format of the string is a space separated list of tokens-value pairs. For example, if the file name string is "myFile_<myToken>_<myOtherToken>_v" then the argument to this flag string should take the form "myToken=myTokenValue myOtherToken=myOtherTokenValue".
-firstImageName(-fin)
Returns the first image name
-fullPath(-fp)
Returns the full path for the image using the current project. Use with firstImageName, lastImageName, or genericFrameImageName.
-fullPathTemp(-fpt)
Returns the full path for the preview render of the image using the current project. Use with firstImageName, lastImageName, or genericFrameImageName.
-genericFrameImageName(-gin)	string
Returns the generic frame image name with the custom specified frame index token
-imageGenericName(-ign)
Returns the image generic name
-lastImageName(-lin)
Returns the last image name
-layer(-lyr)	string
Specify a render layer name that you want to replace the current render layer
-leaveUnmatchedTokens(-lut)
Do not remove unmatched tokens from the name string. Use with firstImageName or lastImageName.

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 be used more than once in a command.

MEL examples

// Get the name of the first and last image for the current layer
string $fl[] = `renderSettings -firstImageName -lastImageName`;
print ("First image is "+$fl[0]+"\n");
// This is the empty string if the scene is not set for animation
if ($fl[1] == "") {
	print "Not rendering animation\n";
} else {
	print ("Last image is "+$fl[1]+"\n");
}