Class Material

Inheritance

Material

Namespace:

Syntax

Methods

addUniformProperty

Add a shader uniform parameter to the given custom pattern

Declaration

material.addUniformProperty(pattern, name, type)

Parameters

Type	Name	Description
CustomMaterialPattern	pattern	The custom pattern to edit
String	name	Name of the new property
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

Declaration

material.areOpaques(materials) -> core.BoolList

Parameters

Type	Name	Description
MaterialList	materials	Materials to check opacity

Returns

Type	Description
BoolList	For each given material, returns True if opaque or False if transparent

clearAllMaterials

Remove and delete all the materials

Declaration

material.clearAllMaterials()

configureFunctionLogger

Declaration

material.configureFunctionLogger(functionName, enableFunction, enableParameters, enableExecutionTime)

Parameters

Type	Name	Description
String	functionName
Boolean	enableFunction
Boolean	enableParameters
Boolean	enableExecutionTime

convertHeightMapToNormalMap

Convert a height map to a normal map

Declaration

material.convertHeightMapToNormalMap(hmap, height) -> material.Image

Parameters

Type	Name	Description
Image	hmap	Height map reference
Double	height	Maximum height

Returns

Type	Description
Image	Normal map

copyMaterial

copies a material

Declaration

material.copyMaterial(toCopy, addToMaterialLibrary) -> material.Material

Parameters

Type	Name	Description
Material	toCopy	Material to copy
Boolean	addToMaterialLibrary	Add to material library

Returns

Type	Description
Material	The copied material

createCustomMaterialPattern

Create a new custom material pattern

Declaration

material.createCustomMaterialPattern(name) -> material.CustomMaterialPattern

Parameters

Type	Name	Description
String	name	Name of the pattern

Returns

Type	Description
CustomMaterialPattern	The created material pattern

createMaterial

Create a new material from pattern

Declaration

material.createMaterial(name, pattern, addToMaterialLibrary) -> material.Material

Parameters

Type	Name	Description
String	name	Name of the material
String	pattern	Name of the pattern
Boolean	addToMaterialLibrary	Name of the pattern

Returns

Type	Description
Material	The created material

createMaterialFromDefinition

Create PBR material from a material definition

Declaration

material.createMaterialFromDefinition(materialDefinition) -> material.Material

Parameters

Type	Name	Description
MaterialDefinition	materialDefinition	The structure containing all the PBR material information

Returns

Type	Description
Material	The created material

createMaterialsFromDefinitions

Create PBR materials from material definitions

Declaration

material.createMaterialsFromDefinitions(materialDefinitions) -> material.MaterialList

Parameters

Type	Name	Description
MaterialDefinitionList	materialDefinitions	Material definitions containing properties for each given material

Returns

Type	Description
MaterialList	The created materials

createMaterialsFromMaps

Automatically creates PBR materials when importing PBR texture maps from a folder

Declaration

material.createMaterialsFromMaps(directory) -> material.MaterialFromMapsReturn

Parameters

Type	Name	Description
DirectoryPath	directory	Directory path

Returns

Type	Description
MaterialFromMapsReturn	Results of the createMaterialsFromMaps function

filterAO

Filter an AO map using ATrous method

Declaration

material.filterAO(aoMaps, normalMaps, sigmaPos, sigmaValue, sigmaNormal, levelCount, filterLowValues, lowValueThreshold) -> material.ImageList

Parameters

Type	Name	Description
ImageList	aoMaps	Input AO Maps (the alpha component must be set to 0 for unused pixels)
ImageList	normalMaps	Input Normal Maps (preferable to use World space normal maps, but Object space normal maps can be used too)
Double	sigmaPos	ATrous Sigma pos
Double	sigmaValue	ATrous Sigma value
Double	sigmaNormal	ATrous Sigma normal
Int	levelCount	Atrous #Levels
Boolean	filterLowValues	Remove low values from the filtering (see: lowValuesThreshold parameter)
Double	lowValueThreshold	Threshold used if filterLowValues is enabled

Returns

Type	Description
ImageList	The filtered AO Maps

findCustomMaterialPatternByName

Returns the material pattern which has the given name

