Mako 8.1.0 API
Loading...
Searching...
No Matches
IDOMImageDownsamplerFilter Class Reference

An image filter that presents a downsampled version of an image. More...

#include <idomimageresource.h>

Inherits IDOMImageFilter.

Classes

class  Data
 Initialization data. More...
 

Public Types

enum  eDownsamplingMethod
 The type of downsampling to be performed.
 

Static Public Member Functions

static EDL_API IDOMImageDownsamplerFilterPtr create (IEDLClassFactory *pFactory, double xRes, double yRes=0.0, eDownsamplingMethod method=eSubsample, bool useFloatingPointResolution=false)
 Simplified creator for an image downsampler filter.
 
static const CClassIDclassID ()
 Retrieves class id of IDOMImageDownsamplerFilter.
 

Detailed Description

An image filter that presents a downsampled version of an image.

Member Function Documentation

◆ classID()

static const CClassID & IDOMImageDownsamplerFilter::classID ( )
inlinestatic

Retrieves class id of IDOMImageDownsamplerFilter.

Returns
CClassID Class id of the element.

◆ create()

static EDL_API IDOMImageDownsamplerFilterPtr IDOMImageDownsamplerFilter::create ( IEDLClassFactory * pFactory,
double xRes,
double yRes = 0.0,
eDownsamplingMethod method = eSubsample,
bool useFloatingPointResolution = false )
static

Simplified creator for an image downsampler filter.

Parameters
pFactoryThe EDL Class Factory.
xResThe desired x resolution of the result.
yResThe desired y resolution of the result. If 0, the x resolution will be used.
methodThe desired downsampling method to use.
useFloatingPointResolutionSet to true if you wish to always preserve the resolution in floating point form in all cases. The default is false, which, if the resolution differs from the incoming image, snaps to integer values in order to produce reliable results if the image is encoded in a format that does not support floating point resolution information.
Returns
IDOMImageDownsamplerFilterPtr The new filter.

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