register_ink_effect_image method

register_ink_effect_image

Registers an image to collection of custom images used to simulate visual effects for ink brushes. These images are used when rendering ink with specific InkEffectType values, such as Galaxy, Rainbow, etc. By providing your own images, you can control how each ink effect appears.

@staticmethod
def register_ink_effect_image(effect_type, image):
    ...
ParameterTypeDescription
effect_typeInkEffectType
imageIImage

Remarks

This method allows replacing the default ink effect textures with user-defined ones, which is particularly useful when default assets are restricted by licensing or unavailable at runtime. Each registered value pair must associate an InkEffectType value with a corresponding IImage object (e.g., Bitmap, or an Aspose image interface).

See Also

get_image method remove_placeholder method