PDFix SDK  6.5.0
PsImage Struct Referenceabstract

PsImage class. More...

Public Member Functions

virtual void Destroy ()=0
 Destroys PsImage resources. More...
 
virtual bool Save (const wchar_t *path, PdfImageParams *params)=0
 Saves the image into a file. More...
 
virtual bool SaveRect (const wchar_t *path, PdfImageParams *params, PdfDevRect *dev_rect)=0
 Saves a clip of the image into a file. More...
 
virtual bool SaveToStream (PsStream *stream, PdfImageParams *params)=0
 Saves the image into a stream. More...
 
virtual bool SaveRectToStream (PsStream *stream, PdfImageParams *params, PdfDevRect *dev_rect)=0
 Saves a clip of the image into a stream. More...
 
virtual void GetPointColor (PdfDevPoint *point, PdfRGB *color)=0
 Gets a color of the image point. More...
 
virtual bool SaveDataToStream (PsStream *stream)=0
 Saves the image data in the format of an image into a stream. More...
 

Detailed Description

PsImage class.

PsImage contains an image data in an internal format.

Member Function Documentation

◆ Destroy()

virtual void PsImage::Destroy ( )
pure virtual

Destroys PsImage resources.

See also
Pdfix::CreateImage

◆ GetPointColor()

virtual void PsImage::GetPointColor ( PdfDevPoint point,
PdfRGB color 
)
pure virtual

Gets a color of the image point.

Parameters
pointA point which color is requested.
color(filledby method) RGB color of the image point.

◆ Save()

virtual bool PsImage::Save ( const wchar_t *  path,
PdfImageParams params 
)
pure virtual

Saves the image into a file.

Parameters
pathAbsolute file path where the image should be saved.
paramsPdfImageParams specifying the image format and quality.
Returns
true if succeeded, false otherwise.
See also
PdfImageFormat

◆ SaveDataToStream()

virtual bool PsImage::SaveDataToStream ( PsStream stream)
pure virtual

Saves the image data in the format of an image into a stream.

Parameters
streamPsStream where to save image data in requested format.
Returns
true if succeeded, false otherwise.

◆ SaveRect()

virtual bool PsImage::SaveRect ( const wchar_t *  path,
PdfImageParams params,
PdfDevRect dev_rect 
)
pure virtual

Saves a clip of the image into a file.

Parameters
pathAbsolute file path where the image should be saved.
paramsPdfImageParams specifying the image format and quality.
dev_rectClip area of the image that needs to be saved.
Returns
true if succeeded, false otherwise.
See also
PdfImageFormat

◆ SaveRectToStream()

virtual bool PsImage::SaveRectToStream ( PsStream stream,
PdfImageParams params,
PdfDevRect dev_rect 
)
pure virtual

Saves a clip of the image into a stream.

Parameters
streamPsStream where to save image data in requested format.
paramsPdfImageParams specifying the image format and quality.
dev_rectClip area of the image that needs to be saved.
Returns
true if succeeded, false otherwise.
See also
PdfImageFormat

◆ SaveToStream()

virtual bool PsImage::SaveToStream ( PsStream stream,
PdfImageParams params 
)
pure virtual

Saves the image into a stream.

Parameters
streamPsStream where to save image data in requested format.
paramsPdfImageParams specifying the image format and quality.
Returns
true if succeeded, false otherwise.
See also
PdfImageFormat