Class: TRGBSrcInTransferMode

Declaration: RGBTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

TRGBSrcInTransferMode is a concrete class, derived from TTransferMode, for applying the source inside compositing operation using the RGB color space. (The source and destination colors need not be TRGBColors, and the resulting color is converted from RGB to the specified color space.) 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 RGB 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: TRGBSrcInTransferMode::TRGBSrcInTransferMode

TRGBSrcInTransferMode ()
TRGBSrcInTransferMode (const TRGBSrcInTransferMode &)

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

virtual ~ TRGBSrcInTransferMode ()

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

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

Interface Category:

API.

Purpose:

If either the source or destination color is completely transparent, replaces the destination color with a completely transparent (alpha =0.0) white color. Otherwise, the destination color is replaced by the source color, with the resulting color's transparency component set to the product of the source's and destination's transparency components. All parameters are passed as TColor objects.

Calling Context:

Call this function directly.

Parameters:

const TColor & sourceColor -The source color to put in the destination.
const TColor & destColor -The destination color to modify.
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: TRGBSrcInTransferMode::GetSrcInResult

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

Interface Category:

API.

Purpose:

Calling Context:

Call this function directly.

Parameters:

const TRGBColor & sourceColor -The source color to put in 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: TRGBSrcInTransferMode::operator=

TRGBSrcInTransferMode & operator =(const TRGBSrcInTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TRGBSrcInTransferMode & 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: TRGBSrcInTransferMode::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: TRGBSrcInTransferMode::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: TRGBSrcInTransferMode::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 kRGBSrcInTransferMode.

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.