Class: TRGBDstOutTransferMode

Declaration: RGBTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

TRGBDstOutTransferMode is a concrete class, derived from TTransferMode, for applying the destination outside 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 destination outside operation contains only the destination pixels that are outside the source area. If the source color is completely transparent (alpha

0.0), the resultant color is determined by the destination. If the source is completely opaque (alpha =1.0) or the destination is completely transparent, the resulting color is a completely transparent white. Otherwise, the resultant RGB value is determined by the destination color only, and the resultant transparency is a combination 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: TRGBDstOutTransferMode::TRGBDstOutTransferMode

TRGBDstOutTransferMode ()
TRGBDstOutTransferMode (const TRGBDstOutTransferMode &)

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

virtual ~ TRGBDstOutTransferMode ()

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

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

Interface Category:

API.

Purpose:

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

Calling Context:

Call this function directly.

Parameters:

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

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBDstOutTransferMode::GetDstOutResult

static void GetDstOutResult (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 be modified.
const TRGBColor & destColor -The destination color to apply outside the source color.
TRGBColor & resultingColor -The resulting, modified source color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBDstOutTransferMode::operator=

TRGBDstOutTransferMode & operator =(const TRGBDstOutTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TRGBDstOutTransferMode & 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: TRGBDstOutTransferMode::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: TRGBDstOutTransferMode::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: TRGBDstOutTransferMode::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 kRGBDstOutTransferMode.

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.