Declaration

material.findCustomMaterialPatternByName(name) -> material.CustomMaterialPattern

Parameters

Type	Name	Description
String	name	The name of the material pattern

Returns

Type	Description
CustomMaterialPattern	The material pattern

findMaterialsByPattern

Returns all materials using the given pattern

Declaration

material.findMaterialsByPattern(pattern) -> material.MaterialList

Parameters

Type	Name	Description
String	pattern	A material pattern

Returns

Type	Description
MaterialList	Materials using the pattern

findMaterialsByProperty

Returns all materials which match a given property value

Declaration

material.findMaterialsByProperty(propertyName, propertyValue, caseInsensitive) -> material.MaterialList

Parameters

Type	Name	Description
String	propertyName	Name of the property to match
Regex	propertyValue	Regular expression to match for the property value
Bool	caseInsensitive	If True, the regex will be insensitive to upper and lower cases

Returns

Type	Description
MaterialList	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)

Declaration

material.generateColorFromIndex(index) -> core.Color

Parameters

Type	Name	Description
Int	index	Index

Returns

Type	Description
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)

Declaration

material.generateUniqueColors(count) -> core.ColorList

Parameters

Type	Name	Description
Int	count	Number of unique colors to generate

Returns

Type	Description
ColorList	Count unique colors

getAllMaterialPatterns

Returns all the material patterns in the current session

Declaration

material.getAllMaterialPatterns() -> core.StringList

Returns

Type	Description
StringList	A list containing all material patterns

getAllMaterials

Retrieve the list of all the materials in the material library

Declaration

material.getAllMaterials() -> material.MaterialList

Returns

Type	Description
MaterialList	List of materials in the material library

getColorMaterialInfos

Get color material properties

Declaration

material.getColorMaterialInfos(material) -> material.ColorMaterialInfos

Parameters

Type	Name	Description
Material	material	The material to get properties

Returns

Type	Description
ColorMaterialInfos	The ColorMaterialInfos properties

getCustomMaterialPattern

Returns the custom material pattern associated to the custom material

Declaration

material.getCustomMaterialPattern(material) -> material.CustomMaterialPattern

Parameters

Type	Name	Description
Material	material	Custom material to get the pattern from

Returns

Type	Description
CustomMaterialPattern	The custom material pattern

getImageAverageColor

Get the average color of an image

Declaration

material.getImageAverageColor(image) -> core.ColorAlpha, core.ColorAlpha

Parameters

Type	Name	Description
Image	image	The image

Returns

Type	Description
ColorAlpha	The main color

getImpostorMaterialInfos

Get impostor texture material properties

Declaration

material.getImpostorMaterialInfos(material) -> material.ImpostorMaterialInfos

Parameters

Type	Name	Description
Material	material	The material to get properties

Returns

Type	Description
ImpostorMaterialInfos	The getImpostorMaterialInfos properties

getMaterialDefinition

Returns the properties of a PBR Material

Declaration

material.getMaterialDefinition(material) -> material.MaterialDefinition

Parameters

Type	Name	Description
Material	material	The PBR Material

Returns

Type	Description
MaterialDefinition	The PBR material definition

getMaterialDefinitions

Returns the properties of a set of PBR Materials

Declaration

material.getMaterialDefinitions(materials) -> material.MaterialDefinitionList

Parameters

Type	Name	Description
MaterialList	materials	The PBR Materials

Returns

Type	Description
MaterialDefinitionList	The PBR Material definitions

getMaterialMainColor

Get the main color on any material pattern type

Declaration

material.getMaterialMainColor(material) -> core.ColorAlpha

Parameters

Type	Name	Description
Material	material	The material

Returns

Type	Description
ColorAlpha	The main color

getMaterialPattern

Gets the MaterialPattern name of the material

Declaration

material.getMaterialPattern(material) -> core.String

Parameters

Type	Name	Description
Material	material	The material to find the pattern

Returns

Type	Description
String	The pattern of the material

getMaterialPatternType

Returns the MaterialPatternType name of the material

Declaration

material.getMaterialPatternType(material) -> material.MaterialPatternType

Parameters

