IImageSamplingControl

IImageSamplingControl lets you specify a filtering method to control the appearance of the rendered image when it has been interpolated or decimated. IImageSamplingControl lets you specify a filtering method to control the appearance of the rendered image when it has been interpolated or decimated.


IImageSamplingControl - Member Functions and Data by Group

Constructors & Destructor

Use the constructors in this group to construct an object of class IImageSamplingControl.


[view class]
~IImageSamplingControl
public:
~IImageSamplingControl()

Destructs an object of class IImageSamplingControl.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IImageSamplingControl
Constructs an object of class IImageSamplingControl.


Overload 1
Copy constructor.
public:
IImageSamplingControl(const IImageSamplingControl&)

IImageSamplingControl
A constant reference to the sampling control to copy from.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
Constructor takes an enumerated type ESamplingMode.
public:
IImageSamplingControl(ESamplingMode mode)

mode
The sampling control mode to set.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 3
Constructor with default mode of color-on-color.
public:
IImageSamplingControl()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Assignment Operator

Use the operator in this group to assign the given image sampling control to the target one.


[view class]
operator =
public:
IImageSamplingControl& operator =( const IImageSamplingControl& )
Assignment operator.

IImageSamplingControl
A constant reference to the sampling control mode to copy from.

Return
A non-const reference to the left-hand side object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Comparing Two Objects for Equality or Inequality

Use the operators in this group to compare two IImageSamplingControl objects for equality.


[view class]
operator !=
public:
virtual bool operator !=( const IImageSamplingControl& ) const
Tests two IImageSamplingControl objects for inequality.

IImageSamplingControl
A constant reference to the IImageSamplingControl to be compared with.

Return
True if the two IImageSamplingControl objects have different types.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator ==
public:
virtual bool operator ==( const IImageSamplingControl& ) const
Tests two IImageSamplingControl objects for equality.

IImageSamplingControl
A constant reference to the IImageSamplingControl to be compared with.

Return
True if the two IImageSamplingControl objects are the same type.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Obtaining the Control Mode Type

Use the function in this group to obtain the sampling control mode.


[view class]
mode
public:
IImageSamplingControl::ESamplingMode mode() const
Returns the enumerated type of the sampling control mode.

Return
The enumberated type.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Streaming an Object In and Out

Use the functions in this group to read a sampling control mode object in from the specified stream or write it out to it.


[view class]
readFromStream
protected:
virtual void readFromStream(IDataStream& toWhere)
Reads the IImageSamplingControl object in from the specified stream.

fromWhere
The stream that is used to read in the object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
writeToStream
protected:
virtual void writeToStream(IDataStream& toWhere) const
Writes the IImageSamplingControl object out to the specified stream.

toWhere
The stream that the object is written out to.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IImageSamplingControl - Enumerations


[view class]
ESamplingMode
enum ESamplingMode { kBlackOnWhite, 
                     kWhiteOnBlack, 
                     kColorOnColor, 
                     kHalfTone }
Describes a set of supported image sampling control modes.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IImageSamplingControl - Inherited Member Functions and Data

Inherited Public Functions

IMStreamable

Inherited Public Data

Inherited Protected Functions

IMStreamable

Inherited Protected Data