Class: TSuppressDither

Declaration: DitherHints.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TDitherHint

Inherited By:

None.

Purpose:

Adopts a TSuppressDither object when you want to suppress dithering for all graphics arranged in a group. There might be a graphic in the group with a bundle that has adopted a dither class, but if the attribute bundle of the group adopts a TSuppressDither object, no graphics in the group are dithered when rendered.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSuppressDither::TSuppressDither

TSuppressDither (bool primary =true)
TSuppressDither (const TSuppressDither &)

Interface Category:

API.

Purpose:

Creates a primary or secondary suppress dither hint.
Copy constructor.

Calling Context:

Call to create a primary or secondary suppress dither hint.
Called to copy an object.

Parameters:

bool primary =true -The flag indicating whether the new dither hint is primary or secondary. The default value is true.
const TSuppressDither & -The dither hint to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSuppressDither::~TSuppressDither

virtual ~ TSuppressDither ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSuppressDither::operator=

TSuppressDither & operator =(const TSuppressDither & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSuppressDither & source -The dither hint to be copied.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSuppressDither::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & towhere -The stream to which the object streams itself out.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSuppressDither::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -The stream from which the object streams itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSuppressDither::TemporaryTypeID

virtual EDitherHintClassID TemporaryTypeID () const

Interface Category:

API.

Purpose:

Returns the type identifier for the specific dither hint class. The return value is one of the values from the enum EDitherHintClassID, defined by this class. This is a temporary replacement for the C++ language typeid operator. This function will go away in the future.

Calling Context:

Call this function instead of the C++ language typeid operator.

Parameters:

Takes no parameters.

Return Value:

kSuppressDither.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSuppressDither::GetBaseTemporaryTypeID

virtual EDitherHintClassID GetBaseTemporaryTypeID () const

Interface Category:

API.

Purpose:

Calling Context:

Call this function instead of the C++ language typeid operator.

Parameters:

Takes no parameters.

Return Value:

kSuppressDither.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.