Type	Name	Description
Material	material	The material to find the pattern

Returns

Type	Description
MaterialPatternType	The pattern type of the material

getPBRMaterialInfos

Get PBR material properties

Declaration

material.getPBRMaterialInfos(material) -> material.PBRMaterialInfos

Parameters

Type	Name	Description
Material	material	The material to get properties

Returns

Type	Description
PBRMaterialInfos	The PBRMaterialInfos properties

getPointsAndMaterialFromText

Returns a list of 3D Points and a material from a string and a fontname

Declaration

material.getPointsAndMaterialFromText(text, fontName, fontSize, matrix, colorInput, offset, height3D) -> geom.Point3List, geom.Point2List, geom.Vector3, material.Material, core.Double

Parameters

Type	Name	Description
String	text	Input text
String	fontName	Fontname
Int	fontSize	FontSize
Matrix4	matrix	Input matrix for the text
Color	colorInput	Color of the font needed
Double	offset	Input offset for the text
Double	height3D	Input height in 3D which will be a ratio from the textSize

Returns

Type	Description
Point3List

getStandardMaterialInfos

Get standard material properties

Declaration

material.getStandardMaterialInfos(material) -> material.StandardMaterialInfos

Parameters

Type	Name	Description
Material	material	The material to get properties

Returns

Type	Description
StandardMaterialInfos	The StandardMaterialInfos properties

getUniformPropertyType

Get a shader uniform shader property type

Declaration

material.getUniformPropertyType(pattern, name) -> material.ShaderUniformType

Parameters

Type	Name	Description
CustomMaterialPattern	pattern	The custom pattern
String	name	Name of the property to get the type from

Returns

Type	Description
ShaderUniformType	Type of the uniform property

getUnlitTextureMaterialInfos

Get unlit texture material properties

Declaration

material.getUnlitTextureMaterialInfos(material) -> material.UnlitTextureMaterialInfos

Parameters

Type	Name	Description
Material	material	The material to get properties

Returns

Type	Description
UnlitTextureMaterialInfos	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

Declaration

material.isOpaque(material) -> core.Boolean

Parameters

Type	Name	Description
Material	material	Material to check opacity

Returns

Type	Description
Boolean	Returns True if opaque or False if transparent

makeMaterialNamesUnique

Rename materials to have a unique name for each one

Declaration

material.makeMaterialNamesUnique(materials=[])

Parameters

Type	Name	Description
MaterialList	materials	Materials to rename (rename all materials if empty)

remapIndexMap

create remapped versions of index maps

Declaration

material.remapIndexMap(maps, maxIndices) -> material.ImageList, core.IntListList

Parameters

Type	Name	Description
ImageList	maps	Input Images
Int	maxIndices	Number max of indices remapped

Returns

Type	Description
ImageList	Output maps remapped

setCoeffOrTextureProperty

Set a CoeffOrTexture property

Declaration

material.setCoeffOrTextureProperty(material, name, coeffOrTexture)

Parameters

Type	Name	Description
Material	material	The material to apply the color on
String	name	The property to set
CoeffOrTexture	coeffOrTexture	The CoeffOrTexture to apply

setColorAlphaProperty

Set a ColorAlpha property

Declaration

material.setColorAlphaProperty(material, name, color)

Parameters

Type	Name	Description
Material	material	The material to apply the color on
String	name	The property to set
ColorAlpha	color	The color to apply

setColorOrTextureProperty

Set a ColorOrTexture property

Declaration

material.setColorOrTextureProperty(material, name, colorOrTexture)

Parameters

Type	Name	Description
Material	material	The material to apply the color on
String	name	The property to set
ColorOrTexture	colorOrTexture	The ColorOrTexture to apply

setFragmentShader

Set the fragment shader of a custom pattern

Declaration

material.setFragmentShader(pattern, code)

Parameters

Type	Name	Description
CustomMaterialPattern	pattern	The custom pattern to edit
String	code	The GLSL code of the fragment shader

setMaterialMainColor

Set the main color on any material pattern type

Declaration

material.setMaterialMainColor(material, color)

Parameters

Type	Name	Description
Material	material	The material to apply the color on
ColorAlpha	color	The color to apply

