NiXPSObjects::NOImage Class Reference

#include "NOImage.h"

List of all members.

Public Member Functions
const NCommon::UTF8String	getFileName ()
NCommon::Image::Format	getFormat ()
void	writeImageToFile (const NCommon::UTF8String &destinationPath)
bool	getImageData (NCommon::UInt8 *pBuffer, NCommon::UInt32 pSize)
NCommon::UInt32	getImageSize () const
NCommon::UInt32	getWidthInPixels () const
NCommon::UInt32	getHeightInPixels () const
double	getXResolution () const
double	getYResolution () const
NCommon::Image::ColorType	getColorType () const
NCommon::Image::BitDepth	getBitDepth () const

---

Detailed Description

Class representing an image in an XPS package

Examples:

docexample_extractimage.cpp.

---

Member Function Documentation

const NCommon::UTF8String NOImage::getFileName

(

)

Returns the filename of the image. By default returns the base name in the XPS package.

NCommon::Image::Format NOImage::getFormat

(

)

Returns the image Format.

void NOImage::writeImageToFile

(

const NCommon::UTF8String &

destinationPath

)

Write the image to the path destinationPath. Overwrites if file already exists.

Parameters:

destinationPath

UTF-8 encoded string describing the path to write the file to. The path is seperated by forward slashes ('/').

Examples:

docexample_extractimage.cpp.

bool NOImage::getImageData	(	NCommon::UInt8 *	pBuffer,
		NCommon::UInt32	pSize
	)

Fill a buffer with the image data

Parameters:

	pBuffer	The buffer that will contain the image data upon successful completion
	pSize	The size of the buffer. This operation will fail if the size of the buffer is smaller than the image size returned by getImageSize()

Returns:

True upon successful completion, false otherwise

NCommon::UInt32 NOImage::getImageSize

(

)

const

Returns the size of the image in bytes (UInt8's).

NCommon::UInt32 NOImage::getWidthInPixels

(

)

const

Returns the width of the image in pixels.

NCommon::UInt32 NOImage::getHeightInPixels

(

)

const

Returns the height of the image in pixels.

double NOImage::getXResolution

(

)

const

Returns resolution of the image in the X direction.

double NOImage::getYResolution

(

)

const

Returns resolution of the image in the Y direction.

Image::ColorType NOImage::getColorType

(

)

const

Returns the colortype of the image.

Image::BitDepth NOImage::getBitDepth

(

)

const

Returns the bitdepth of the image.

---

The documentation for this class was generated from the following files:

• NOImage.h
• NOImage.cpp

---