Class: TGrayMultiplyTransferMode

Declaration: GrayTransferModes.h

Taxonomy Categories:

Member Functions:

TGrayMultiplyTransferMode
~TGrayMultiplyTransferMode
GetResultingColor
GetMultiplyResult
operator=
operator>>=
operator<<=
TemporaryTypeID

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

TGrayMultiplyTransferMode is a concrete class, derived from TTransferMode, that combines the grayscale equivalent of two colors using multiplication. (The source and destination colors need not be grayscale, but the resulting color is always a gray.) The resultant color's grayscale value is the product of the source's and destination's grayscale values. The transparency values are similarly multiplied.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGrayMultiplyTransferMode::TGrayMultiplyTransferMode

TGrayMultiplyTransferMode ()
TGrayMultiplyTransferMode (const TGrayMultiplyTransferMode &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators. You can also call this constructor directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TGrayMultiplyTransferMode & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrayMultiplyTransferMode::~TGrayMultiplyTransferMode

virtual ~ TGrayMultiplyTransferMode ()

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: TGrayMultiplyTransferMode::GetResultingColor

virtual void GetResultingColor (const TColor & sourceColor, const TColor & destColor, TColor & resultingColor) const

Interface Category:

API.

Purpose:

Returns a color whose components are the product of the source and destination color's grayscale values. The transparency values are similarly multiplied. All colors are specified as TColor objects.

Calling Context:

Call this function directly.

Parameters:

const TColor & sourceColor -The source color to multiply.
const TColor & destColor -The destination color to multiply.
TColor & resultingColor -The resulting grayscale color, returned in a TColor object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrayMultiplyTransferMode::GetMultiplyResult

static void GetMultiplyResult (const TGrayColor & sourceColor, const TGrayColor & destColor, TGrayColor & resultingColor)

Interface Category:

API.

Purpose:

Returns a grayscale color whose components are the product of the source's and destination's grayscale values. The transparency values are similarly multiplied. All arguments are specified as TGrayColor objects.

Calling Context:

Call this function directly.

Parameters:

const TGrayColor & sourceColor -The source color to multiply.
const TGrayColor & destColor -The destination color to multiply.
TGrayColor & resultingColor -The resultant grayscale color, returned in a TGrayColor object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrayMultiplyTransferMode::operator=

TGrayMultiplyTransferMode & operator =(const TGrayMultiplyTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TGrayMultiplyTransferMode & source -The object 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: TGrayMultiplyTransferMode::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 that the object streams itself out to.

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: TGrayMultiplyTransferMode::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 that the object streams itself in from.

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: TGrayMultiplyTransferMode::TemporaryTypeID

virtual ETransferModeClassID TemporaryTypeID () const

Interface Category:

API.

Purpose:

Returns the type of transfer mode this class represents.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an ETransferModeClassID with value kGrayMultiplyTransferMode.

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.