setMaterialPattern

Sets the MaterialPattern name of the material

Declaration

material.setMaterialPattern(material, pattern)

Parameters

Type	Name	Description
Material	material	The material to find the pattern
String	pattern	The pattern of the material

setPBRMaterialInfos

Set PBR material properties

Declaration

material.setPBRMaterialInfos(material, infos)

Parameters

Type	Name	Description
Material	material	The material to set properties
PBRMaterialInfos	infos	The PBRMaterialInfos properties

setVertexShader

Set the vertex shader of a custom pattern

Declaration

material.setVertexShader(pattern, code)

Parameters

Type	Name	Description
CustomMaterialPattern	pattern	The custom pattern to edit
String	code	The GLSL code of the vertex shader

applyFactorOnImage

Aplly a factor to an image

See also:

Declaration

material.applyFactorOnImage(image, imageIsLinear, factor)

Parameters

Type	Name	Description
Image	image	Image to be modified
Bool	imageIsLinear	Image is linear or not
ColorAlpha	factor	Factor to apply

blurImage

Applies a blurring to the given image

See also:

Declaration

material.blurImage(image, radius, blurType, edgeFilter)

Parameters

Type	Name	Description
Image	image	Image to blur
Int	radius	Radius in pixels of the Gaussian kernel
BlurFilter	blurType	Kernel of the blur filter to apply
EdgeFilter	edgeFilter	Method to use for the management of boundary pixels

clearImageRoI

Removes the region of interest from an image

See also:

Declaration

material.clearImageRoI(image)

Parameters

Type	Name	Description
Image	image	Image to process

convertFloat32To8BitsImage

Returns a new image from the given converter from 32bits float to a 8Bits (e.g. depth render map)

See also:

Declaration

material.convertFloat32To8BitsImage(image32F, minValue, maxValue, inPlace) -> material.Image

Parameters

Type	Name	Description
Image	image32F	Image to convert
Double	minValue	Minimal value of the floats (will be 0 in 8bits)
Double	maxValue	Minimal value of the floats (will be 255 in 8bits)
Boolean	inPlace	If true, the given image is modified instead of creating a new one

Returns

Type	Description
Image	The new 8bits image

convertImage

Converts the given image to a new format

See also:

Declaration

material.convertImage(image, layout, type, inPlace) -> material.Image

Parameters

Type	Name	Description
Image	image	Image to convert
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	type	Component data type of the new image format
Boolean	inPlace	If true, the given image is modified instead of creating a new one

Returns

Type	Description
Image	The converted image

convertImageToDefinition

Returns an image definition which contains data corresponding to the given image converted to a new format

See also:

Declaration

material.convertImageToDefinition(image, layout, type) -> material.ImageDefinition

Parameters

Type	Name	Description
Image	image	Image to convert
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	type	Component data type of the new image format

Returns

Type	Description
ImageDefinition	The converted image definition

createCheckerboardImage

Create an image consisting in a black and white checkerboard

See also:

Declaration

material.createCheckerboardImage(width, height, cellSize, color1, color2, layout, type) -> material.Image

Parameters

Type	Name	Description
Int	width	Width desired for the created image
Int	height	Height desired for the created image
Int	cellSize	Size of checkerboard cells (in pixels)
ColorAlpha	color1	First checkerboard color
ColorAlpha	color2	Second checkerboard color
ImageLayout	layout	Desired image layout
ImageComponentType	type	Desired image component type

Returns

Type	Description
Image	The resulting checkerboard image

createImageFromData

Import an Image from only its data

See also:

Declaration

material.createImageFromData(data, name) -> material.Image

Parameters

Type	Name	Description
ByteList	data	The raw data as input
String	name	If need of a name

Returns

Type	Description
Image	The created Image

createImageFromDefinition

Import an image from its raw data

See also:

Declaration

material.createImageFromDefinition(imageDefinition) -> material.Image

Parameters

Type	Name	Description
ImageDefinition	imageDefinition	The image definition

Returns

Type	Description
Image	The created image

createImagesFromDefinitions

Import images from their raw data

See also:

Declaration

