Class: TGraySrcInTransferMode

Declaration: GrayTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

TGraySrcInTransferMode is a concrete class, derived from TTransferMode, for applying the source inside compositing operation using a grayscale. (The source and destination colors need not be grayscale, but the resulting color is always a gray.) The result of the source inside operation contains only the source pixels that are inside the destination area. If either the source or the original destination color is completely transparent (alpha =0.0), this transfer mode sets the resulting color to a completely transparent white. Otherwise the resultant gray value is determined by the source color only, and the resultant transparency is the product of the source's and destination's transparency values.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGraySrcInTransferMode::TGraySrcInTransferMode

TGraySrcInTransferMode ()
TGraySrcInTransferMode (const TGraySrcInTransferMode &)

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

virtual ~ TGraySrcInTransferMode ()

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

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

Interface Category:

API.

Purpose:

Replaces the destination color with the source color, taking into account the transparency information of the destination color. If either the source or the original destination color is completely transparent (alpha =0.0), this transfer mode sets the resulting color to a completely transparent white. Otherwise the resultant gray value is determined by the source color only, and the resultant transparency is the product of the source's and destination's transparency values. The resulting grayscale color is returned in a TColor object.

Calling Context:

Call this function directly.

Parameters:

const TColor & sourceColor -The source color to use.
const TColor & destColor -The color to be converted.
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: TGraySrcInTransferMode::GetSrcInResult

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

Interface Category:

API.

Purpose:

Calling Context:

Call this function directly.

Parameters:

const TGrayColor & sourceColor -The source color to use.
const TGrayColor & destColor -The destination color to convert.
TGrayColor & resultingColor -The resulting grayscale color, returned as a TGrayColor object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGraySrcInTransferMode::operator=

TGraySrcInTransferMode & operator =(const TGraySrcInTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TGraySrcInTransferMode & 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: TGraySrcInTransferMode::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: TGraySrcInTransferMode::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: TGraySrcInTransferMode::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 kGraySrcInTransferMode.

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.