# Material > Python API functions ### addUniformProperty Add a shader uniform parameter to the given custom pattern. ```python material.addUniformProperty(pattern, name, type) ``` Parameters | Type | Name | Description | | --------------------------------------------------------------- | ------- | --------------------------- | | [CustomMaterialPattern](./material_types#custommaterialpattern) | pattern | The custom pattern to edit. | | [String](./core_types#string) | name | Name of the new property. | | [ShaderUniformType](./material_types#shaderuniformtype) | type | Type of the new uniform. | ### areOpaques Check if some materials are opaques. Function will return 'False' for each material if: * The 'Opacity' Coeff is not 1.0 * The 'Opacity' property is a Texture * The 'Albedo' property is a Texture and at least one pixel of the texture has an alpha value. ```python material.areOpaques(materials) -> core.BoolList ``` Parameters | Type | Name | Description | | --------------------------------------------- | --------- | --------------------------- | | [MaterialList](./material_types#materiallist) | materials | Materials to check opacity. | Returns | Type | Name | Description | | --------------------------------- | ------- | ------------------------------------------------------------------------ | | [BoolList](./core_types#boollist) | opaques | For each given material, returns True if opaque or False if transparent. | ### clearAllMaterials Remove and delete all the materials. ```python material.clearAllMaterials() ``` ### configureFunctionLogger ```python material.configureFunctionLogger(functionName, enableFunction, enableParameters, enableExecutionTime) ``` Parameters | Type | Name | Description | | ------------------------------- | ------------------- | ----------- | | [String](./core_types#string) | functionName | | | [Boolean](./core_types#boolean) | enableFunction | | | [Boolean](./core_types#boolean) | enableParameters | | | [Boolean](./core_types#boolean) | enableExecutionTime | | ### convertHeightMapToNormalMap Convert a height map to a normal map. ```python material.convertHeightMapToNormalMap(hmap, height=0.5) -> material.Image ``` Parameters | Type | Name | Description | | ------------------------------- | ------ | --------------------- | | [Image](./material_types#image) | hmap | Height map reference. | | [Double](./core_types#double) | height | Maximum height. | Returns | Type | Name | Description | | ------------------------------- | ---- | ----------- | | [Image](./material_types#image) | nmap | Normal map. | ### copyMaterial Copies a material. ```python material.copyMaterial(toCopy, addToMaterialLibrary) -> material.Material ``` Parameters | Type | Name | Description | | ------------------------------------- | -------------------- | ------------------------ | | [Material](./material_types#material) | toCopy | Material to copy. | | [Boolean](./core_types#boolean) | addToMaterialLibrary | Add to material library. | Returns | Type | Name | Description | | ------------------------------------- | -------- | -------------------- | | [Material](./material_types#material) | material | The copied material. | ### createCustomMaterialPattern Create a new custom material pattern. ```python material.createCustomMaterialPattern(name) -> material.CustomMaterialPattern ``` Parameters | Type | Name | Description | | ----------------------------- | ---- | -------------------- | | [String](./core_types#string) | name | Name of the pattern. | Returns | Type | Name | Description | | --------------------------------------------------------------- | ------- | ----------------------------- | | [CustomMaterialPattern](./material_types#custommaterialpattern) | pattern | The created material pattern. | ### createMaterial Create a new material from pattern. ```python material.createMaterial(name, pattern, addToMaterialLibrary=True) -> material.Material ``` Parameters | Type | Name | Description | | ------------------------------- | -------------------- | --------------------- | | [String](./core_types#string) | name | Name of the material. | | [String](./core_types#string) | pattern | Name of the pattern. | | [Boolean](./core_types#boolean) | addToMaterialLibrary | Name of the pattern. | Returns | Type | Name | Description | | ------------------------------------- | -------- | --------------------- | | [Material](./material_types#material) | material | The created material. | ### createMaterialFromDefinition Create PBR material from a material definition. ```python material.createMaterialFromDefinition(materialDefinition) -> material.Material ``` Parameters | Type | Name | Description | | --------------------------------------------------------- | ------------------ | ---------------------------------------------------------- | | [MaterialDefinition](./material_types#materialdefinition) | materialDefinition | The structure containing all the PBR material information. | Returns | Type | Name | Description | | ------------------------------------- | -------- | --------------------- | | [Material](./material_types#material) | material | The created material. | ### createMaterialsFromDefinitions Create PBR materials from material definitions. ```python material.createMaterialsFromDefinitions(materialDefinitions) -> material.MaterialList ``` Parameters | Type | Name | Description | | ----------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------- | | [MaterialDefinitionList](./material_types#materialdefinitionlist) | materialDefinitions | Material definitions containing properties for each given material. | Returns | Type | Name | Description | | --------------------------------------------- | --------- | ---------------------- | | [MaterialList](./material_types#materiallist) | materials | The created materials. | ### createMaterialsFromMaps Automatically creates PBR materials when importing PBR texture maps from a folder. ```python material.createMaterialsFromMaps(directory) -> material.MaterialFromMapsReturn ``` Parameters | Type | Name | Description | | ------------------------------------------- | --------- | --------------- | | [DirectoryPath](./core_types#directorypath) | directory | Directory path. | Returns | Type | Name | Description | | ----------------------------------------------------------------- | ------ | ------------------------------------------------ | | [MaterialFromMapsReturn](./material_types#materialfrommapsreturn) | result | Results of the createMaterialsFromMaps function. | ### filterAO Filter an AO map using ATrous method. ```python material.filterAO(aoMaps, normalMaps, sigmaPos=2.0, sigmaValue=0.2, sigmaNormal=0.2, levelCount=4, filterLowValues=True, lowValueThreshold=0.01) -> material.ImageList ``` Parameters | Type | Name | Description | | --------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------ | | [ImageList](./material_types#imagelist) | aoMaps | Input AO Maps (the alpha component must be set to 0 for unused pixels). | | [ImageList](./material_types#imagelist) | normalMaps | Input Normal Maps (preferable to use World space normal maps, but Object space normal maps can be used too). | | [Double](./core_types#double) | sigmaPos | ATrous Sigma pos. | | [Double](./core_types#double) | sigmaValue | ATrous Sigma value. | | [Double](./core_types#double) | sigmaNormal | ATrous Sigma normal. | | [Int](./core_types#int) | levelCount | Atrous #Levels. | | [Boolean](./core_types#boolean) | filterLowValues | Remove low values from the filtering (see: lowValuesThreshold parameter). | | [Double](./core_types#double) | lowValueThreshold | Threshold used if filterLowValues is enabled. | Returns | Type | Name | Description | | --------------------------------------- | -------------- | --------------------- | | [ImageList](./material_types#imagelist) | filteredAOMaps | The filtered AO Maps. | ### findCustomMaterialPatternByName Returns the material pattern which has the given name. ```python material.findCustomMaterialPatternByName(name) -> material.CustomMaterialPattern ``` Parameters | Type | Name | Description | | ----------------------------- | ---- | --------------------------------- | | [String](./core_types#string) | name | The name of the material pattern. | Returns | Type | Name | Description | | --------------------------------------------------------------- | ------- | --------------------- | | [CustomMaterialPattern](./material_types#custommaterialpattern) | pattern | The material pattern. | ### findMaterialsByPattern Returns all materials using the given pattern. ```python material.findMaterialsByPattern(pattern) -> material.MaterialList ``` Parameters | Type | Name | Description | | ----------------------------- | ------- | ------------------- | | [String](./core_types#string) | pattern | A material pattern. | Returns | Type | Name | Description | | --------------------------------------------- | --------- | ---------------------------- | | [MaterialList](./material_types#materiallist) | materials | Materials using the pattern. | ### findMaterialsByProperty Returns all materials which match a given property value. ```python material.findMaterialsByProperty(propertyName, propertyValue, caseInsensitive=False) -> material.MaterialList ``` Parameters | Type | Name | Description | | ----------------------------- | --------------- | ---------------------------------------------------------------- | | [String](./core_types#string) | propertyName | Name of the property to match. | | [Regex](./core_types#regex) | propertyValue | Regular expression to match for the property value. | | [Bool](./core_types#bool) | caseInsensitive | If True, the regex will be insensitive to upper and lower cases. | Returns | Type | Name | Description | | --------------------------------------------- | --------- | -------------------------------------- | | [MaterialList](./material_types#materiallist) | materials | Materials matching the property value. | ### generateColorFromIndex Generate a unique color from an index (only 16M differents color can be generated, if index is greater than 16777216, the color is not guaranted to be unique). ```python material.generateColorFromIndex(index) -> core.Color ``` Parameters | Type | Name | Description | | ----------------------- | ----- | ----------- | | [Int](./core_types#int) | index | Index. | Returns | Type | Name | Description | | --------------------------- | ----- | ----------- | | [Color](./core_types#color) | color | Color. | ### generateUniqueColors Generate a set of unique colors (max 16M differents color can be generated, if count is greater than 16777216, the colors are not guaranted to be unique). ```python material.generateUniqueColors(count) -> core.ColorList ``` Parameters | Type | Name | Description | | ----------------------- | ----- | ------------------------------------ | | [Int](./core_types#int) | count | Number of unique colors to generate. | Returns | Type | Name | Description | | ----------------------------------- | ------ | -------------------- | | [ColorList](./core_types#colorlist) | colors | Count unique colors. | ### getAllMaterialPatterns Returns all the material patterns in the current session. ```python material.getAllMaterialPatterns() -> core.StringList ``` Returns | Type | Name | Description | | ------------------------------------- | ------- | ---------------------------------------- | | [StringList](./core_types#stringlist) | shaders | A list containing all material patterns. | ### getAllMaterials Retrieve the list of all the materials in the material library. ```python material.getAllMaterials() -> material.MaterialList ``` Returns | Type | Name | Description | | --------------------------------------------- | --------- | ------------------------------------------ | | [MaterialList](./material_types#materiallist) | materials | List of materials in the material library. | ### getColorMaterialInfos Get color material properties. ```python material.getColorMaterialInfos(material) -> material.ColorMaterialInfos ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | ------------------------------- | | [Material](./material_types#material) | material | The material to get properties. | Returns | Type | Name | Description | | --------------------------------------------------------- | ----- | ---------------------------------- | | [ColorMaterialInfos](./material_types#colormaterialinfos) | infos | The ColorMaterialInfos properties. | ### getCustomMaterialPattern Returns the custom material pattern associated to the custom material. ```python material.getCustomMaterialPattern(material) -> material.CustomMaterialPattern ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | ---------------------------------------- | | [Material](./material_types#material) | material | Custom material to get the pattern from. | Returns | Type | Name | Description | | --------------------------------------------------------------- | ------- | ---------------------------- | | [CustomMaterialPattern](./material_types#custommaterialpattern) | pattern | The custom material pattern. | ### getImageAverageColor Get the average color of an image. ```python material.getImageAverageColor(image) -> core.ColorAlpha, core.ColorAlpha ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ----------- | | [Image](./material_types#image) | image | The image. | Returns | Type | Name | Description | | ------------------------------------- | ----------------- | -------------------------------------------- | | [ColorAlpha](./core_types#coloralpha) | color | The main color. | | [ColorAlpha](./core_types#coloralpha) | standardDeviation | The standard deviation of the average color. | ### getImpostorMaterialInfos Get impostor texture material properties. ```python material.getImpostorMaterialInfos(material) -> material.ImpostorMaterialInfos ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | ------------------------------- | | [Material](./material_types#material) | material | The material to get properties. | Returns | Type | Name | Description | | --------------------------------------------------------------- | ----- | ---------------------------------------- | | [ImpostorMaterialInfos](./material_types#impostormaterialinfos) | infos | The getImpostorMaterialInfos properties. | ### getMaterialDefinition Returns the properties of a PBR Material. ```python material.getMaterialDefinition(material) -> material.MaterialDefinition ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | ----------------- | | [Material](./material_types#material) | material | The PBR Material. | Returns | Type | Name | Description | | --------------------------------------------------------- | ------------------ | ---------------------------- | | [MaterialDefinition](./material_types#materialdefinition) | materialDefinition | The PBR material definition. | ### getMaterialDefinitions Returns the properties of a set of PBR Materials. ```python material.getMaterialDefinitions(materials) -> material.MaterialDefinitionList ``` Parameters | Type | Name | Description | | --------------------------------------------- | --------- | ------------------ | | [MaterialList](./material_types#materiallist) | materials | The PBR Materials. | Returns | Type | Name | Description | | ----------------------------------------------------------------- | ------------------- | ----------------------------- | | [MaterialDefinitionList](./material_types#materialdefinitionlist) | materialDefinitions | The PBR Material definitions. | ### getMaterialMainColor Get the main color on any material pattern type. ```python material.getMaterialMainColor(material) -> core.ColorAlpha ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | ------------- | | [Material](./material_types#material) | material | The material. | Returns | Type | Name | Description | | ------------------------------------- | ----- | --------------- | | [ColorAlpha](./core_types#coloralpha) | color | The main color. | ### getMaterialPattern Gets the MaterialPattern name of the material. ```python material.getMaterialPattern(material) -> core.String ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | --------------------------------- | | [Material](./material_types#material) | material | The material to find the pattern. | Returns | Type | Name | Description | | ----------------------------- | ------- | ---------------------------- | | [String](./core_types#string) | pattern | The pattern of the material. | ### getMaterialPatternType Returns the MaterialPatternType name of the material. ```python material.getMaterialPatternType(material) -> material.MaterialPatternType ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | --------------------------------- | | [Material](./material_types#material) | material | The material to find the pattern. | Returns | Type | Name | Description | | ----------------------------------------------------------- | ----------- | --------------------------------- | | [MaterialPatternType](./material_types#materialpatterntype) | patternType | The pattern type of the material. | ### getPBRMaterialInfos Get PBR material properties. ```python material.getPBRMaterialInfos(material) -> material.PBRMaterialInfos ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | ------------------------------- | | [Material](./material_types#material) | material | The material to get properties. | Returns | Type | Name | Description | | ----------------------------------------------------- | ----- | -------------------------------- | | [PBRMaterialInfos](./material_types#pbrmaterialinfos) | infos | The PBRMaterialInfos properties. | ### getPointsAndMaterialFromText Returns a list of 3D Points and a material from a string and a fontname. ```python material.getPointsAndMaterialFromText(text, fontName, fontSize, matrix, colorInput, offset=0.0, height3D=0.0) -> geom.Point3List, geom.Point2List, geom.Vector3, material.Material, core.Double ``` Parameters | Type | Name | Description | | ------------------------------- | ---------- | ----------------------------------------------------------- | | [String](./core_types#string) | text | Input text. | | [String](./core_types#string) | fontName | Fontname. | | [Int](./core_types#int) | fontSize | FontSize. | | [Matrix4](./geom_types#matrix4) | matrix | Input matrix for the text. | | [Color](./core_types#color) | colorInput | Color of the font needed. | | [Double](./core_types#double) | offset | Input offset for the text. | | [Double](./core_types#double) | height3D | Input height in 3D which will be a ratio from the textSize. | Returns | Type | Name | Description | | ------------------------------------- | -------- | ------------------------- | | [Point3List](./geom_types#point3list) | points | | | [Point2List](./geom_types#point2list) | uvs | | | [Vector3](./geom_types#vector3) | normal | | | [Material](./material_types#material) | material | | | [Double](./core_types#double) | offset | Offset given by the text. | ### getStandardMaterialInfos Get standard material properties. ```python material.getStandardMaterialInfos(material) -> material.StandardMaterialInfos ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | ------------------------------- | | [Material](./material_types#material) | material | The material to get properties. | Returns | Type | Name | Description | | --------------------------------------------------------------- | ----- | ------------------------------------- | | [StandardMaterialInfos](./material_types#standardmaterialinfos) | infos | The StandardMaterialInfos properties. | ### getUniformPropertyType Get a shader uniform shader property type. ```python material.getUniformPropertyType(pattern, name) -> material.ShaderUniformType ``` Parameters | Type | Name | Description | | --------------------------------------------------------------- | ------- | ------------------------------------------ | | [CustomMaterialPattern](./material_types#custommaterialpattern) | pattern | The custom pattern. | | [String](./core_types#string) | name | Name of the property to get the type from. | Returns | Type | Name | Description | | ------------------------------------------------------- | ---- | ----------------------------- | | [ShaderUniformType](./material_types#shaderuniformtype) | type | Type of the uniform property. | ### getUnlitTextureMaterialInfos Get unlit texture material properties. ```python material.getUnlitTextureMaterialInfos(material) -> material.UnlitTextureMaterialInfos ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | ------------------------------- | | [Material](./material_types#material) | material | The material to get properties. | Returns | Type | Name | Description | | ----------------------------------------------------------------------- | ----- | ----------------------------------------- | | [UnlitTextureMaterialInfos](./material_types#unlittexturematerialinfos) | infos | The UnlitTextureMaterialInfos properties. | ### isOpaque Check if material is opaque. Function will return 'False' if: * The 'Opacity' Coeff is not 1.0 * The 'Opacity' property is a Texture * The 'Albedo' property is a Texture and at least one pixel of the texture has an alpha value. ```python material.isOpaque(material) -> core.Boolean ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | -------------------------- | | [Material](./material_types#material) | material | Material to check opacity. | Returns | Type | Name | Description | | ------------------------------- | ------ | ----------------------------------------------- | | [Boolean](./core_types#boolean) | opaque | Returns True if opaque or False if transparent. | ### makeMaterialNamesUnique Rename materials to have a unique name for each one. ```python material.makeMaterialNamesUnique(materials=[]) ``` Parameters | Type | Name | Description | | --------------------------------------------- | --------- | ---------------------------------------------------- | | [MaterialList](./material_types#materiallist) | materials | Materials to rename (rename all materials if empty). | ### remapIndexMap Create remapped versions of index maps. ```python material.remapIndexMap(maps, maxIndices=-1) -> material.ImageList, core.IntListList ``` Parameters | Type | Name | Description | | --------------------------------------- | ---------- | ------------------------------- | | [ImageList](./material_types#imagelist) | maps | Input Images. | | [Int](./core_types#int) | maxIndices | Number max of indices remapped. | Returns | Type | Name | Description | | --------------------------------------- | ------------------ | ------------------------------------ | | [ImageList](./material_types#imagelist) | mappedMaps | Output maps remapped. | | [IntListList](./core_types#intlistlist) | newToOldMapIndices | New index to old index for each map. | ### setCoeffOrTextureProperty Set a CoeffOrTexture property. ```python material.setCoeffOrTextureProperty(material, name, coeffOrTexture) ``` Parameters | Type | Name | Description | | ------------------------------------------------- | -------------- | ----------------------------------- | | [Material](./material_types#material) | material | The material to apply the color on. | | [String](./core_types#string) | name | The property to set. | | [CoeffOrTexture](./material_types#coeffortexture) | coeffOrTexture | The CoeffOrTexture to apply. | ### setColorAlphaProperty Set a ColorAlpha property. ```python material.setColorAlphaProperty(material, name, color) ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | ----------------------------------- | | [Material](./material_types#material) | material | The material to apply the color on. | | [String](./core_types#string) | name | The property to set. | | [ColorAlpha](./core_types#coloralpha) | color | The color to apply. | ### setColorOrTextureProperty Set a ColorOrTexture property. ```python material.setColorOrTextureProperty(material, name, colorOrTexture) ``` Parameters | Type | Name | Description | | ------------------------------------------------- | -------------- | ----------------------------------- | | [Material](./material_types#material) | material | The material to apply the color on. | | [String](./core_types#string) | name | The property to set. | | [ColorOrTexture](./material_types#colorortexture) | colorOrTexture | The ColorOrTexture to apply. | ### setFragmentShader Set the fragment shader of a custom pattern. ```python material.setFragmentShader(pattern, code) ``` Parameters | Type | Name | Description | | --------------------------------------------------------------- | ------- | ------------------------------------- | | [CustomMaterialPattern](./material_types#custommaterialpattern) | pattern | The custom pattern to edit. | | [String](./core_types#string) | code | The GLSL code of the fragment shader. | ### setMaterialMainColor Set the main color on any material pattern type. ```python material.setMaterialMainColor(material, color) ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | ----------------------------------- | | [Material](./material_types#material) | material | The material to apply the color on. | | [ColorAlpha](./core_types#coloralpha) | color | The color to apply. | ### setMaterialPattern Sets the MaterialPattern name of the material. ```python material.setMaterialPattern(material, pattern) ``` Parameters | Type | Name | Description | | ------------------------------------- | -------- | --------------------------------- | | [Material](./material_types#material) | material | The material to find the pattern. | | [String](./core_types#string) | pattern | The pattern of the material. | ### setPBRMaterialInfos Set PBR material properties. ```python material.setPBRMaterialInfos(material, infos) ``` Parameters | Type | Name | Description | | ----------------------------------------------------- | -------- | -------------------------------- | | [Material](./material_types#material) | material | The material to set properties. | | [PBRMaterialInfos](./material_types#pbrmaterialinfos) | infos | The PBRMaterialInfos properties. | ### setVertexShader Set the vertex shader of a custom pattern. ```python material.setVertexShader(pattern, code) ``` Parameters | Type | Name | Description | | --------------------------------------------------------------- | ------- | ----------------------------------- | | [CustomMaterialPattern](./material_types#custommaterialpattern) | pattern | The custom pattern to edit. | | [String](./core_types#string) | code | The GLSL code of the vertex shader. | ## Images ### applyFactorOnImage Aplly a factor to an image. ```python material.applyFactorOnImage(image, imageIsLinear, factor) ``` Parameters | Type | Name | Description | | ------------------------------------- | ------------- | ----------------------- | | [Image](./material_types#image) | image | Image to be modified. | | [Bool](./core_types#bool) | imageIsLinear | Image is linear or not. | | [ColorAlpha](./core_types#coloralpha) | factor | Factor to apply. | See also: * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### blurImage Applies a blurring to the given image. ```python material.blurImage(image, radius, blurType, edgeFilter) ``` Parameters | Type | Name | Description | | ----------------------------------------- | ---------- | ---------------------------------------------------- | | [Image](./material_types#image) | image | Image to blur. | | [Int](./core_types#int) | radius | Radius in pixels of the Gaussian kernel. | | [BlurFilter](./material_types#blurfilter) | blurType | Kernel of the blur filter to apply. | | [EdgeFilter](./material_types#edgefilter) | edgeFilter | Method to use for the management of boundary pixels. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### clearImageRoI Removes the region of interest from an image. ```python material.clearImageRoI(image) ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ----------------- | | [Image](./material_types#image) | image | Image to process. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### convertFloat32To8BitsImage Returns a new image from the given converter from 32bits float to a 8Bits (e.g. depth render map). ```python material.convertFloat32To8BitsImage(image32F, minValue=-1, maxValue=1, inPlace=False) -> material.Image ``` Parameters | Type | Name | Description | | ------------------------------- | -------- | ------------------------------------------------------------------- | | [Image](./material_types#image) | image32F | Image to convert. | | [Double](./core_types#double) | minValue | Minimal value of the floats (will be 0 in 8bits). | | [Double](./core_types#double) | maxValue | Minimal value of the floats (will be 255 in 8bits). | | [Boolean](./core_types#boolean) | inPlace | If true, the given image is modified instead of creating a new one. | Returns | Type | Name | Description | | ------------------------------- | ------- | -------------------- | | [Image](./material_types#image) | image8U | The new 8bits image. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### convertImage Converts the given image to a new format. ```python material.convertImage(image, layout, type, inPlace=False) -> material.Image ``` Parameters | Type | Name | Description | | --------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Image](./material_types#image) | image | Image to convert. | | [ImageLayout](./material_types#imagelayout) | layout | Layout (components definition) of the new image format. Accepted values are combinations of the following: 'R' (red), 'G' (green), 'B' (blue), 'A' (alpha), 'L' (luminance), 'S' (stencil index) and 'D' (depth component). | | [ImageComponentType](./material_types#imagecomponenttype) | type | Component data type of the new image format. | | [Boolean](./core_types#boolean) | inPlace | If true, the given image is modified instead of creating a new one. | Returns | Type | Name | Description | | ------------------------------- | -------------- | -------------------- | | [Image](./material_types#image) | convertedImage | The converted image. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### convertImageToDefinition Returns an image definition which contains data corresponding to the given image converted to a new format. ```python material.convertImageToDefinition(image, layout, type) -> material.ImageDefinition ``` Parameters | Type | Name | Description | | --------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Image](./material_types#image) | image | Image to convert. | | [ImageLayout](./material_types#imagelayout) | layout | Layout (components definition) of the new image format. Accepted values are combinations of the following: 'R' (red), 'G' (green), 'B' (blue), 'A' (alpha), 'L' (luminance), 'S' (stencil index) and 'D' (depth component). | | [ImageComponentType](./material_types#imagecomponenttype) | type | Component data type of the new image format. | Returns | Type | Name | Description | | --------------------------------------------------- | -------------- | ------------------------------- | | [ImageDefinition](./material_types#imagedefinition) | convertedImage | The converted image definition. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### createCheckerboardImage Create an image consisting in a black and white checkerboard. ```python material.createCheckerboardImage(width=1024, height=1024, cellSize=32, color1=core.ColorAlpha(0, 0, 0, 0), color2=core.ColorAlpha(1, 1, 1, 1), layout=6, type=1) -> material.Image ``` Parameters | Type | Name | Description | | --------------------------------------------------------- | -------- | --------------------------------------- | | [Int](./core_types#int) | width | Width desired for the created image. | | [Int](./core_types#int) | height | Height desired for the created image. | | [Int](./core_types#int) | cellSize | Size of checkerboard cells (in pixels). | | [ColorAlpha](./core_types#coloralpha) | color1 | First checkerboard color. | | [ColorAlpha](./core_types#coloralpha) | color2 | Second checkerboard color. | | [ImageLayout](./material_types#imagelayout) | layout | Desired image layout. | | [ImageComponentType](./material_types#imagecomponenttype) | type | Desired image component type. | Returns | Type | Name | Description | | ------------------------------- | ------------ | --------------------------------- | | [Image](./material_types#image) | checkerboard | The resulting checkerboard image. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### createImageFromData Import an Image from only its data. ```python material.createImageFromData(data, name="img") -> material.Image ``` Parameters | Type | Name | Description | | --------------------------------- | ---- | ---------------------- | | [ByteList](./core_types#bytelist) | data | The raw data as input. | | [String](./core_types#string) | name | If need of a name. | Returns | Type | Name | Description | | ------------------------------- | ----- | ------------------ | | [Image](./material_types#image) | image | The created Image. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### createImageFromDefinition Import an image from its raw data. ```python material.createImageFromDefinition(imageDefinition) -> material.Image ``` Parameters | Type | Name | Description | | --------------------------------------------------- | --------------- | --------------------- | | [ImageDefinition](./material_types#imagedefinition) | imageDefinition | The image definition. | Returns | Type | Name | Description | | ------------------------------- | ----- | ------------------ | | [Image](./material_types#image) | image | The created image. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### createImagesFromDefinitions Import images from their raw data. ```python material.createImagesFromDefinitions(imageDefinitions) -> material.ImageList ``` Parameters | Type | Name | Description | | ----------------------------------------------------------- | ---------------- | ---------------------- | | [ImageDefinitionList](./material_types#imagedefinitionlist) | imageDefinitions | The image definitions. | Returns | Type | Name | Description | | --------------------------------------- | ------ | ------------------- | | [ImageList](./material_types#imagelist) | images | The created images. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### exportImage Export an image. ```python material.exportImage(image, filename) ``` Parameters | Type | Name | Description | | --------------------------------------------- | -------- | ---------------------------------- | | [Image](./material_types#image) | image | Identifier of the image to export. | | [OutputFilePath](./core_types#outputfilepath) | filename | Filename of the file to export. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### extractImageChannels Creates new images from individual channels of the given image. ```python material.extractImageChannels(image, channel=-1) -> material.ImageList ``` Parameters | Type | Name | Description | | ------------------------------- | ------- | ----------------------------------------------------------- | | [Image](./material_types#image) | image | Image to convert. | | [Int](./core_types#int) | channel | Number of the channel to extract. -1 extracts all channels. | Returns | Type | Name | Description | | --------------------------------------- | --------------- | --------------------- | | [ImageList](./material_types#imagelist) | componentImages | Single channel image. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### extractImageComponents Creates new images from individual components of the given image. ```python material.extractImageComponents(image, components) -> material.ImageList ``` Parameters | Type | Name | Description | | ------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------- | | [Image](./material_types#image) | image | Image to convert. | | [ImageLayout](./material_types#imagelayout) | components | Name of the components to extract. Accepted values: 'R' (red), 'G' (green), 'B' (blue), 'A' (alpha), 'L' (luminance). | Returns | Type | Name | Description | | --------------------------------------- | --------------- | -------------------------------- | | [ImageList](./material_types#imagelist) | componentImages | List of single component images. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### fillImageWithColor Fills an image (or a sub-part of it) with the provided color. ```python material.fillImageWithColor(image, color, x=0, y=0, w=-1, h=-1) ``` Parameters | Type | Name | Description | | ------------------------------------- | ----- | ----------------------------------------------------------- | | [Image](./material_types#image) | image | Image from which type has to be fetched. | | [ColorAlpha](./core_types#coloralpha) | color | Filling color. | | [Int](./core_types#int) | x | Image X coordinate of the sub-image to fill. | | [Int](./core_types#int) | y | Image Y coordinate of the sub-image to fill. | | [Int](./core_types#int) | w | Width of the sub-image to fill (-1 means infinite width). | | [Int](./core_types#int) | h | Height of the sub-image to fill (-1 means infinite height). | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### fillUnusedPixels Fill unused pixels by propagating and averaging used pixels. ```python material.fillUnusedPixels(image, unusedColor=core.ColorAlpha(0., 0., 0., 0.), size=-1, validityMask=0, inPlace=False) -> material.Image ``` Parameters | Type | Name | Description | | ------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Image](./material_types#image) | image | Image to process. | | [ColorAlpha](./core_types#coloralpha) | unusedColor | Color used to identify unused pixels. | | [Int](./core_types#int) | size | Dilation size in pixels. | | [Image](./material_types#image) | validityMask | Image describing which texels are valid (color set to white) and which ones need to be filled (color set to black). If zero, unusedColor is used instead. | | [Boolean](./core_types#boolean) | inPlace | If True, the source image is modified. Otherwise, a new one is created. | Returns | Type | Name | Description | | ------------------------------- | ----------- | ----------------------------------- | | [Image](./material_types#image) | filledImage | Resulting image with filled pixels. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### flipImageY Applies a vertical flip to an image. ```python material.flipImageY(image) ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | -------------- | | [Image](./material_types#image) | image | Image to flip. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getAllImages Returns all the images loaded in the current session or from a list of materials. ```python material.getAllImages(materials=[]) -> material.ImageList ``` Parameters | Type | Name | Description | | --------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------- | | [MaterialList](./material_types#materiallist) | materials | Materials to retrieve the images from (returns all images loaded in the current session if empty). | Returns | Type | Name | Description | | --------------------------------------- | ------ | ----------------------------------------- | | [ImageList](./material_types#imagelist) | images | A list containing all images identifiers. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getExportImageFormats Returns image format names and extensions which can be exported in Pixyz. ```python material.getExportImageFormats() -> core.FormatList ``` Returns | Type | Name | Description | | ------------------------------------- | ------- | ----------------------------------- | | [FormatList](./core_types#formatlist) | formats | Image formats that can be exported. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImageColorBilinear Returns the color at a specific image point, in real coordinates, using bi-linear interpolation. ```python material.getImageColorBilinear(image, x, y, edgeFilter=0) -> core.ColorAlpha ``` Parameters | Type | Name | Description | | ----------------------------------------- | ---------- | ---------------------------------------------------- | | [Image](./material_types#image) | image | The image to get the color from. | | [Double](./core_types#double) | x | Image X coordinate (real). | | [Double](./core_types#double) | y | Image Y coordinate (real). | | [EdgeFilter](./material_types#edgefilter) | edgeFilter | Method to use for the management of boundary pixels. | Returns | Type | Name | Description | | ------------------------------------- | ----- | ------------------------------------------- | | [ColorAlpha](./core_types#coloralpha) | color | The color of the pixel at the x,y position. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImageColorRange Gets the min and max bounds of each image color component. ```python material.getImageColorRange(image) -> core.ColorAlphaList ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ------------- | | [Image](./material_types#image) | image | Source image. | Returns | Type | Name | Description | | --------------------------------------------- | ----------- | ----------------------------------------- | | [ColorAlphaList](./core_types#coloralphalist) | colorBounds | Min and max bounds of image color values. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImageComponentType Gets the component data type of the given image. ```python material.getImageComponentType(image) -> material.ImageComponentType ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ---------------------------------------- | | [Image](./material_types#image) | image | Image from which type has to be fetched. | Returns | Type | Name | Description | | --------------------------------------------------------- | ---- | --------------------------- | | [ImageComponentType](./material_types#imagecomponenttype) | type | Image data type definition. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImageComponentTypeName Gets the name of a given component data type ID. ```python material.getImageComponentTypeName(type) -> core.String ``` Parameters | Type | Name | Description | | --------------------------------------------------------- | ---- | ----------- | | [ImageComponentType](./material_types#imagecomponenttype) | type | | Returns | Type | Name | Description | | ----------------------------- | ---- | ----------- | | [String](./core_types#string) | name | | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImageDefinition Returns the raw data of an image. ```python material.getImageDefinition(image) -> material.ImageDefinition ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ------------- | | [Image](./material_types#image) | image | Source image. | Returns | Type | Name | Description | | --------------------------------------------------- | --------------- | ------------------------ | | [ImageDefinition](./material_types#imagedefinition) | imageDefinition | Definition of the image. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImageDefinitions Returns the raw data of a set of images. ```python material.getImageDefinitions(images) -> material.ImageDefinitionList ``` Parameters | Type | Name | Description | | --------------------------------------- | ------ | ----------- | | [ImageList](./material_types#imagelist) | images | The images. | Returns | Type | Name | Description | | ----------------------------------------------------------- | ---------------- | --------------------- | | [ImageDefinitionList](./material_types#imagedefinitionlist) | imageDefinitions | Images's definitions. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImageFormatName Gets a comprenhensive name from an image format. ```python material.getImageFormatName(layout, type) -> core.String ``` Parameters | Type | Name | Description | | --------------------------------------------------------- | ------ | ----------- | | [ImageLayout](./material_types#imagelayout) | layout | | | [ImageComponentType](./material_types#imagecomponenttype) | type | | Returns | Type | Name | Description | | ----------------------------- | ---- | ----------- | | [String](./core_types#string) | name | | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImageLayout Gets the layout (component definitions) of the given image. ```python material.getImageLayout(image) -> material.ImageLayout ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ------------------------------------------ | | [Image](./material_types#image) | image | Image from which layout has to be fetched. | Returns | Type | Name | Description | | ------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ImageLayout](./material_types#imagelayout) | layout | Image component definition. Valid values are combinations of the following: 'R' (red), 'G' (green), 'B' (blue), 'A' (alpha), 'L' (luminance), 'S' (stencil index) and 'D' (depth component). | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImagePixelColor Returns the color of a given pixel in an image. ```python material.getImagePixelColor(image, x, y) -> core.ColorAlpha ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | -------------------------------- | | [Image](./material_types#image) | image | The image to get the pixel from. | | [Int](./core_types#int) | x | The X pixel coordinate. | | [Int](./core_types#int) | y | The Y pixel coordinate. | Returns | Type | Name | Description | | ------------------------------------- | ----- | ------------------------------------------- | | [ColorAlpha](./core_types#coloralpha) | color | The color of the pixel at the x,y position. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImagePixelInfo Returns info about the image pixel format. ```python material.getImagePixelInfo(image) -> material.PixelInfo ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ------------- | | [Image](./material_types#image) | image | Source image. | Returns | Type | Name | Description | | --------------------------------------- | --------- | ------------------------------- | | [PixelInfo](./material_types#pixelinfo) | pixelInfo | Information about image pixels. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImagePixelInfoFromDefinition Returns info about the image pixel format. ```python material.getImagePixelInfoFromDefinition(imageDefinition) -> material.PixelInfo ``` Parameters | Type | Name | Description | | --------------------------------------------------- | --------------- | ------------- | | [ImageDefinition](./material_types#imagedefinition) | imageDefinition | Source image. | Returns | Type | Name | Description | | --------------------------------------- | --------- | ------------------------------- | | [PixelInfo](./material_types#pixelinfo) | pixelInfo | Information about image pixels. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImagePixelInfoFromLayoutAndType Returns info about the image pixel format for a given combination of image layout and component type. ```python material.getImagePixelInfoFromLayoutAndType(layout, type) -> material.PixelInfo ``` Parameters | Type | Name | Description | | --------------------------------------------------------- | ------ | ------------------------------------- | | [ImageLayout](./material_types#imagelayout) | layout | Image layout (components definition). | | [ImageComponentType](./material_types#imagecomponenttype) | type | Image component data type. | Returns | Type | Name | Description | | --------------------------------------- | --------- | ------------------------------- | | [PixelInfo](./material_types#pixelinfo) | pixelInfo | Information about image pixels. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImageRoI Returns the region of interest of an image. ```python material.getImageRoI(image) -> material.RoI ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ----------------- | | [Image](./material_types#image) | image | Image to process. | Returns | Type | Name | Description | | --------------------------- | ---- | ----------- | | [RoI](./material_types#roi) | roi | Image RoI. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImageSize Returns the size of an image. ```python material.getImageSize(image) -> core.Int, core.Int ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ------------------------------- | | [Image](./material_types#image) | image | The image to get the size from. | Returns | Type | Name | Description | | ----------------------- | ------ | ---------------------------------- | | [Int](./core_types#int) | width | The width of the image in pixels. | | [Int](./core_types#int) | height | The height of the image in pixels. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImagesSizes Returns the sizes of multiple images. ```python material.getImagesSizes(images) -> core.IntList, core.IntList ``` Parameters | Type | Name | Description | | --------------------------------------- | ------ | ------------------------------- | | [ImageList](./material_types#imagelist) | images | The image to get the size from. | Returns | Type | Name | Description | | ------------------------------- | ------- | ------------------------------------ | | [IntList](./core_types#intlist) | widths | The widths of the images in pixels. | | [IntList](./core_types#intlist) | heights | The heights of the images in pixels. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getImportImageFormats Returns the image format names and extensions which can be imported in Pixyz. ```python material.getImportImageFormats() -> core.FormatList ``` Returns | Type | Name | Description | | ------------------------------------- | ------- | ----------------------------------- | | [FormatList](./core_types#formatlist) | formats | Image formats that can be imported. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### getSubImage Extracts a sub-part of the given image. ```python material.getSubImage(image, x, y, w, h) -> material.Image ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ----------------------------------------------- | | [Image](./material_types#image) | image | Source image. | | [Int](./core_types#int) | x | Image X coordinate of the sub-image to extract. | | [Int](./core_types#int) | y | Image Y coordinate of the sub-image to extract. | | [Int](./core_types#int) | w | Width of the sub-image to extract. | | [Int](./core_types#int) | h | Height of the sub-image to extract. | Returns | Type | Name | Description | | ------------------------------- | -------- | ----------- | | [Image](./material_types#image) | subImage | Sub-image. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### importImage Import an image. ```python material.importImage(filename) -> material.Image ``` Parameters | Type | Name | Description | | --------------------------------- | -------- | -------------------------------- | | [FilePath](./core_types#filepath) | filename | Filename of the image to import. | Returns | Type | Name | Description | | ------------------------------- | ----- | --------------------------------- | | [Image](./material_types#image) | image | Identifier of the imported image. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### invertImageColor Inverts the color of all image pixels. ```python material.invertImageColor(image) ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ---------------- | | [Image](./material_types#image) | image | Image to invert. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### overrideImageFormat Changes the way image channels are interpreted by assigning a new format without modifying the data. Note that the new format must be compatible with the previous one, which means that they have to have the same number of bytes per pixel. ```python material.overrideImageFormat(image, layout=0, type=0) -> core.Boolean ``` Parameters | Type | Name | Description | | --------------------------------------------------------- | ------ | --------------------------------------------------------------- | | [Image](./material_types#image) | image | Image for format must be overridden. | | [ImageLayout](./material_types#imagelayout) | layout | New layout (keep the original one if set to Undefined). | | [ImageComponentType](./material_types#imagecomponenttype) | type | New component type (keep the original one if set to Undefined). | Returns | Type | Name | Description | | ------------------------------- | ------------ | ----------------------------------------- | | [Boolean](./core_types#boolean) | hasSucceeded | True in case of success, False otherwise. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### resizeImage Resize an image. ```python material.resizeImage(image, width, height, filteringMethod=0) ``` Parameters | Type | Name | Description | | --------------------------------------------------------- | --------------- | ------------------------------------ | | [Image](./material_types#image) | image | Image to be resize. | | [Int](./core_types#int) | width | New image width. | | [Int](./core_types#int) | height | New image height. | | [ResizeFilterMethod](./material_types#resizefiltermethod) | filteringMethod | Filtering method for image resizing. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### rotateImage Applies a rotation to (the sub-part of) an image. ```python material.rotateImage(image, angle, cx, cy, edgeFilter=0, adjustSize=False) ``` Parameters | Type | Name | Description | | ----------------------------------------- | ---------- | ------------------------------------------------------------- | | [Image](./material_types#image) | image | Image to process. | | [Double](./core_types#double) | angle | Rotation angle (in degrees). | | [Double](./core_types#double) | cx | X coordinate of the transformation center. | | [Double](./core_types#double) | cy | Y coordinate of the transformation center. | | [EdgeFilter](./material_types#edgefilter) | edgeFilter | Method to use for the management of boundary pixels. | | [Boolean](./core_types#boolean) | adjustSize | Adjust the dimensions of the image to fit the transformation. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### setImageRoI Defines the region of interest of an image. ```python material.setImageRoI(image, x, y, w, h) ``` Parameters | Type | Name | Description | | ------------------------------- | ----- | ------------------------------- | | [Image](./material_types#image) | image | Image to process. | | [Int](./core_types#int) | x | X coordinate of the RoI origin. | | [Int](./core_types#int) | y | Y coordinate of the RoI origin. | | [Int](./core_types#int) | w | Width of the RoI. | | [Int](./core_types#int) | h | Height of the RoI. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### setSubImage Replaces a part of a given image by another one. ```python material.setSubImage(destination, subImage, x, y, edgeFilter=0) ``` Parameters | Type | Name | Description | | ----------------------------------------- | ----------- | ---------------------------------------------------- | | [Image](./material_types#image) | destination | Destination image. | | [Image](./material_types#image) | subImage | Source image. | | [Int](./core_types#int) | x | X coordinate where to copy sub-image. | | [Int](./core_types#int) | y | Y coordinate where to copy sub-image. | | [EdgeFilter](./material_types#edgefilter) | edgeFilter | Method to use for the management of boundary pixels. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### stretchImage Applies a non-uniform scale to (the sub-part of) an image. ```python material.stretchImage(image, sx, sy, cx, cy, edgeFilter=0, adjustSize=False) ``` Parameters | Type | Name | Description | | ----------------------------------------- | ---------- | ------------------------------------------------------------- | | [Image](./material_types#image) | image | Image to process. | | [Double](./core_types#double) | sx | Scale factor along X axis. | | [Double](./core_types#double) | sy | Scale factor along Y axis. | | [Double](./core_types#double) | cx | X coordinate of the transformation center. | | [Double](./core_types#double) | cy | Y coordinate of the transformation center. | | [EdgeFilter](./material_types#edgefilter) | edgeFilter | Method to use for the management of boundary pixels. | | [Boolean](./core_types#boolean) | adjustSize | Adjust the dimensions of the image to fit the transformation. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### transformImage Applies a transformation matrix to (the sub-part of) an image. ```python material.transformImage(image, matrix, edgeFilter=0, adjustSize=False) ``` Parameters | Type | Name | Description | | ----------------------------------------- | ---------- | ------------------------------------------------------------- | | [Image](./material_types#image) | image | Image to process. | | [Matrix3](./geom_types#matrix3) | matrix | Transformation matrix. | | [EdgeFilter](./material_types#edgefilter) | edgeFilter | Method to use for the management of boundary pixels. | | [Boolean](./core_types#boolean) | adjustSize | Adjust the dimensions of the image to fit the transformation. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### translateImage Applies a translation to (the sub-part of) an image. ```python material.translateImage(image, tx, ty, edgeFilter=0, adjustSize=False) ``` Parameters | Type | Name | Description | | ----------------------------------------- | ---------- | ------------------------------------------------------------- | | [Image](./material_types#image) | image | Image to process. | | [Double](./core_types#double) | tx | X translation. | | [Double](./core_types#double) | ty | Y translation. | | [EdgeFilter](./material_types#edgefilter) | edgeFilter | Method to use for the management of boundary pixels. | | [Boolean](./core_types#boolean) | adjustSize | Adjust the dimensions of the image to fit the transformation. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### updateImageFromDefinition Update an image from its raw data. ```python material.updateImageFromDefinition(image, imageDefinition) ``` Parameters | Type | Name | Description | | --------------------------------------------------- | --------------- | ---------------------- | | [Image](./material_types#image) | image | The image to update. | | [ImageDefinition](./material_types#imagedefinition) | imageDefinition | The new data to apply. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImagesFromDefinitions](./material_functions#updateimagesfromdefinitions) ### updateImagesFromDefinitions Update images from their raw data. ```python material.updateImagesFromDefinitions(image, imageDefinitions) ``` Parameters | Type | Name | Description | | ----------------------------------------------------------- | ---------------- | ---------------------- | | [ImageList](./material_types#imagelist) | image | The image to update. | | [ImageDefinitionList](./material_types#imagedefinitionlist) | imageDefinitions | The new data to apply. | See also: * [material.applyFactorOnImage](./material_functions#applyfactoronimage) * [material.blurImage](./material_functions#blurimage) * [material.clearImageRoI](./material_functions#clearimageroi) * [material.convertFloat32To8BitsImage](./material_functions#convertfloat32to8bitsimage) * [material.convertImage](./material_functions#convertimage) * [material.convertImageToDefinition](./material_functions#convertimagetodefinition) * [material.createCheckerboardImage](./material_functions#createcheckerboardimage) * [material.createImageFromData](./material_functions#createimagefromdata) * [material.createImageFromDefinition](./material_functions#createimagefromdefinition) * [material.createImagesFromDefinitions](./material_functions#createimagesfromdefinitions) * [material.exportImage](./material_functions#exportimage) * [material.extractImageChannels](./material_functions#extractimagechannels) * [material.extractImageComponents](./material_functions#extractimagecomponents) * [material.fillImageWithColor](./material_functions#fillimagewithcolor) * [material.fillUnusedPixels](./material_functions#fillunusedpixels) * [material.flipImageY](./material_functions#flipimagey) * [material.getAllImages](./material_functions#getallimages) * [material.getExportImageFormats](./material_functions#getexportimageformats) * [material.getImageColorBilinear](./material_functions#getimagecolorbilinear) * [material.getImageColorRange](./material_functions#getimagecolorrange) * [material.getImageComponentType](./material_functions#getimagecomponenttype) * [material.getImageComponentTypeName](./material_functions#getimagecomponenttypename) * [material.getImageDefinition](./material_functions#getimagedefinition) * [material.getImageDefinitions](./material_functions#getimagedefinitions) * [material.getImageFormatName](./material_functions#getimageformatname) * [material.getImageLayout](./material_functions#getimagelayout) * [material.getImagePixelColor](./material_functions#getimagepixelcolor) * [material.getImagePixelInfo](./material_functions#getimagepixelinfo) * [material.getImagePixelInfoFromDefinition](./material_functions#getimagepixelinfofromdefinition) * [material.getImagePixelInfoFromLayoutAndType](./material_functions#getimagepixelinfofromlayoutandtype) * [material.getImageRoI](./material_functions#getimageroi) * [material.getImageSize](./material_functions#getimagesize) * [material.getImagesSizes](./material_functions#getimagessizes) * [material.getImportImageFormats](./material_functions#getimportimageformats) * [material.getSubImage](./material_functions#getsubimage) * [material.importImage](./material_functions#importimage) * [material.invertImageColor](./material_functions#invertimagecolor) * [material.overrideImageFormat](./material_functions#overrideimageformat) * [material.resizeImage](./material_functions#resizeimage) * [material.rotateImage](./material_functions#rotateimage) * [material.setImageRoI](./material_functions#setimageroi) * [material.setSubImage](./material_functions#setsubimage) * [material.stretchImage](./material_functions#stretchimage) * [material.transformImage](./material_functions#transformimage) * [material.translateImage](./material_functions#translateimage) * [material.updateImageFromDefinition](./material_functions#updateimagefromdefinition) ## userData ### getMaterialUserData Set or replace a userdata stored on an material. ```python material.getMaterialUserData(userDataId, material) -> core.Ptr ``` Parameters | Type | Name | Description | | ----------------------------------------------------- | ---------- | ------------------------------------------------------------ | | [MaterialUserData](./material_types#materialuserdata) | userDataId | UserData identifier provided by subscribeToMaterialUserData. | | [Material](./material_types#material) | material | Material that store the user data. | Returns | Type | Name | Description | | ----------------------- | -------- | --------------------------------------- | | [Ptr](./core_types#ptr) | userData | User data stored in the given material. | See also: * [material.getMultipleMaterialUserData](./material_functions#getmultiplematerialuserdata) * [material.hasMaterialUserData](./material_functions#hasmaterialuserdata) * [material.hasMultipleMaterialUserData](./material_functions#hasmultiplematerialuserdata) * [material.setMaterialUserData](./material_functions#setmaterialuserdata) * [material.setMultipleMaterialUserData](./material_functions#setmultiplematerialuserdata) * [material.subscribeToMaterialUserData](./material_functions#subscribetomaterialuserdata) * [material.unsetMaterialUserData](./material_functions#unsetmaterialuserdata) * [material.unsetMultipleMaterialUserData](./material_functions#unsetmultiplematerialuserdata) * [material.unsubscribeFromMaterialUserData](./material_functions#unsubscribefrommaterialuserdata) ### getMultipleMaterialUserData Batch version of getMaterialUserData. ```python material.getMultipleMaterialUserData(userDataId, materials) -> core.PtrList ``` Parameters | Type | Name | Description | | ----------------------------------------------------- | ---------- | ------------------------------------------------------------ | | [MaterialUserData](./material_types#materialuserdata) | userDataId | UserData identifier provided by subscribeToMaterialUserData. | | [MaterialList](./material_types#materiallist) | materials | Materials that store the user data. | Returns | Type | Name | Description | | ------------------------------- | ------------ | ----------------------------------------- | | [PtrList](./core_types#ptrlist) | userDataList | User data stored for each given material. | See also: * [material.getMaterialUserData](./material_functions#getmaterialuserdata) * [material.hasMaterialUserData](./material_functions#hasmaterialuserdata) * [material.hasMultipleMaterialUserData](./material_functions#hasmultiplematerialuserdata) * [material.setMaterialUserData](./material_functions#setmaterialuserdata) * [material.setMultipleMaterialUserData](./material_functions#setmultiplematerialuserdata) * [material.subscribeToMaterialUserData](./material_functions#subscribetomaterialuserdata) * [material.unsetMaterialUserData](./material_functions#unsetmaterialuserdata) * [material.unsetMultipleMaterialUserData](./material_functions#unsetmultiplematerialuserdata) * [material.unsubscribeFromMaterialUserData](./material_functions#unsubscribefrommaterialuserdata) ### hasMaterialUserData Set or replace a userdata stored on an material. ```python material.hasMaterialUserData(userDataId, material) -> core.Bool ``` Parameters | Type | Name | Description | | ----------------------------------------------------- | ---------- | ------------------------------------------------------------ | | [MaterialUserData](./material_types#materialuserdata) | userDataId | UserData identifier provided by subscribeToMaterialUserData. | | [Material](./material_types#material) | material | Material that potentially store the user data. | Returns | Type | Name | Description | | ------------------------- | ------ | ------------------------------------------------------------------------------- | | [Bool](./core_types#bool) | result | Returns true if a userdata is stored on this material for the given userDataId. | See also: * [material.getMaterialUserData](./material_functions#getmaterialuserdata) * [material.getMultipleMaterialUserData](./material_functions#getmultiplematerialuserdata) * [material.hasMultipleMaterialUserData](./material_functions#hasmultiplematerialuserdata) * [material.setMaterialUserData](./material_functions#setmaterialuserdata) * [material.setMultipleMaterialUserData](./material_functions#setmultiplematerialuserdata) * [material.subscribeToMaterialUserData](./material_functions#subscribetomaterialuserdata) * [material.unsetMaterialUserData](./material_functions#unsetmaterialuserdata) * [material.unsetMultipleMaterialUserData](./material_functions#unsetmultiplematerialuserdata) * [material.unsubscribeFromMaterialUserData](./material_functions#unsubscribefrommaterialuserdata) ### hasMultipleMaterialUserData Batch version of hasMaterialUserData. ```python material.hasMultipleMaterialUserData(userDataId, materials) -> core.BoolList ``` Parameters | Type | Name | Description | | ----------------------------------------------------- | ---------- | ------------------------------------------------------------ | | [MaterialUserData](./material_types#materialuserdata) | userDataId | UserData identifier provided by subscribeToMaterialUserData. | | [MaterialList](./material_types#materiallist) | materials | Materials that potentially store the user data. | Returns | Type | Name | Description | | --------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | | [BoolList](./core_types#boollist) | results | Returns an array of bool that are true if a userdata is stored on the material at the same index for the given userDataId. | See also: * [material.getMaterialUserData](./material_functions#getmaterialuserdata) * [material.getMultipleMaterialUserData](./material_functions#getmultiplematerialuserdata) * [material.hasMaterialUserData](./material_functions#hasmaterialuserdata) * [material.setMaterialUserData](./material_functions#setmaterialuserdata) * [material.setMultipleMaterialUserData](./material_functions#setmultiplematerialuserdata) * [material.subscribeToMaterialUserData](./material_functions#subscribetomaterialuserdata) * [material.unsetMaterialUserData](./material_functions#unsetmaterialuserdata) * [material.unsetMultipleMaterialUserData](./material_functions#unsetmultiplematerialuserdata) * [material.unsubscribeFromMaterialUserData](./material_functions#unsubscribefrommaterialuserdata) ### setMaterialUserData Set or replace a userdata stored on an material. ```python material.setMaterialUserData(userDataId, material, userData) ``` Parameters | Type | Name | Description | | ----------------------------------------------------- | ---------- | ------------------------------------------------------------ | | [MaterialUserData](./material_types#materialuserdata) | userDataId | UserData identifier provided by subscribeToMaterialUserData. | | [Material](./material_types#material) | material | Material that will store the user data. | | [Ptr](./core_types#ptr) | userData | User data to store in the given material. | See also: * [material.getMaterialUserData](./material_functions#getmaterialuserdata) * [material.getMultipleMaterialUserData](./material_functions#getmultiplematerialuserdata) * [material.hasMaterialUserData](./material_functions#hasmaterialuserdata) * [material.hasMultipleMaterialUserData](./material_functions#hasmultiplematerialuserdata) * [material.setMultipleMaterialUserData](./material_functions#setmultiplematerialuserdata) * [material.subscribeToMaterialUserData](./material_functions#subscribetomaterialuserdata) * [material.unsetMaterialUserData](./material_functions#unsetmaterialuserdata) * [material.unsetMultipleMaterialUserData](./material_functions#unsetmultiplematerialuserdata) * [material.unsubscribeFromMaterialUserData](./material_functions#unsubscribefrommaterialuserdata) ### setMultipleMaterialUserData Batch version of setMaterialUserData. ```python material.setMultipleMaterialUserData(userDataId, materials, userDataList) ``` Parameters | Type | Name | Description | | ----------------------------------------------------- | ------------ | ------------------------------------------------------------ | | [MaterialUserData](./material_types#materialuserdata) | userDataId | UserData identifier provided by subscribeToMaterialUserData. | | [MaterialList](./material_types#materiallist) | materials | Materials that will store the user data. | | [PtrList](./core_types#ptrlist) | userDataList | User data to store on each material. | See also: * [material.getMaterialUserData](./material_functions#getmaterialuserdata) * [material.getMultipleMaterialUserData](./material_functions#getmultiplematerialuserdata) * [material.hasMaterialUserData](./material_functions#hasmaterialuserdata) * [material.hasMultipleMaterialUserData](./material_functions#hasmultiplematerialuserdata) * [material.setMaterialUserData](./material_functions#setmaterialuserdata) * [material.subscribeToMaterialUserData](./material_functions#subscribetomaterialuserdata) * [material.unsetMaterialUserData](./material_functions#unsetmaterialuserdata) * [material.unsetMultipleMaterialUserData](./material_functions#unsetmultiplematerialuserdata) * [material.unsubscribeFromMaterialUserData](./material_functions#unsubscribefrommaterialuserdata) ### subscribeToMaterialUserData Subscribe to material user data. multiple different userdata can be stored on the same materials if subscribeToMaterialUserData is called multiple times. ```python material.subscribeToMaterialUserData() -> material.MaterialUserData ``` Returns | Type | Name | Description | | ----------------------------------------------------- | ---------- | ----------------------------------------------------------------- | | [MaterialUserData](./material_types#materialuserdata) | userDataId | UserData identifier to pass to setUserData/getUserData functions. | See also: * [material.getMaterialUserData](./material_functions#getmaterialuserdata) * [material.getMultipleMaterialUserData](./material_functions#getmultiplematerialuserdata) * [material.hasMaterialUserData](./material_functions#hasmaterialuserdata) * [material.hasMultipleMaterialUserData](./material_functions#hasmultiplematerialuserdata) * [material.setMaterialUserData](./material_functions#setmaterialuserdata) * [material.setMultipleMaterialUserData](./material_functions#setmultiplematerialuserdata) * [material.unsetMaterialUserData](./material_functions#unsetmaterialuserdata) * [material.unsetMultipleMaterialUserData](./material_functions#unsetmultiplematerialuserdata) * [material.unsubscribeFromMaterialUserData](./material_functions#unsubscribefrommaterialuserdata) ### unsetMaterialUserData Unset the userdata stored on an material. ```python material.unsetMaterialUserData(userDataId, material) ``` Parameters | Type | Name | Description | | ----------------------------------------------------- | ---------- | ------------------------------------------------------------ | | [MaterialUserData](./material_types#materialuserdata) | userDataId | UserData identifier provided by subscribeToMaterialUserData. | | [Material](./material_types#material) | material | Material that will store the user data. | See also: * [material.getMaterialUserData](./material_functions#getmaterialuserdata) * [material.getMultipleMaterialUserData](./material_functions#getmultiplematerialuserdata) * [material.hasMaterialUserData](./material_functions#hasmaterialuserdata) * [material.hasMultipleMaterialUserData](./material_functions#hasmultiplematerialuserdata) * [material.setMaterialUserData](./material_functions#setmaterialuserdata) * [material.setMultipleMaterialUserData](./material_functions#setmultiplematerialuserdata) * [material.subscribeToMaterialUserData](./material_functions#subscribetomaterialuserdata) * [material.unsetMultipleMaterialUserData](./material_functions#unsetmultiplematerialuserdata) * [material.unsubscribeFromMaterialUserData](./material_functions#unsubscribefrommaterialuserdata) ### unsetMultipleMaterialUserData Batch version of unsetMaterialUserData. ```python material.unsetMultipleMaterialUserData(userDataId, materials) ``` Parameters | Type | Name | Description | | ----------------------------------------------------- | ---------- | ------------------------------------------------------------ | | [MaterialUserData](./material_types#materialuserdata) | userDataId | UserData identifier provided by subscribeToMaterialUserData. | | [MaterialList](./material_types#materiallist) | materials | Materials that will store the user data. | See also: * [material.getMaterialUserData](./material_functions#getmaterialuserdata) * [material.getMultipleMaterialUserData](./material_functions#getmultiplematerialuserdata) * [material.hasMaterialUserData](./material_functions#hasmaterialuserdata) * [material.hasMultipleMaterialUserData](./material_functions#hasmultiplematerialuserdata) * [material.setMaterialUserData](./material_functions#setmaterialuserdata) * [material.setMultipleMaterialUserData](./material_functions#setmultiplematerialuserdata) * [material.subscribeToMaterialUserData](./material_functions#subscribetomaterialuserdata) * [material.unsetMaterialUserData](./material_functions#unsetmaterialuserdata) * [material.unsubscribeFromMaterialUserData](./material_functions#unsubscribefrommaterialuserdata) ### unsubscribeFromMaterialUserData ```python material.unsubscribeFromMaterialUserData(userDataId) ``` Parameters | Type | Name | Description | | ----------------------------------------------------- | ---------- | ----------------------------------- | | [MaterialUserData](./material_types#materialuserdata) | userDataId | UserData identifier to unsubscribe. | See also: * [material.getMaterialUserData](./material_functions#getmaterialuserdata) * [material.getMultipleMaterialUserData](./material_functions#getmultiplematerialuserdata) * [material.hasMaterialUserData](./material_functions#hasmaterialuserdata) * [material.hasMultipleMaterialUserData](./material_functions#hasmultiplematerialuserdata) * [material.setMaterialUserData](./material_functions#setmaterialuserdata) * [material.setMultipleMaterialUserData](./material_functions#setmultiplematerialuserdata) * [material.subscribeToMaterialUserData](./material_functions#subscribetomaterialuserdata) * [material.unsetMaterialUserData](./material_functions#unsetmaterialuserdata) * [material.unsetMultipleMaterialUserData](./material_functions#unsetmultiplematerialuserdata)