material.createImagesFromDefinitions(imageDefinitions) -> material.ImageList

Parameters

Type	Name	Description
ImageDefinitionList	imageDefinitions	The image definitions

Returns

Type	Description
ImageList	The created images

exportImage

Export an image

See also:

Declaration

material.exportImage(image, filename)

Parameters

Type	Name	Description
Image	image	Identifier of the image to export
OutputFilePath	filename	Filename of the file to export

extractImageChannels

Creates new images from individual channels of the given image

See also:

Declaration

material.extractImageChannels(image, channel) -> material.ImageList

Parameters

Type	Name	Description
Image	image	Image to convert
Int	channel	Number of the channel to extract. -1 extracts all channels

Returns

Type	Description
ImageList	Single channel image

extractImageComponents

Creates new images from individual components of the given image

See also:

Declaration

material.extractImageComponents(image, components) -> material.ImageList

Parameters

Type	Name	Description
Image	image	Image to convert
ImageLayout	components	Name of the components to extract. Accepted values: 'R' (red), 'G' (green), 'B' (blue), 'A' (alpha), 'L' (luminance).

Returns

Type	Description
ImageList	List of single component images

fillImageWithColor

Fills an image (or a sub-part of it) with the provided color

See also:

Declaration

material.fillImageWithColor(image, color, x=0, y=0, w=-1, h=-1)

Parameters

Type	Name	Description
Image	image	Image from which type has to be fetched
ColorAlpha	color	Filling color
Int	x	Image X coordinate of the sub-image to fill
Int	y	Image Y coordinate of the sub-image to fill
Int	w	Width of the sub-image to fill (-1 means infinite width)
Int	h	Height of the sub-image to fill (-1 means infinite height)

fillUnusedPixels

Fill unused pixels by propagating and averaging used pixels

See also:

Declaration

material.fillUnusedPixels(image, unusedColor, size, validityMask, inPlace) -> material.Image

Parameters

Type	Name	Description
Image	image	Image to process
ColorAlpha	unusedColor	Color used to identify unused pixels
Int	size	Dilation size in pixels
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	inPlace	If True, the source image is modified. Otherwise, a new one is created

Returns

Type	Description
Image	Resulting image with filled pixels

flipImageY

Applies a vertical flip to an image

See also:

Declaration

material.flipImageY(image)

Parameters

Type	Name	Description
Image	image	Image to flip

getAllImages

Returns all the images loaded in the current session or from a list of materials

See also:

Declaration

material.getAllImages(materials) -> material.ImageList

Parameters

Type	Name	Description
MaterialList	materials	Materials to retrieve the images from (returns all images loaded in the current session if empty)

Returns

Type	Description
ImageList	A list containing all images identifiers

getExportImageFormats

Returns image format names and extensions which can be exported in Pixyz

See also:

Declaration

material.getExportImageFormats() -> core.FormatList

Returns

Type	Description
FormatList	Image formats that can be exported

getImageColorBilinear

Returns the color at a specific image point, in real coordinates, using bi-linear interpolation

See also:

Declaration

material.getImageColorBilinear(image, x, y, edgeFilter) -> core.ColorAlpha

Parameters

Type	Name	Description
Image	image	The image to get the color from
Double	x	Image X coordinate (real)
Double	y	Image Y coordinate (real)
EdgeFilter	edgeFilter	Method to use for the management of boundary pixels

Returns

Type	Description
ColorAlpha	The color of the pixel at the x,y position

getImageColorRange

Gets the min and max bounds of each image color component

See also:

Declaration

material.getImageColorRange(image) -> core.ColorAlphaList

Parameters

Type	Name	Description
Image	image	Source image

Returns

Type	Description
ColorAlphaList	Min and max bounds of image color values.

getImageComponentType

Gets the component data type of the given image

See also:

Declaration

material.getImageComponentType(image) -> material.ImageComponentType

Parameters

Type	Name	Description
Image	image	Image from which type has to be fetched

Returns

Type	Description
ImageComponentType	Image data type definition

getImageComponentTypeName

Gets the name of a given component data type ID

See also:

Declaration

material.getImageComponentTypeName(type) -> core.String

Parameters

