Mako 7.3.0 API
IDOMImageColorKeyFilter Class Reference

An image filter that presents a masked image where colours within a given range are masked out, analogous to a green screen. The source image must not have a mask or alpha channel. More...

#include <idomimageresource.h>

Inherits IDOMImageFilter.

Classes

class  Data
 Initialization data. More...
 

Static Public Member Functions

static EDL_API IDOMImageColorKeyFilterPtr create (IEDLClassFactory *pFactory, const CEDLVector< uint16 > &key)
 Simplified creator for a color key scaling filter. More...
 
static const CClassIDclassID ()
 Retrieves class id of IDOMImageColorKeyFilter. More...
 

Detailed Description

An image filter that presents a masked image where colours within a given range are masked out, analogous to a green screen. The source image must not have a mask or alpha channel.

Member Function Documentation

◆ classID()

static const CClassID& IDOMImageColorKeyFilter::classID ( )
inlinestatic

Retrieves class id of IDOMImageColorKeyFilter.

Returns
CClassID Class id of the element

◆ create()

static EDL_API IDOMImageColorKeyFilterPtr IDOMImageColorKeyFilter::create ( IEDLClassFactory pFactory,
const CEDLVector< uint16 > &  key 
)
static

Simplified creator for a color key scaling filter.

Parameters
pFactoryThe EDL Class Factory
keyA vector that describes the range of colours to be masked out. In the form low1, hi1, low2, hi2, ... lowN, hiN where N is the number of color components in the source image. The values are expressed in the range of the samples in the image. For example, if the image is 4 bits per component then the values in this vector need to be between 0 and 15 inclusive.
Returns
IDOMImageColorKeyFilterPtr The new filter.

The documentation for this class was generated from the following file: