Documentation

​
​

Development

User Acquisition

Monetization

Industry

Asset Transformer SDK

2026.1

Supported
​

User Manual

Python API

C# API

Changelog

Discussions

Asset Transformer SDK

2026.1

Supported
​

Asset Transformer SDK
​
​
pxz
  • Functions
Algo
  • Functions
  • Types
CAD
  • Functions
  • Types
Core
  • Functions
  • Events
  • Types
Geom
  • Functions
  • Types
IO
  • Functions
  • Types
Material
  • Functions
  • Events
  • Types
    • BlurFilter
    • CoeffOrTexture
    • ColorMaterialInfos
    • ColorOrTexture
    • CustomMaterialPattern
    • EdgeFilter
    • Image
    • ImageChangeType
    • ImageComponentType
    • ImageDefinition
    • ImageDefinitionList
    • ImageLayout
    • ImageList
    • ImpostorMaterialInfos
    • Material
    • MaterialChangeType
    • MaterialDefinition
    • MaterialDefinitionList
    • MaterialFromMapsReturn
    • MaterialList
    • MaterialListList
    • MaterialPatternType
    • MaterialUserData
    • PBRMaterialInfos
    • PixelInfo
    • ResizeFilterMethod
    • RoI
    • ShaderUniformType
    • StandardMaterialInfos
    • Texture
    • UnlitTextureMaterialInfos
Polygonal
  • Functions
  • Types
Scene
  • Functions
  • Events
  • Types
Unity
  • Functions
  • Events
  • Types
View
  • Functions
  • Events
  • Types
  1. Asset Transformer SDK (ex Pixyz)

Material

Python API types
Read time 7 minutes
Last updated 9 months ago

BlurFilter

Enum of core.Int

Name

Value

Box0
Gaussian1
Functions accepting this type or a list of this type as a parameter:
  • material.blurImage

CoeffOrTexture

Select between:
  • coeff: core.Coeff
  • texture: material.Texture Functions accepting this type or a list of this type as a parameter:
  • material.setCoeffOrTextureProperty

ColorMaterialInfos

Fields

Type

Name

Default

Description

nameCore.String
colorColorAlpha

ColorOrTexture

Select between:
  • color: core.Color
  • texture: material.Texture Functions accepting this type or a list of this type as a parameter:
  • material.setColorOrTextureProperty

CustomMaterialPattern

A Custom MaterialPattern is an entity which defines an abstract custom Shader. It is used by the Materials. Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:
  • material.addUniformProperty
  • material.getUniformPropertyType
  • material.setFragmentShader
  • material.setVertexShader
  • core.cloneEntity
  • core.deleteEntities
  • core.entityExists
  • core.getEntityType
  • core.getEntityTypeString
  • core.addCustomProperties
  • core.addCustomProperty
  • core.getProperties
  • core.getProperty
  • core.getPropertyInfo
  • core.hasCustomProperty
  • core.hasProperty
  • core.listProperties
  • core.listPropertiesBatch
  • core.removeCustomProperty
  • core.setProperties
  • core.setProperty
  • core.supportCustomProperties
  • core.unsetProperty
  • scene.linkPropertyToAnimation
  • scene.unlinkPropertyToAnimation

EdgeFilter

Enum of core.Int

Name

Value

Clamp0
Extend1
Repeat2
Mirror3
Functions accepting this type or a list of this type as a parameter:
  • material.blurImage
  • material.getImageColorBilinear
  • material.rotateImage
  • material.setSubImage
  • material.stretchImage
  • material.transformImage
  • material.translateImage

Image