Type	Name	Description
ImageComponentType	type

Returns

Type	Description
String

getImageDefinition

Returns the raw data of an image

See also:

Declaration

material.getImageDefinition(image) -> material.ImageDefinition

Parameters

Type	Name	Description
Image	image	Source image

Returns

Type	Description
ImageDefinition	Definition of the image

getImageDefinitions

Returns the raw data of a set of images

See also:

Declaration

material.getImageDefinitions(images) -> material.ImageDefinitionList

Parameters

Type	Name	Description
ImageList	images	The images

Returns

Type	Description
ImageDefinitionList	Images's definitions

getImageFormatName

Gets a comprenhensive name from an image format

See also:

Declaration

material.getImageFormatName(layout, type) -> core.String

Parameters

Type	Name	Description
ImageLayout	layout
ImageComponentType	type

Returns

Type	Description
String

getImageLayout

Gets the layout (component definitions) of the given image

See also:

Declaration

material.getImageLayout(image) -> material.ImageLayout

Parameters

Type	Name	Description
Image	image	Image from which layout has to be fetched

Returns

Type	Description
ImageLayout	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).

getImagePixelColor

Returns the color of a given pixel in an image

See also:

Declaration

material.getImagePixelColor(image, x, y) -> core.ColorAlpha

Parameters

Type	Name	Description
Image	image	The image to get the pixel from
Int	x	The X pixel coordinate
Int	y	The Y pixel coordinate

Returns

Type	Description
ColorAlpha	The color of the pixel at the x,y position

getImagePixelInfo

Returns info about the image pixel format

See also:

Declaration

material.getImagePixelInfo(image) -> material.PixelInfo

Parameters

Type	Name	Description
Image	image	Source image

Returns

Type	Description
PixelInfo	Information about image pixels

getImagePixelInfoFromDefinition

Returns info about the image pixel format

See also:

Declaration

material.getImagePixelInfoFromDefinition(imageDefinition) -> material.PixelInfo

Parameters

Type	Name	Description
ImageDefinition	imageDefinition	Source image

Returns

Type	Description
PixelInfo	Information about image pixels

getImagePixelInfoFromLayoutAndType

Returns info about the image pixel format for a given combination of image layout and component type

See also:

Declaration

material.getImagePixelInfoFromLayoutAndType(layout, type) -> material.PixelInfo

Parameters

Type	Name	Description
ImageLayout	layout	Image layout (components definition)
ImageComponentType	type	Image component data type

Returns

Type	Description
PixelInfo	Information about image pixels

getImageRoI

Returns the region of interest of an image

See also:

Declaration

material.getImageRoI(image) -> material.RoI

Parameters

Type	Name	Description
Image	image	Image to process

Returns

Type	Description
RoI	Image RoI

getImageSize

Returns the size of an image

See also:

Declaration

material.getImageSize(image) -> core.Int, core.Int

Parameters

Type	Name	Description
Image	image	The image to get the size from

Returns

Type	Description
Int	The width of the image in pixels

getImagesSizes

Returns the sizes of multiple images

See also:

Declaration

material.getImagesSizes(images) -> core.IntList, core.IntList

Parameters

Type	Name	Description
ImageList	images	The image to get the size from

Returns

Type	Description
IntList	The widths of the images in pixels

getImportImageFormats

Returns the image format names and extensions which can be imported in Pixyz

See also:

Declaration

material.getImportImageFormats() -> core.FormatList

Returns

Type	Description
FormatList	Image formats that can be imported

getSubImage

Extracts a sub-part of the given image

See also:

Declaration

material.getSubImage(image, x, y, w, h) -> material.Image

Parameters

Type	Name	Description
Image	image	Source image
Int	x	Image X coordinate of the sub-image to extract
Int	y	Image Y coordinate of the sub-image to extract
Int	w	Width of the sub-image to extract
Int	h	Height of the sub-image to extract

Returns

Type	Description
Image	Sub-image

importImage

Import an image

See also:

Declaration

material.importImage(filename) -> material.Image

Parameters

Type	Name	Description
FilePath	filename	Filename of the image to import

Returns

Type	Description
Image	Identifier of the imported image

