Class: TR8G8B8Image

Declaration: GraphicImage.h

Taxonomy Categories:

Member Functions:

TR8G8B8Image
~TR8G8B8Image
operator=
operator>>=
operator<<=
CreateGrafDevice
GetSourceOrigin

Interface Category:

API.

Inherits From:

TModifiableImage

Inherited By:

None.

Purpose:

TR8G8B8Image is a concrete 8-bit RGB image. Each pixel of this image is specified with 24 bits. These 24 bits are divided into three 8-bit components: red, green, and blue. The red, green, and blue components form a coordinate in an RGB space. To derive an XYZcolor from this RGB triplet, use the TColorProfile of the Image.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TR8G8B8Image::TR8G8B8Image

TR8G8B8Image ()
TR8G8B8Image (const TImage &)
TR8G8B8Image (const TR8G8B8Image &)
TR8G8B8Image (const TGPoint & dstOrigin, long widthInPixels, long heightInPixels, TGPoint dpi =TGImage :: k72DPI, TGrafBundle * adoptBundle =NIL, TGImage :: EOrientation orientation =TGImage :: kIdentity, const TColorProfile & theProfile =* TColorProfile :: GetDefaultColorProfile (), const TGPoint & sourceOrigin =TGPoint ( 0, 0 ))
TR8G8B8Image (const TGPoint & dstOrigin, const TGPoint & imageSizeInWorldSpace, TGPoint dpi =TGImage :: k72DPI, TGrafBundle * adoptBundle =NIL, TGImage :: EOrientation orientation =TGImage :: kIdentity, const TColorProfile & theProfile =* TColorProfile :: GetDefaultColorProfile (), const TGPoint & sourceOrigin =TGPoint ( 0, 0 ))

Interface Category:

API.

Purpose:

Default constructor.
Creates a TR8G8B8Image from another type of image.
Copy constructor.
Creates a TR8G8B8Image initialized with the given parameters.
Creates a TR8G8B8Image initialized with the given parameters.

Calling Context:

Called by the stream-in operators.
Call to create a TR8G8B8Image from another type of image.
Called to copy an object.
Call to create a new TR8G8B8Image.
Call to create a new TR8G8B8Image.

Parameters:

Takes no parameters.
const TImage & -The image from which to construct the TR8G8B8Image.
const TR8G8B8Image & -The image to be copied.
const TGPoint & dstOrigin -The origin of the image in world space.
long widthInPixels -The width of the image measured in pixels.
long heightInPixels -The height of the image measured in pixels.
TGPoint dpi =TGImage :: k72DPI -The vertical and horizontal resolution of the image. The default value for both axes is 72 dpi.
TGrafBundle * adoptBundle =NIL -The initial attribute bundle for the image. The default value is NIL.
TGImage :: EOrientation orientation =TGImage :: kIdentity -The initial orientation for the image. The default value is kIdentity; the orientation of the image as stored in memory.
const TColorProfile & theProfile =* TColorProfile :: GetDefaultColorProfile () -The color profile for the image.
const TGPoint & sourceOrigin =TGPoint ( 0 , 0 ) -The offscreen origin for the image.
const TGPoint & dstOrigin -The origin of the image in world space.
const TGPoint & imageSizeInWorldSpace -The height and width of the image in world space.
TGPoint dpi =TGImage :: k72DPI -The vertical and horizontal resolution of the image. The default value for both axes is 72 dpi.
TGrafBundle * adoptBundle =NIL -The initial attribute bundle for the image. The default value is NIL.
TGImage :: EOrientation orientation =TGImage :: kIdentity -The initial orientation for the image. The default value is kIdentity; the orientation of the image as stored in memory.
const TColorProfile & theProfile =* TColorProfile :: GetDefaultColorProfile () -The color profile for the image.
const TGPoint & sourceOrigin =TGPoint ( 0 , 0 ) -The offscreen origin for the image.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TR8G8B8Image::~TR8G8B8Image

virtual ~ TR8G8B8Image ()

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: TR8G8B8Image::operator=

TR8G8B8Image & operator =(const TR8G8B8Image & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TR8G8B8Image & source -The image 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: TR8G8B8Image::operator>>=

virtual TStream & operator >>=(TStream & ) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream to which the object streams itself out.

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: TR8G8B8Image::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream from which the object streams itself in.

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: TR8G8B8Image::CreateGrafDevice

virtual TGrafDevice * CreateGrafDevice ()

Interface Category:

API.

Purpose:

Creates a new rendering pipeline device for an image object.

Calling Context:

Called when no graphics device has been defined for the object.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to a new graphics device.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TR8G8B8Image::GetSourceOrigin

virtual TGPoint GetSourceOrigin () const

Interface Category:

API.

Purpose:

Returns the defined origin for the source image of a given object.

Calling Context:

Called when the user needs to determine the origin of the source image.

Parameters:

Takes no parameters.

Return Value:

Returns the coordinate which corresponds to the location of the origin of the source image (in pixel space).

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.