Class: TGraySrcAtopTransferMode

Declaration: GrayTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

TGraySrcAtopTransferMode is a concrete class, derived from TTransferMode, for applying the source atop compositing operation using a grayscale. (The source and destination colors need not be grayscale, but the resulting color is always a gray.) In the source atop transfer mode, the source is placed over the destination, but only where the destination is not completely transparent. If the source color is completely transparent (alpha =0.0), the resultant color is determined completely by the destination. Otherwise, the resultant transparency value is determined by the destination only, and the resultant gray value is determined by both the source and the destination.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGraySrcAtopTransferMode::TGraySrcAtopTransferMode

TGraySrcAtopTransferMode ()
TGraySrcAtopTransferMode (const TGraySrcAtopTransferMode &)

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

virtual ~ TGraySrcAtopTransferMode ()

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

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

Interface Category:

API.

Purpose:

Places the source color over the destination, but only where the destination is not completely transparent. If the source color is completely transparent (alpha =0.0), the resultant color is determined completely by the destination. Otherwise, the resultant transparency value is determined by the destination only, and the resultant gray value is determined by both the source and the destination. The resultant gray scale color is returned in a TColor object.

Calling Context:

Call this function directly.

Parameters:

const TColor & sourceColor -The source color to modify.
const TColor & destColor -The destination color to replace.
TColor & resultingColor -The resultant 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: TGraySrcAtopTransferMode::GetSrcAtopResult

static void GetSrcAtopResult (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 modify.
const TGrayColor & destColor -The destination color to replace.
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: TGraySrcAtopTransferMode::operator=

TGraySrcAtopTransferMode & operator =(const TGraySrcAtopTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TGraySrcAtopTransferMode & 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: TGraySrcAtopTransferMode::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: TGraySrcAtopTransferMode::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: TGraySrcAtopTransferMode::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 kGraySrcAtopTransferMode.

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.