invertImageColor

Inverts the color of all image pixels

See also:

Declaration

material.invertImageColor(image)

Parameters

Type	Name	Description
Image	image	Image to invert

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.

See also:

Declaration

material.overrideImageFormat(image, layout, type) -> core.Boolean

Parameters

Type	Name	Description
Image	image	Image for format must be overridden
ImageLayout	layout	New layout (keep the original one if set to Undefined)
ImageComponentType	type	New component type (keep the original one if set to Undefined)

Returns

Type	Description
Boolean	True in case of success, False otherwise

resizeImage

Resize an image

See also:

Declaration

material.resizeImage(image, width, height, filteringMethod=0)

Parameters

Type	Name	Description
Image	image	Image to be resize
Int	width	New image width
Int	height	New image height
ResizeFilterMethod	filteringMethod	Filtering method for image resizing

rotateImage

Applies a rotation to (the sub-part of) an image

See also:

Declaration

material.rotateImage(image, angle, cx, cy, edgeFilter=0, adjustSize=False)

Parameters

Type	Name	Description
Image	image	Image to process
Double	angle	Rotation angle (in degrees)
Double	cx	X coordinate of the transformation center
Double	cy	Y coordinate of the transformation center
EdgeFilter	edgeFilter	Method to use for the management of boundary pixels
Boolean	adjustSize	Adjust the dimensions of the image to fit the transformation.

setImageRoI

Defines the region of interest of an image

See also:

Declaration

material.setImageRoI(image, x, y, w, h)

Parameters

Type	Name	Description
Image	image	Image to process
Int	x	X coordinate of the RoI origin
Int	y	Y coordinate of the RoI origin
Int	w	Width of the RoI
Int	h	Height of the RoI

setSubImage

Replaces a part of a given image by another one

See also:

Declaration

material.setSubImage(destination, subImage, x, y, edgeFilter=0)

Parameters

Type	Name	Description
Image	destination	Destination image
Image	subImage	Source image
Int	x	X coordinate where to copy sub-image
Int	y	Y coordinate where to copy sub-image
EdgeFilter	edgeFilter	Method to use for the management of boundary pixels

stretchImage

Applies a non-uniform scale to (the sub-part of) an image

See also:

Declaration

material.stretchImage(image, sx, sy, cx, cy, edgeFilter=0, adjustSize=False)

Parameters

Type	Name	Description
Image	image	Image to process
Double	sx	Scale factor along X axis
Double	sy	Scale factor along Y axis
Double	cx	X coordinate of the transformation center
Double	cy	Y coordinate of the transformation center
EdgeFilter	edgeFilter	Method to use for the management of boundary pixels
Boolean	adjustSize	Adjust the dimensions of the image to fit the transformation.

transformImage

Applies a transformation matrix to (the sub-part of) an image

See also:

Declaration

material.transformImage(image, matrix, edgeFilter=0, adjustSize=False)

Parameters

Type	Name	Description
Image	image	Image to process
Matrix3	matrix	Transformation matrix
EdgeFilter	edgeFilter	Method to use for the management of boundary pixels
Boolean	adjustSize	Adjust the dimensions of the image to fit the transformation.

translateImage

Applies a translation to (the sub-part of) an image

See also:

Declaration

material.translateImage(image, tx, ty, edgeFilter=0, adjustSize=False)

Parameters

Type	Name	Description
Image	image	Image to process
Double	tx	X translation
Double	ty	Y translation
EdgeFilter	edgeFilter	Method to use for the management of boundary pixels
Boolean	adjustSize	Adjust the dimensions of the image to fit the transformation.

updateImageFromDefinition

Update an image from its raw data

See also:

Declaration

material.updateImageFromDefinition(image, imageDefinition)

Parameters

Type	Name	Description
Image	image	The image to update
ImageDefinition	imageDefinition	The new data to apply

updateImagesFromDefinitions

Update images from their raw data

See also:

Declaration

material.updateImagesFromDefinitions(image, imageDefinitions)

Parameters

Type	Name	Description
ImageList	image	The image to update
ImageDefinitionList	imageDefinitions	The new data to apply

getMaterialUserData

