Class: TRGBSrcOverTransferMode

Declaration: RGBTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

TRGBSrcOverTransferMode is a concrete class, derived from TTransferMode, for applying the source over compositing operation using the RGB color space. Source over places the source image on top of the destination. (The source and destination colors need not be RGB, and the resulting color is converted from RGB to the specified color space.) If the source color is completely opaque (that is, if its alpha value is 1.0), this transfer mode copies the RGB equivalent of the source color to the destination. If the source color is completely transparent (alpha =0.0), the destination is unchanged. If the source's alpha value is between 0 and 1, the resultant RGB values and transparency are computed by taking into account 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: TRGBSrcOverTransferMode::TRGBSrcOverTransferMode

TRGBSrcOverTransferMode ()
TRGBSrcOverTransferMode (const TRGBSrcOverTransferMode &)

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

virtual ~ TRGBSrcOverTransferMode ()

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

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

Interface Category:

API.

Purpose:

If the source color is completely opaque (that is, if its alpha value is 1.0), copies the RGB equivalent of the source color to the destination. If the source color is completely transparent (alpha =0.0), the destination is unchanged. If the source's alpha value is between 0 and 1, the resultant RGB and transparency components are computed by adding the appropriate amount of red, green, and blue components of the source color to the destination components. All parameters are passed as TColor objects.

Calling Context:

Call this function directly.

Parameters:

const TColor & sourceColor -The source color to apply over the destination.
const TColor & destColor -The destination color to be modified.
TColor & resultingColor -The resulting, modified destination color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBSrcOverTransferMode::GetSrcOverResult

void GetSrcOverResult (const TRGBColor & sourceColor, const TRGBColor & destColor, TRGBColor & resultingColor) const

Interface Category:

API.

Purpose:

If the source color is completely opaque (that is, if its alpha value is 1.0), copies the source color to the destination. If the source color is completely transparent (alpha =0.0), the destination is unchanged. If the source's alpha value is between 0 and 1, the resultant RGB and transparency components are computed by adding the appropriate amount of red, green, blue, and transparency components of the source color to the destination components. All parameters are passed as TRGBColor objects.

Calling Context:

Call this function directly.

Parameters:

const TRGBColor & sourceColor -The source color to apply over the destination.
const TRGBColor & destColor -The destination color to modify.
TRGBColor & resultingColor -The resulting, modified destination color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBSrcOverTransferMode::operator=

TRGBSrcOverTransferMode & operator =(const TRGBSrcOverTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TRGBSrcOverTransferMode & 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: TRGBSrcOverTransferMode::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: TRGBSrcOverTransferMode::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: TRGBSrcOverTransferMode::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 kRGBSrcOverTransferMode.

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.