Class: TGrayInvertSrcTransferMode

Declaration: GrayTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSrcActiveTransferMode

Inherited By:

None.

Purpose:

TGrayInvertSrcTransferMode is a concrete class, derived from TSrcActiveTransferMode, for inverting a grayscale color. This transfer mode determines the source color's grayscale color, subtracts it from 1.0, and replaces the destination with it. This transfer mode is useful when you want to invert an image or graphic (such as a button) without having to store a second image or graphic.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGrayInvertSrcTransferMode::TGrayInvertSrcTransferMode

TGrayInvertSrcTransferMode ()
TGrayInvertSrcTransferMode (const TGrayInvertSrcTransferMode &)

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 TGrayInvertSrcTransferMode & -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: TGrayInvertSrcTransferMode::~TGrayInvertSrcTransferMode

virtual ~ TGrayInvertSrcTransferMode ()

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

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

Interface Category:

API.

Purpose:

Converts a source color into the corresponding inverted gray scale color. First the source color is converted to grayscale, and then it is subtracted from 1.0 to give the inverted color. The destColor variable is ignored.
Converts a source color into the corresponding inverted gray scale color. First the source color is converted to grayscale, and then it is subtracted from 1.0 to give the inverted color.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TColor & sourceColor -The color to be converted.
const TColor & destColor -Ignored by this function.
TColor & resultingColor -The resulting, inverted grayscale color.
const TColor & sourceColor -The color to be converted.
TColor & resultingColor -The resulting, inverted grayscale color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrayInvertSrcTransferMode::GetInvertSrcResult

static void GetInvertSrcResult (const TGrayColor & sourceColor, TGrayColor & resultingColor)

Interface Category:

API.

Purpose:

Converts a source color into the corresponding inverted gray scale color. First the source color is converted to grayscale, and then it is subtracted from 1.0 to give the inverted color. The result is returned in a TGrayColor object.

Calling Context:

Call this function directly.

Parameters:

const TGrayColor & sourceColor -The color to be converted.
TGrayColor & resultingColor -The resulting, inverted grayscale color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrayInvertSrcTransferMode::operator=

TGrayInvertSrcTransferMode & operator =(const TGrayInvertSrcTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TGrayInvertSrcTransferMode & 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: TGrayInvertSrcTransferMode::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: TGrayInvertSrcTransferMode::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: TGrayInvertSrcTransferMode::TemporaryTypeID

virtual ETransferModeClassID TemporaryTypeID () const

Interface Category:

API.

Purpose:

Returns the type of TransferMode this class represents.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an ETransferModeClassID with value kGrayInvertSrcTransferMode.

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.