rifContextCreateImageFilter

Creates a new image filter of the specified type associated with the context.

rif_int rifContextCreateImageFilter(

rif_context context,

rif_image_filter_type type,

rif_image_filter * out_effect);

Parameters

Parameter

Input/Output

Description

context

input

A valid context object.

type

input

The filter type that defines the conversion to be performed. Each type of the filter corresponds to a set of parameters with a certain string names and certain data types.

out_effect

output

A pointer to the image filter object which will be created if the function performs successfully.

Output

A pointer to an image filter object.

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_CONTEXT - context is not a valid context object.

  • RIF_ERROR_INVALID_PARAMETER - out_effect is nullptr.

  • RIF_ERROR_UNIMPLEMENTED - a filter with type type is not implemented at the moment.

  • RIF_ERROR_UNSUPPORTED - a filter with type type is not supported.