API:DynamicImageClearCustomShader

UI Lua API · DynamicImage functions
Version: WAR 1.4.8

Meant to remove a custom shader from a DynamicImage. In the current client it only checks its argument and does nothing else.

DynamicImageClearCustomShader(imageName)

Arguments

imageName

string – Name of a DynamicImage window.

Returns

Nothing.

Details

• The client looks up the window and checks that it is a DynamicImage. After that the function returns without changing anything.
• DynamicImageSetCustomShader does not set a shader either, so there is nothing to clear.
• The error messages name DynamicImageSetRotation, not this function.
• The function needs at least one argument and only reads the last one.
• The stock UI never calls DynamicImageClearCustomShader.

Errors

These are written to the UI log; the call returns normally.

• Error in function call 'DynamicImageSetRotation': Window %s does not exist
• Error in function call 'DynamicImageSetRotation': Window %s is not a DynamicImage

Example

A minimal example built from the signature above:

DynamicImageClearCustomShader( "MyImage" )

See also

• DynamicImageSetCustomShader