Class: TRGBInvertSrcTransferMode

Declaration: RGBTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSrcActiveTransferMode

Inherited By:

None.

Purpose:

TRGBInvertSrcTransferMode is a concrete class, derived from TSrcActiveTransferMode, for inverting a color in the RGB color space. This transfer mode determines the source color's red, green, and blue components, subtracts each value from 1.0, and replaces the destination with the inverted color. (The source need not be a TRGBColor, and the resulting color is converted from RGB to the specified color space.) 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: TRGBInvertSrcTransferMode::TRGBInvertSrcTransferMode

  1. TRGBInvertSrcTransferMode ()
  2. TRGBInvertSrcTransferMode (const TRGBInvertSrcTransferMode &)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Copy constructor.

Calling Context:

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

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBInvertSrcTransferMode::~TRGBInvertSrcTransferMode

virtual ~ TRGBInvertSrcTransferMode ()

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

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

Interface Category:

API.

Purpose:

  1. Converts a source color into the corresponding inverted RGB color. Each of the red, green, and blue components, as well as the alpha component, are subtracted from 1.0. The destination color is ignored. The resulting color is returned as a TColor.
  2. Converts a source color into the corresponding inverted RGB color. Each of the red, green, and blue components, as well as the alpha component, are subtracted from 1.0. The resulting color is returned as a TColor.

Calling Context:

  1. Call this function directly.
  2. Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBInvertSrcTransferMode::GetInvertSrcResult

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

Interface Category:

API.

Purpose:

Converts a source TRGBColor into the corresponding inverted RGB color. Each of the red, green, and blue components, as well as the alpha component, are subtracted from 1.0. The resulting color is returned as a TRGBColor.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBInvertSrcTransferMode::operator=

TRGBInvertSrcTransferMode & operator =(const TRGBInvertSrcTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

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: TRGBInvertSrcTransferMode::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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: TRGBInvertSrcTransferMode::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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: TRGBInvertSrcTransferMode::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:

Return Value:

Returns an ETransferModeClassID with value kRGBInvertSrcTransferMode.

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.