PImageFilter Class Reference

Detailed Description

The PImageFilter class represents an image filter.

To create a PImageFilter, use the Create() factory. To find out what image filters are available look at Image Filter (PImageFilter).

Definition at line 34 of file PImageFilter.h.

#include <PImageFilter.h>

Constructor & Destructor Documentation

PImageFilter() [1/2]

PImageFilter::PImageFilter

(

)

Constructs an empty image filter; use PImageFilter::Create() factory to instantiate an image filter.

PImageFilter() [2/2]

PImageFilter::PImageFilter

(

const PImageFilter &

other

)

Constructs a shared copy of other.

~PImageFilter()

virtual PImageFilter::~PImageFilter ( )

virtual

Destroys this object.

Member Function Documentation

Apply() [1/2]

PResult PImageFilter::Apply	(	const PImage &	source,
		PImage &	destination
	)

Applies this filter on the specified source image and puts the resulting image into destination.

Returns PResult::C_OK if success, another result otherwise.

Apply() [2/2]

PResult PImageFilter::Apply

(

PFrame &

frame

)

Applies this filter on the specified frame.

If success, the image stored in this frame is modified. Returns PResult::C_OK if success, another result otherwise.

Create() [1/2]

static PResult PImageFilter::Create ( const PString &  productName, const PProperties &  parameters, PImageFilter &  imageFilter  )

static

Creates an image filter from the specified plugin and parameters.

Returns PResult::C_OK if success, another result otherwise.

Create() [2/2]

static PResult PImageFilter::Create ( const PPlugin &  plugin, const PProperties &  parameters, PImageFilter &  imageFilter  )

static

Factory: creates an image filter from the specified plugin and parameters.

Returns PResult::C_OK if success, another result otherwise.

operator=()

PImageFilter& PImageFilter::operator=

(

const PImageFilter &

other

)

Performs a shared copy of other to this object.