An Image is an entity which represents an image in the Image library. Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:
  • algo.convertNormalMap
  • algo.fillNormalMap
  • algo.orientNormalMap
  • material.convertHeightMapToNormalMap
  • material.filterAO
  • material.remapIndexMap
  • material.applyFactorOnImage
  • material.blurImage
  • material.clearImageRoI
  • material.convertFloat32To8BitsImage
  • material.convertImage
  • material.convertImageToDefinition
  • material.exportImage
  • material.extractImageChannels
  • material.extractImageComponents
  • material.fillImageWithColor
  • material.fillUnusedPixels
  • material.flipImageY
  • material.getImageColorBilinear
  • material.getImageColorRange
  • material.getImageComponentType
  • material.getImageDefinition
  • material.getImageDefinitions
  • material.getImageLayout
  • material.getImagePixelColor
  • material.getImagePixelInfo
  • material.getImageRoI
  • material.getImageSize
  • material.getImagesSizes
  • material.getSubImage
  • material.invertImageColor
  • material.overrideImageFormat
  • material.resizeImage
  • material.rotateImage
  • material.setImageRoI
  • material.setSubImage
  • material.stretchImage
  • material.transformImage
  • material.translateImage
  • material.updateImageFromDefinition
  • material.updateImagesFromDefinitions
  • scene.mergeImages
  • core.cloneEntity
  • core.deleteEntities
  • core.entityExists
  • core.getEntityType
  • core.getEntityTypeString
  • core.addCustomProperties
  • core.addCustomProperty
  • core.getProperties
  • core.getProperty
  • core.getPropertyInfo
  • core.hasCustomProperty
  • core.hasProperty
  • core.listProperties
  • core.listPropertiesBatch
  • core.removeCustomProperty
  • core.setProperties
  • core.setProperty
  • core.supportCustomProperties
  • core.unsetProperty
  • scene.linkPropertyToAnimation
  • scene.unlinkPropertyToAnimation

ImageChangeType

Enum of core.Long

Name

Value

ADDED0
REMOVED1
CHANGED2
RESET3
REPLACED4

ImageComponentType

Enum of core.Int

Name

Value

Undefined0
UInt8_Norm1
UInt8_Int2
SInt8_Norm3
SInt8_Int4
UInt16_Norm5
UInt16_Int6
SInt16_Norm7
SInt16_Int8
Float169
UInt32_Norm10
UInt32_Int11
SInt32_Norm12
SInt32_Int13
Float3214
UInt64_Norm15
UInt64_Int16
SInt64_Norm17
SInt64_Int18
Float6419
Functions accepting this type or a list of this type as a parameter:
  • material.convertImage
  • material.convertImageToDefinition
  • material.createCheckerboardImage
  • material.getImageComponentTypeName
  • material.getImageFormatName
  • material.getImagePixelInfoFromLayoutAndType
  • material.overrideImageFormat

ImageDefinition

Fields

Type

Name

Default

Description

idImage0
nameCore.String
widthCore.Int0
heightCore.Int0
layoutImageLayoutRGBA
typeImageComponentTypeUInt8_Norm
dataByteList
Functions accepting this type or a list of this type as a parameter:
  • material.createImageFromDefinition
  • material.createImagesFromDefinitions
  • material.getImagePixelInfoFromDefinition
  • material.updateImageFromDefinition
  • material.updateImagesFromDefinitions

ImageDefinitionList

List of material.ImageDefinition
Functions accepting this type or a list of this type as a parameter:
  • material.createImagesFromDefinitions
  • material.updateImagesFromDefinitions

ImageLayout

Enum of core.Int

Name

Value

Undefined0
R1
G2
B3
A4
RG5
RGB6
RGBA7
BGR8
BGRA9
ABGR10
Lum11
LumA12
Functions accepting this type or a list of this type as a parameter:
  • material.convertImage
  • material.convertImageToDefinition
  • material.createCheckerboardImage
  • material.extractImageComponents
  • material.getImageFormatName
  • material.getImagePixelInfoFromLayoutAndType
  • material.overrideImageFormat

ImageList

List of material.Image
Functions accepting this type or a list of this type as a parameter:
  • material.filterAO
  • material.remapIndexMap
  • material.getImageDefinitions
  • material.getImagesSizes
  • material.updateImagesFromDefinitions
  • scene.mergeImages

ImpostorMaterialInfos

Fields

Type

Name

Default

Description

