Radeon ProRender

rifImageFilterClearParameterImage

Used to clear the image parameter with the specified name. Cannot be used to clear input/output images.

rif_int rifImageFilterClearParameterImage( rif_image_filter image_filter,
  rif_char const * name);

Parameters

Parameter Input/Output Description
image_filter Input A valid rif_image_filter object.
name Input The name of the filter parameter for which the value will be set to null.

Return

Returns RIF_SUCCESS if the function is executed successfully, or RIF_ERROR code if a problem is encountered.

Errors

Possible error codes:

  • RIF_ERROR_INVALID_FILTER — image_filter is not a valid image filter object.
  • RIF_ERROR_INVALID_FILTER_ARGUMENT_NAME — parameter with the specified is not associated with this type of filter.