hdi::core::RasterArt::Record Struct Reference

Describes more detailed information about raster art. More...

#include <hdicoreRasterArt.h>

Collaboration diagram for hdi::core::RasterArt::Record:

Public Member Functions
	Record ()
	Constructs a new Record object with default values.
	Record (const Record &rec_)
	Constructs a new Record object from an existing one.
	Record (const Flags flags_, const Size &dim_, const int16_t bitsPerPx_, const int32_t rowBytes_, const ColorSpace colorSpace_, const ColorSpace origColorSpace_)
	Constructs a new Record object from the given values.
virtual	~Record ()
	Destructs a Record object.
Record &	operator= (const Record &rhs_)
	Record assignment operator.
bool	operator== (const Record &rhs_)
	Compares two Record objects for equality.
bool	operator!= (const Record &rhs_)
	Compares two Record objects for inequality.

Public Attributes
Flags	flags
	Bitwise OR of flags defining additional options for the image.
Size	dimensions
	The width and height of the image data in pixels.
int16_t	bitsPerPx
	The number of bits used to define each pixel in the pixel map.
int32_t	rowBytes
	The number of bytes in a single row of pixel data.
ColorSpace	colorSpace
	The color model of the pixel data, which can include an alpha channel.
ColorSpace	originalColorSpace
	For an image that has been converted from one color space to another, the original color space. If the image has not been converted, the value should match colorSpace.

Detailed Description

Describes more detailed information about raster art.

Constructor & Destructor Documentation

Record() [1/3]

hdi::core::RasterArt::Record::Record

(

)

Constructs a new Record object with default values.

Author

GW

Date

08/2014

Record() [2/3]

hdi::core::RasterArt::Record::Record

(

const Record &

rec_

)

Constructs a new Record object from an existing one.

Author

GW

Date

08/2014

Parameters

rec_	Existing Record object to copy values from

Record() [3/3]

hdi::core::RasterArt::Record::Record	(	const Flags	flags_,
		const Size &	dim_,
		const int16_t	bitsPerPx_,
		const int32_t	rowBytes_,
		const ColorSpace	colorSpace_,
		const ColorSpace	origColorSpace_
	)

Constructs a new Record object from the given values.

Author

GW

Date

08/2014

Parameters

flags_	Options for the raster image
dim_	Dimensions of the raster image
bitsPerPx_	Bits per pixel of the raster image
rowBytes_	Bytes per pixel row of the raster image
colorSpace_	Current color space of the raster image
origColorSpace_	Original color space of the raster image

~Record()

virtual hdi::core::RasterArt::Record::~Record ( )

virtual

Destructs a Record object.

Author

GW

Date

08/2014

Member Function Documentation

operator!=()

bool hdi::core::RasterArt::Record::operator!=

(

const Record &

rhs_

)

Compares two Record objects for inequality.

Author

GW

Date

08/2014

Parameters

rhs_	Existing Record object to compare against the target

Returns

true if the members of the two Record objects differ, false otherwise

operator=()

Record & hdi::core::RasterArt::Record::operator=

(

const Record &

rhs_

)

Record assignment operator.

Author

GW

Date

08/2014

Parameters

rhs_	Existing Record object to copy values from (righthand side of the assignment operator)

Returns

The target Record object, but with its values updated

operator==()

bool hdi::core::RasterArt::Record::operator==

(

const Record &

rhs_

)

Compares two Record objects for equality.

Author

GW

Date

08/2014

Parameters

rhs_	Existing Record object to compare against the target

Returns

true if the members of the two Record objects are the same, false otherwise

Member Data Documentation

bitsPerPx

int16_t hdi::core::RasterArt::Record::bitsPerPx

The number of bits used to define each pixel in the pixel map.

Note

Valid values depend on the color space: 1 for black and white (GrayColorSpace), 8 for grayscale (GrayColorSpace), 24 for RGB (8 bits for each color), 48 for RGB (16 bits for each color), or 32 for CMYK (8 bits for each color)

rowBytes

int32_t hdi::core::RasterArt::Record::rowBytes

The number of bytes in a single row of pixel data.

Note

Ignored for the setInfo() method.

1-bit data is packed so that there are 8 pixels per byte.

If bitsPerPx is 1 (for a black and white bitmap), the value should be dimensions.width / 8 + 1. For all other bitsPerPx values, the value of this member should be dimensions.width * (bitsPerPx / 8).