ImageMix: materialID

materialID(obj, name)
  • Returns a numeric value that can be used in the Video Texture module to create a dynamic texture.

Return Type:

  • integer

obj:

  • The game object that holds the texture.
  • Type: KX_GameObject
     
name:
  • Name of the texture or material you want to make dynamic.
  • Type:  string
Note:
  • Images being mixed must be the same size (dimensions).
     
  • ImageMix sources: ImageBuff, ImageFFmpeg, ImageMirror, ImageRender, ImageViewport and VideoFFmpeg.
     
  • Material name must have MA prefix.
    Material must have an image in the first texture channel.
    If the material name is Canvas, you'd use "MACanvas"
     
  • Texture image name must have IM prefix.
    Texture image must be in the first texture channel.
    If the texture image name is Static.jpg, you'd use "IMStatic.jpg"
Sample Code

###################### get materialID

#import bge
import bge

# get current scene
scene = bge.logic.getCurrentScene()

# get list of objects in scene
objList = scene.objects

# get object named Painting
obj = objList["Painting"]

# get matID for the obj named Painting
# I named the material Canvas
matID = bge.texture.materialID(obj, "MACanvas")

# get the name of the image
# I'm using an image named Mona_Lisa.jpg
imageName_A = "Mona_Lisa.jpg"

# get image path
# Mona_Lisa.jpg is in same directory as saved blend
imagePath_A = bge.logic.expandPath('//' + imageName_A)

# get the name of the image
# I'm using an image named Vitruvian_Man.jpg
# it has the same dimensions as Mona_Lisa.jpg
imageName_B = "Vitruvian_Man.jpg"

# get image path
# Vitruvian_Man.jpg is in same directory as saved blend
imagePath_B = bge.logic.expandPath('//' + imageName_B)

# get images
image_A = bge.texture.ImageFFmpeg(imagePath_A)
image_B = bge.texture.ImageFFmpeg(imagePath_B)

# set the texture
mix = bge.texture.Texture(obj, matID)

# get the texture image
mix.source = bge.texture.ImageMix()

# set the source for the image mix
mix.source.setSource("Mix1", image_A)
mix.source.setSource("Mix2", image_B)

# set the image weight for Mix1 and Mix2
# weights should add up to 256

mix.source.setWeight("Mix1", 100)
mix.source.setWeight("Mix2", 156)

# save mix as an object variable
obj["Mix"] = mix

# update the image
mix.refresh(True)