nameCore.String
albedoColorOrTexture
normalColorOrTexture
roughnessCoeffOrTexture
aoCoeffOrTexture
depthCoeffOrTexture
nbFramesCore.Int0
fullOctaCore.Boolean1
octaDiameterCore.Double1.0
linearStepsCore.Int30
binaryStepsCore.Int1

Material

The Material is an Entity that contains visual definition that can be applied to the Components of the scene. Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:
  • algo.filletMesh
  • algo.removeHoles
  • algo.remeshSurfacicHoles
  • cad.setFaceMaterial
  • cad.setEdgeMaterial
  • material.areOpaques
  • material.copyMaterial
  • material.getColorMaterialInfos
  • material.getCustomMaterialPattern
  • material.getImpostorMaterialInfos
  • material.getMaterialDefinition
  • material.getMaterialDefinitions
  • material.getMaterialMainColor
  • material.getMaterialPattern
  • material.getMaterialPatternType
  • material.getPBRMaterialInfos
  • material.getStandardMaterialInfos
  • material.getUnlitTextureMaterialInfos
  • material.isOpaque
  • material.makeMaterialNamesUnique
  • material.setCoeffOrTextureProperty
  • material.setColorAlphaProperty
  • material.setColorOrTextureProperty
  • material.setMaterialMainColor
  • material.setMaterialPattern
  • material.setPBRMaterialInfos
  • material.getAllImages
  • material.getMaterialUserData
  • material.getMultipleMaterialUserData
  • material.hasMaterialUserData
  • material.hasMultipleMaterialUserData
  • material.setMaterialUserData
  • material.setMultipleMaterialUserData
  • material.unsetMaterialUserData
  • material.unsetMultipleMaterialUserData
  • scene.convertMaterialsToColor
  • scene.convertMaterialsToPBR
  • scene.mergeMaterials
  • scene.replaceMaterial
  • scene.setOccurrenceMaterial
  • scene.findOccurrencesByMaterial
  • scene.findPartOccurrencesByActiveMaterial
  • scene.findPartOccurrencesByVisibleMaterial
  • scene.setSubpartMaterial
  • scene.setSubpartMaterials
  • scene.addMeshToAnnotation
  • core.cloneEntity
  • core.deleteEntities
  • core.entityExists
  • core.getEntityType
  • core.getEntityTypeString
  • core.addCustomProperties
  • core.addCustomProperty
  • core.getProperties
  • core.getProperty
  • core.getPropertyInfo
  • core.hasCustomProperty
  • core.hasProperty
  • core.listProperties
  • core.listPropertiesBatch
  • core.removeCustomProperty
  • core.setProperties
  • core.setProperty
  • core.supportCustomProperties
  • core.unsetProperty
  • scene.linkPropertyToAnimation
  • scene.unlinkPropertyToAnimation

MaterialChangeType

Enum of core.Long

Name

Value

CHANGED0
PATTERN_CHANGED1
RELOAD2
DESTROYED3
ICON_CHANGED4
ADDED5
REMOVED6

MaterialDefinition

Fields

Type

Name

Default

Description

nameCore.String
idMaterial0
albedoColorOrTexture
normalColorOrTexture
metallicCoeffOrTexture
roughnessCoeffOrTexture
aoCoeffOrTexture
opacityCoeffOrTexture
emissiveColorOrTexture
Functions accepting this type or a list of this type as a parameter:
  • material.createMaterialFromDefinition
  • material.createMaterialsFromDefinitions

MaterialDefinitionList

List of material.MaterialDefinition
Functions accepting this type or a list of this type as a parameter:
  • material.createMaterialsFromDefinitions

MaterialFromMapsReturn

Fields

Type

Name

Default

Description

importedTextureCountCore.Int0Number of newly imported textures.
createdMaterialCountCore.Int0Number of newly created materials.
updatedMaterialCountCore.Int0

MaterialList

