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

Synopsis

psdExport([alphaChannelIdx=int], [bytesPerChannel=int], [emptyLayerSet=boolean], [format=string], [layerName=string], [layerSetName=string], [outFileName=string], [preMultiplyAlpha=boolean], [psdFileName=string])

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

psdExport is NOT undoable, queryable, and NOT editable.

Writes the Photoshop file layer set into different formats. The output file depth (bit per channel ) can be different from that of the input. If the input is 16 bpc and output is 8 bpc, there will be data loss.

Return value

None

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

Keywords

photoshop, psd, texture, convert, export

Flags

alphaChannelIdx, bytesPerChannel, emptyLayerSet, format, layerName, layerSetName, outFileName, preMultiplyAlpha, psdFileName
Long name (short name) Argument types Properties
alphaChannelIdx(aci) int createquery
Index of the alpha channel to output, if not supplied, writes out the default alpha channel. The index is zero based. This is useful to write out specific alpha channels available as "Additional Alpha Channels" of Photoshop.
bytesPerChannel(bpc) int createquery
Output file depth. Any of these keyword:
  • 0 for choosing depth based on input
  • 1 for 8 bits per channel
  • 2 for 16 bits per channel

Default is 0.

emptyLayerSet(els) boolean createquery
Option to check if the given layer set is empty or not. This should be used in query mode and input file name and layer set names should be specified.
format(format) string createquery
Output file format. Any of these keyword: "iff", "sgi", "pic", "tif", "als", "gif", "rla", "jpg"

Default is iff.

layerName(lyn) string createquery
Name of the layer to output.
layerSetName(lsn) string createquery
Name of the layer set to output, if not supplied, writes out the Composite image.

In query mode, this flag needs a value.
outFileName(ofn) string createquery
Name(with path) of the output file.
preMultiplyAlpha(pma) boolean createquery
Option to multiply RGB colors with alpha values. If (r,g,b,a) is the value of pixel, it will be changed to (r*a, g*a, b*a, a) when this flag is used.
psdFileName(ifn) string createquery
Name(with path) of the input Photoshop file.

In query mode, this flag needs a value.
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

# Write the layer set 1 of psd file as 16 bit tif file
cmds.psdExport( ifn='/tmp/test.psd', ofn='/tmp/test.set1.tif', lsn='Set 1', format='tif', bpc=2 )
# Query if the layer set "Set 2" is empty.
cmds.psdExport( ifn='/tmp/test.psd', lsn='Set 2', q=True, els=True )