pymel.core.rendering.psdExport

psdExport(*args, **kwargs)

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. In query mode, return type is based on queried flag.

Dynamic library stub function

Flags:
Long name (short name) Argument Types Properties
alphaChannelIdx (aci) int ../../../_images/create.gif ../../../_images/query.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif
 
Output file depth. Any of these keyword: 0 for choosing depth based on input1 for 8 bits per channel2 for 16 bits per channelDefault is 0.
emptyLayerSet (els) bool ../../../_images/create.gif ../../../_images/query.gif
 

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.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

format (format) unicode ../../../_images/create.gif ../../../_images/query.gif
 
Output file format. Any of these keyword: “iff”, “sgi”, “pic”, “tif”, “als”, “gif”, “rla”, “jpg” Default is iff.
layerName (lyn) unicode ../../../_images/create.gif ../../../_images/query.gif
 
Name of the layer to output.
layerSetName (lsn) unicode ../../../_images/create.gif ../../../_images/query.gif
 
Name of the layer set to output, if not supplied, writes out the Composite image.
outFileName (ofn) unicode ../../../_images/create.gif ../../../_images/query.gif
 
Name(with path) of the output file.
preMultiplyAlpha (pma) bool ../../../_images/create.gif ../../../_images/query.gif
 
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) unicode ../../../_images/create.gif ../../../_images/query.gif
 
Name(with path) of the input Photoshop file.

Derived from mel command maya.cmds.psdExport

Example:

import pymel.core as pm

import maya.cmds as cmds

# Write the layer set 1 of psd file as 16 bit tif file
pm.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.
pm.psdExport( ifn='/tmp/test.psd', lsn='Set 2', q=True, els=True )

Previous topic

pymel.core.rendering.psdEditTextureFile

Next topic

pymel.core.rendering.psdTextureFile

Core

Core Modules

Other Modules

This Page