List of material.Material
Functions accepting this type or a list of this type as a parameter:
  • material.areOpaques
  • material.getMaterialDefinitions
  • material.makeMaterialNamesUnique
  • material.getAllImages
  • material.getMultipleMaterialUserData
  • material.hasMultipleMaterialUserData
  • material.setMultipleMaterialUserData
  • material.unsetMultipleMaterialUserData
  • scene.convertMaterialsToColor
  • scene.convertMaterialsToPBR
  • scene.mergeMaterials
  • scene.setSubpartMaterials
  • scene.setSubpartVariantMaterialsList

MaterialListList

List of material.MaterialList
Functions accepting this type or a list of this type as a parameter:
  • scene.setSubpartVariantMaterialsList

MaterialPatternType

Enum of core.Int

Name

Value

CUSTOM0
COLOR1
STANDARD2
UNLIT_TEXTURE3
PBR4
IMPOSTOR5
LINE6

MaterialUserData

Identifier of materials userdata. Base class: core.Ident
Functions accepting this type or a list of this type as a parameter:
  • material.getMaterialUserData
  • material.getMultipleMaterialUserData
  • material.hasMaterialUserData
  • material.hasMultipleMaterialUserData
  • material.setMaterialUserData
  • material.setMultipleMaterialUserData
  • material.unsetMaterialUserData
  • material.unsetMultipleMaterialUserData
  • material.unsubscribeFromMaterialUserData

PBRMaterialInfos

Fields

Type

Name

Default

Description

nameCore.String
albedoColorOrTexture
normalColorOrTexture
metallicCoeffOrTexture
roughnessCoeffOrTexture
aoCoeffOrTexture
opacityCoeffOrTexture
Functions accepting this type or a list of this type as a parameter:
  • material.setPBRMaterialInfos

PixelInfo

Fields

Type

Name

Default

Description

layoutImageLayoutUndefined
typeImageComponentTypeUndefined
componentCountCore.Int0
bitsPerComponentCore.Int0
bytesPerComponentCore.Int0
bytesPerPixelCore.Int0
isFloatBooleanFalse
isSignedBooleanFalse
isNormalizedBooleanFalse

ResizeFilterMethod

Enum of core.Int

Name

Value

DEFAULT0
BOX1
TRIANGLE2
CUBICBSPLINE3
CATMULLROM4
MITCHELL5
Functions accepting this type or a list of this type as a parameter:
  • material.resizeImage

RoI

Fields

Type

Name

Default

Description

xCore.Int0
yCore.Int0
wCore.Int0
hCore.Int0

ShaderUniformType

The possible types of shader uniform parameters. Enum of core.Long

Name

Value

INTEGER2
BOOLEAN9
REAL11
COEFF13
POINT323
POINT222
COLOR15
COLOR_ALPHA16
TEXTURE34
COLORORTEXTURE35
COEFFORTEXTURE36
Functions accepting this type or a list of this type as a parameter:
  • material.addUniformProperty

StandardMaterialInfos

Fields

Type

Name

Default

Description

nameCore.String
diffuseColorOrTexture
specularColorOrTexture
ambientColorOrTexture
emissiveColorOrTexture
shininessCoeff0.0
transparencyCoeff0.0

Texture

Fields

Type

Name

Default

Description

imageImage0
channelCore.Int0
offsetPoint2
tillingPoint2

UnlitTextureMaterialInfos

Fields

Type

Name

Default

Description

nameCore.String
textureTexture

Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page
    • BlurFilter

    • CoeffOrTexture

    • ColorMaterialInfos

    • ColorOrTexture

    • CustomMaterialPattern

    • EdgeFilter

    • Image

    • ImageChangeType

    • ImageComponentType

    • ImageDefinition

    • ImageDefinitionList

    • ImageLayout

    • ImageList

    • ImpostorMaterialInfos

    • Material

    • MaterialChangeType

    • MaterialDefinition

    • MaterialDefinitionList

    • MaterialFromMapsReturn

    • MaterialList

    • MaterialListList

    • MaterialPatternType

    • MaterialUserData

    • PBRMaterialInfos

    • PixelInfo

    • ResizeFilterMethod

    • RoI

    • ShaderUniformType

    • StandardMaterialInfos

    • Texture

    • UnlitTextureMaterialInfos


Report a problem with this page