Set or replace a userdata stored on an material

See also:

Declaration

material.getMaterialUserData(userDataId, material) -> core.Ptr

Parameters

Type	Name	Description
MaterialUserData	userDataId	UserData identifier provided by subscribeToMaterialUserData
Material	material	Material that store the user data

Returns

Type	Description
Ptr	User data stored in the given material

getMultipleMaterialUserData

Batch version of getMaterialUserData

See also:

Declaration

material.getMultipleMaterialUserData(userDataId, materials) -> core.PtrList

Parameters

Type	Name	Description
MaterialUserData	userDataId	UserData identifier provided by subscribeToMaterialUserData
MaterialList	materials	Materials that store the user data

Returns

Type	Description
PtrList	User data stored for each given material

hasMaterialUserData

Set or replace a userdata stored on an material

See also:

Declaration

material.hasMaterialUserData(userDataId, material) -> core.Bool

Parameters

Type	Name	Description
MaterialUserData	userDataId	UserData identifier provided by subscribeToMaterialUserData
Material	material	Material that potentially store the user data

Returns

Type	Description
Bool	Returns true if a userdata is stored on this material for the given userDataId

hasMultipleMaterialUserData

Batch version of hasMaterialUserData

See also:

Declaration

material.hasMultipleMaterialUserData(userDataId, materials) -> core.BoolList

Parameters

Type	Name	Description
MaterialUserData	userDataId	UserData identifier provided by subscribeToMaterialUserData
MaterialList	materials	Materials that potentially store the user data

Returns

Type	Description
BoolList	Returns an array of bool that are true if a userdata is stored on the material at the same index for the given userDataId

setMaterialUserData

Set or replace a userdata stored on an material

See also:

Declaration

material.setMaterialUserData(userDataId, material, userData)

Parameters

Type	Name	Description
MaterialUserData	userDataId	UserData identifier provided by subscribeToMaterialUserData
Material	material	Material that will store the user data
Ptr	userData	User data to store in the given material

setMultipleMaterialUserData

Batch version of setMaterialUserData

See also:

Declaration

material.setMultipleMaterialUserData(userDataId, materials, userDataList)

Parameters

Type	Name	Description
MaterialUserData	userDataId	UserData identifier provided by subscribeToMaterialUserData
MaterialList	materials	Materials that will store the user data
PtrList	userDataList	User data to store on each material

subscribeToMaterialUserData

subscribe to material user data. multiple different userdata can be stored on the same materials if subscribeToMaterialUserData is called multiple times

See also:

Declaration

material.subscribeToMaterialUserData() -> material.MaterialUserData

Returns

Type	Description
MaterialUserData	UserData identifier to pass to setUserData/getUserData functions

unsetMaterialUserData

Unset the userdata stored on an material

See also:

Declaration

material.unsetMaterialUserData(userDataId, material)

Parameters

Type	Name	Description
MaterialUserData	userDataId	UserData identifier provided by subscribeToMaterialUserData
Material	material	Material that will store the user data

unsetMultipleMaterialUserData

Batch version of unsetMaterialUserData

See also:

Declaration

material.unsetMultipleMaterialUserData(userDataId, materials)

Parameters

Type	Name	Description
MaterialUserData	userDataId	UserData identifier provided by subscribeToMaterialUserData
MaterialList	materials	Materials that will store the user data

unsubscribeFromMaterialUserData

See also:

Declaration

material.unsubscribeFromMaterialUserData(userDataId)

Parameters

Type	Name	Description
MaterialUserData	userDataId	UserData identifier to unsubscribe

ImageChanged

Declaration

def onImageChanged(type, image):
    pass

id = material.addImageChangedCallback(onImageChanged)

...

material.removeImageChangedCallback(id)

Parameters

Type	Name	Description
ImageChangeType	type	Type of image change
Image	image	Image changed

MaterialChanged

Declaration

def onMaterialChanged(type, material):
    pass

id = material.addMaterialChangedCallback(onMaterialChanged)

...

material.removeMaterialChangedCallback(id)

Parameters

Type	Name	Description
MaterialChangeType	type	Type of material change
Material	material	Material changed