[ScriptedImporter(22100002, new string[]{"psb"}, new string[]{"psd"}, AllowCaching = true)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.2d.psdimporter@latest")]
[MovedFrom("UnityEditor.Experimental.AssetImporters")]
public class PSDImporter : ScriptedImporter, ISpriteEditorDataProvider

Constructors

PSDImporter()

Declaration

public PSDImporter()

Properties

anisoLevel

Anisotropic filtering level of the texture.

Declaration

public int anisoLevel { get; set; }

Property Value

Type	Description
Int32

borderMipmap

Keeps texture borders the same when generating mipmaps.

Declaration

public bool borderMipmap { get; set; }

Property Value

Type	Description
Boolean

fadeout

Fades out mip levels to a gray color.

Declaration

public bool fadeout { get; set; }

Property Value

Type	Description
Boolean

filterMode

Filtering mode of the texture.

Declaration

public FilterMode filterMode { get; set; }

Property Value

Type	Description
FilterMode

isReadable

Set this to true if you want texture data to be readable from scripts. Set it to false to prevent scripts from reading texture data.

In order for Texture2D.GetPixel, Texture2D.GetPixels, ImageConversion.EncodeToEXR, ImageConversion.EncodeToJPG, ImageConversion.EncodeToPNG and similar functions to work, the Texture must be readable from scripts. The isReadable setting determines whether scripts can access texture data through these functions.

Textures are not set as readable by default.

When a Texture is not readable, it consumes much less memory because an uncompressed copy of the texture data in system memory is not required after the texture is uploaded to the graphics API. Readable Textures require an uncompressed system memory copy of the texture data so that once edited, the updated texture data can be uploaded to the graphics API.

Declaration

public bool isReadable { get; set; }

Property Value

Type	Description
Boolean

mipMapBias

Mip map bias of the texture.

Declaration

public float mipMapBias { get; set; }

Property Value

Type	Description
Single

mipmapEnabled

Generate Mip Maps.

Select this to enable mip-map generation. Mipmaps are smaller versions of the Texture that get used when the Texture is very small on screen.

Declaration

public bool mipmapEnabled { get; set; }

Property Value

Type	Description
Boolean

mipmapFadeDistanceEnd

Mip level where texture is faded out completely.

Declaration

public int mipmapFadeDistanceEnd { get; set; }

Property Value

Type	Description
Int32

mipmapFadeDistanceStart

Mip level where texture begins to fade out.

Declaration

public int mipmapFadeDistanceStart { get; set; }

Property Value

Type	Description
Int32

mipmapFilter

Mip level where texture is faded out completely.

Declaration

public TextureImporterMipFilter mipmapFilter { get; set; }

Property Value

Type	Description
TextureImporterMipFilter

mipMapsPreserveCoverage

Enables or disables coverage-preserving alpha mipmapping.

Enable this to rescale the alpha values of computed mipmaps so coverage is preserved. This means a higher percentage of pixels passes the alpha test and lower mipmap levels do not become more transparent. This is disabled by default (set to false).

Declaration

public bool mipMapsPreserveCoverage { get; set; }

Property Value

Type	Description
Boolean

secondarySpriteTextures

Secondary textures for the imported Sprites.

Declaration

public SecondarySpriteTexture[] secondarySpriteTextures { get; set; }

Property Value

Type	Description
SecondarySpriteTexture[]

spriteImportMode

Selects Single or Manual import mode for Sprite textures.

Declaration

public SpriteImportMode spriteImportMode { get; set; }

Property Value

Type	Description
SpriteImportMode	Valid values are SpriteImportMode.Multiple or SpriteImportMode.Single.

Exceptions

Type	Condition
ArgumentException	Exception when non valid values are set.

spritePixelsPerUnit

The number of pixels in the sprite that correspond to one unit in world space.

Declaration

public float spritePixelsPerUnit { get; set; }

Property Value

Type	Description
Single

textureType

Which type of texture are we dealing with here.

Declaration

public TextureImporterType textureType { get; set; }

Property Value

Type	Description
TextureImporterType	Valid values are TextureImporterType.Default or TextureImporterType.Sprite.

Exceptions

Type	Condition
ArgumentException	Exception when non valid values are set.

useCharacterMode

Sets if importer should generate a prefab as sub-asset. To generate a Prefab useMosaicMode needs to be set to true and importer needs to be set to import Sprites in multiple mode.

Declaration

public bool useCharacterMode { get; set; }

Property Value

Type	Description
Boolean

useMosaicMode

Sets if importer should generate a mosaic texture from the source layers. To generate such texture, the importer needs to be set to import Sprites in multiple mode.

Declaration

public bool useMosaicMode { get; set; }

Property Value

Type	Description
Boolean

wrapMode

Texture coordinate wrapping mode.

Using wrapMode sets the same wrapping mode on all axes. Different per-axis wrap modes can be set using wrapModeU, wrapModeV, wrapModeW. Querying the value returns the U axis wrap mode (same as wrapModeU getter).

Declaration

public TextureWrapMode wrapMode { get; set; }

Property Value

Type	Description
TextureWrapMode

wrapModeU

Texture U coordinate wrapping mode.

Controls wrapping mode along texture U (horizontal) axis.

Declaration

public TextureWrapMode wrapModeU { get; set; }

Property Value

Type	Description
TextureWrapMode

wrapModeV

Texture V coordinate wrapping mode.

Controls wrapping mode along texture V (vertical) axis.

Declaration

public TextureWrapMode wrapModeV { get; set; }

Property Value

Type	Description
TextureWrapMode

wrapModeW

Texture W coordinate wrapping mode for Texture3D.

Controls wrapping mode along texture W (depth, only relevant for Texture3D) axis.

Declaration

public TextureWrapMode wrapModeW { get; set; }

Property Value

Type	Description
TextureWrapMode

Methods

GetImporterPlatformSettings(BuildTarget)

Retrieves the platform settings used by the importer for a given build target.

Declaration

public TextureImporterPlatformSettings GetImporterPlatformSettings(BuildTarget buildTarget)

Parameters

Type	Name	Description
BuildTarget	buildTarget	The build target to query.

Returns

Type	Description
TextureImporterPlatformSettings	TextureImporterPlatformSettings used for importing the texture for the build target.

OnImportAsset(AssetImportContext)

Implementation of ScriptedImporter.OnImportAsset

Declaration

public override void OnImportAsset(AssetImportContext ctx)

Parameters

Type	Name	Description
AssetImportContext	ctx	This argument contains all the contextual information needed to process the import event and is also used by the custom importer to store the resulting Unity Asset.

Overrides

ScriptedImporter.OnImportAsset(AssetImportContext)

SetImporterPlatformSettings(TextureImporterPlatformSettings)

Sets the platform settings used by the importer for a given build target.

Declaration

public void SetImporterPlatformSettings(TextureImporterPlatformSettings setting)

Parameters

Type	Name	Description
TextureImporterPlatformSettings	setting	TextureImporterPlatformSettings to be used by the importer for the build target indicated by TextureImporterPlatformSettings.

Explicit Interface Implementations

ISpriteEditorDataProvider.Apply()

Implementation for ISpriteEditorDataProvider.Apply.

Declaration

void ISpriteEditorDataProvider.Apply()

Implements

ISpriteEditorDataProvider.Apply()

ISpriteEditorDataProvider.GetDataProvider<T>()

Implementation for ISpriteEditorDataProvider.GetDataProvider.

Declaration

T ISpriteEditorDataProvider.GetDataProvider<T>()
    where T : class

Returns

Type	Description
T

Type Parameters

Name	Description
T	Data provider type to retrieve.

Implements

ISpriteEditorDataProvider.GetDataProvider<T>()

ISpriteEditorDataProvider.GetSpriteRects()

Implementation for ISpriteEditorDataProvider.GetSpriteRects.

Declaration

SpriteRect[] ISpriteEditorDataProvider.GetSpriteRects()

Returns

Type	Description
SpriteRect[]	An array of SpriteRect for the current import mode.

Implements

ISpriteEditorDataProvider.GetSpriteRects()

ISpriteEditorDataProvider.HasDataProvider(Type)

Implementation for ISpriteEditorDataProvider.HasDataProvider.

Declaration

bool ISpriteEditorDataProvider.HasDataProvider(Type type)

Parameters

Type	Name	Description
Type	type	Data provider type to query.

Returns

Type	Description
Boolean	True if data provider is supported, false otherwise.

Implements

ISpriteEditorDataProvider.HasDataProvider(Type)

ISpriteEditorDataProvider.InitSpriteEditorDataProvider()

Implementation for ISpriteEditorDataProvider.InitSpriteEditorDataProvider.

Declaration

void ISpriteEditorDataProvider.InitSpriteEditorDataProvider()

Implements

ISpriteEditorDataProvider.InitSpriteEditorDataProvider()

ISpriteEditorDataProvider.pixelsPerUnit

Implementation for ISpriteEditorDataProvider.pixelsPerUnit.

Declaration

float ISpriteEditorDataProvider.pixelsPerUnit { get; }

Returns

Type	Description
Single

Implements

ISpriteEditorDataProvider.pixelsPerUnit

ISpriteEditorDataProvider.SetSpriteRects(SpriteRect[])

Implementation for ISpriteEditorDataProvider.SetSpriteRects.

Declaration

void ISpriteEditorDataProvider.SetSpriteRects(SpriteRect[] spriteRects)

Parameters

Type	Name	Description
SpriteRect[]	spriteRects	Set the SpriteRect data for the current import mode.

Implements

ISpriteEditorDataProvider.SetSpriteRects(SpriteRect[])