Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TDitherHint
Inherited By:
None.
Purpose:
Adopt a TNoiseDither object when you want to add a random amount of noise to the rendered graphic. The noise dither changes the pixel value by a random value. When constructing a TNoiseDither object, specify the maximum value by which any pixel can be changed. This maximum value is known as the amplitude. Use this class to get a noisy or mezzotint-looking dither.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
None.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
- TNoiseDither (bool primary =true)
- TNoiseDither (GCoordinate ditherAmplitude, bool primary =true)
- TNoiseDither (const TNoiseDither &)
Interface Category:
API.
Purpose:
- Creates a primary or secondary noise dither hint.
- Creates a noise dither with the given amplitude.
- Copy constructor.
Calling Context:
- Call to create a primary or secondary noise dither hint.
- Call to create a noise dither given an amplitude.
- 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.
- GCoordinate ditherAmplitude -The amplitude of the noise dither.
- bool primary =true -The flag indicating whether the new dither hint is primary or secondary. The default value is true.
- const TNoiseDither & -The dither hint to be copied.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TNoiseDither ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TNoiseDither::GetDitherAmplitude
GCoordinate GetDitherAmplitude () const
Interface Category:
API.
Purpose:
Returns the amplitude of the noise dither.
Calling Context:
Call this function directly.
Parameters:
Return Value:
The amplitude of the noise dither.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TNoiseDither::operator=
TNoiseDither & operator =(const TNoiseDither & source)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object.
Parameters:
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: TNoiseDither::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: TNoiseDither::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: TNoiseDither::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:
Return Value:
Returns kNoiseDither.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TNoiseDither::GetBaseTemporaryTypeID
virtual EDitherHintClassID GetBaseTemporaryTypeID () 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:
Return Value:
Returns kNoiseDither.
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.
Copyright©1995 Taligent,Inc. All rights reserved.