Image Class Reference

#include <gdiplusheaders.h>

Inheritance diagram for Image:

Collaboration diagram for Image:

Public Member Functions
	Image (IStream *stream, BOOL useEmbeddedColorManagement=FALSE)
	Image (const WCHAR *filename, BOOL useEmbeddedColorManagement=FALSE)
Image *	Clone (VOID)
Status	GetAllPropertyItems (UINT totalBufferSize, UINT numProperties, PropertyItem *allItems)
Status	GetBounds (RectF *srcRect, Unit *srcUnit)
Status	GetEncoderParameterList (const CLSID *clsidEncoder, UINT size, EncoderParameters *buffer)
UINT	GetEncoderParameterListSize (const CLSID *clsidEncoder)
UINT	GetFlags (VOID)
UINT	GetFrameCount (const GUID *dimensionID)
UINT	GetFrameDimensionsCount (VOID)
Status	GetFrameDimensionsList (GUID *dimensionIDs, UINT count)
UINT	GetHeight (VOID)
REAL	GetHorizontalResolution (VOID)
Status	GetLastStatus (VOID)
Status	GetPalette (ColorPalette *palette, INT size)
INT	GetPaletteSize (VOID)
Status	GetPhysicalDimension (SizeF *size)
PixelFormat	GetPixelFormat (VOID)
UINT	GetPropertyCount (VOID)
Status	GetPropertyIdList (UINT numOfProperty, PROPID *list)
Status	GetPropertyItem (PROPID propId, UINT propSize, PropertyItem *buffer)
UINT	GetPropertyItemSize (PROPID propId)
Status	GetPropertySize (UINT *totalBufferSize, UINT *numProperties)
Status	GetRawFormat (GUID *format)
Image *	GetThumbnailImage (UINT thumbWidth, UINT thumbHeight, GetThumbnailImageAbort callback, VOID *callbackData)
ImageType	GetType (VOID)
REAL	GetVerticalResolution (VOID)
UINT	GetWidth (VOID)
Status	RemovePropertyItem (PROPID propId)
Status	RotateFlip (RotateFlipType rotateFlipType)
Status	Save (IStream *stream, const CLSID *clsidEncoder, const EncoderParameters *encoderParams)
Status	Save (const WCHAR *filename, const CLSID *clsidEncoder, const EncoderParameters *encoderParams)
Status	SaveAdd (const EncoderParameters *encoderParams)
Status	SaveAdd (Image *newImage, const EncoderParameters *encoderParams)
Status	SelectActiveFrame (const GUID *dimensionID, UINT frameIndex)
Status	SetPalette (const ColorPalette *palette)
Status	SetPropertyItem (const PropertyItem *item)
Public Member Functions inherited from GdiplusBase
void	operator delete (void *in_pVoid)
void	operator delete[] (void *in_pVoid)
void *	operator new (size_t in_size)
void *	operator new[] (size_t in_size)

Static Public Member Functions
static Image *	FromFile (const WCHAR *filename, BOOL useEmbeddedColorManagement=FALSE)
static Image *	FromStream (IStream *stream, BOOL useEmbeddedColorManagement=FALSE)

Protected Member Functions
	Image ()

Private Member Functions
Status	SetStatus (Status status) const

Private Attributes
Status	status
GpImage *	image

Friends
class	Graphics

Detailed Description

Definition at line 22 of file gdiplusheaders.h.

Constructor & Destructor Documentation

Image() [1/3]

Image::Image ( IStream *  stream, BOOL  useEmbeddedColorManagement = FALSE  )

inline

Definition at line 27 of file gdiplusheaders.h.

  {
    if (useEmbeddedColorManagement)
      status = DllExports::GdipLoadImageFromStreamICM(stream, &image);
    else
      status = DllExports::GdipLoadImageFromStream(stream, &image);
  }

Image() [2/3]

Image::Image ( const WCHAR *  filename, BOOL  useEmbeddedColorManagement = FALSE  )

inline

Definition at line 35 of file gdiplusheaders.h.

  {
    if (useEmbeddedColorManagement)
      status = DllExports::GdipLoadImageFromFileICM(filename, &image);
    else
      status = DllExports::GdipLoadImageFromFile(filename, &image);
  }

Image() [3/3]

Image::Image ( )

inlineprotected

Definition at line 260 of file gdiplusheaders.h.

  {
  }

Referenced by Clone(), FromFile(), FromStream(), and GetThumbnailImage().

Member Function Documentation

Clone()

Image* Image::Clone ( VOID  )

inline

Definition at line 43 of file gdiplusheaders.h.

  {
    Image *newImage = new Image();
    SetStatus(DllExports::GdipCloneImage(image, newImage ? &newImage->image : NULL));
    return newImage;
  }

FromFile()

static Image* Image::FromFile ( const WCHAR *  filename, BOOL  useEmbeddedColorManagement = FALSE  )

inlinestatic

Definition at line 50 of file gdiplusheaders.h.

  {
    return new Image(filename, useEmbeddedColorManagement);
  }

FromStream()

static Image* Image::FromStream ( IStream *  stream, BOOL  useEmbeddedColorManagement = FALSE  )

inlinestatic

Definition at line 55 of file gdiplusheaders.h.

  {
    return new Image(stream, useEmbeddedColorManagement);
  }

GetAllPropertyItems()

Status Image::GetAllPropertyItems ( UINT  totalBufferSize, UINT  numProperties, PropertyItem *  allItems  )

inline

Definition at line 60 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipGetAllPropertyItems(image, totalBufferSize, numProperties, allItems));
  }

GetBounds()

Status Image::GetBounds ( RectF *  srcRect, Unit *  srcUnit  )

inline

Definition at line 65 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipGetImageBounds(image, srcRect, srcUnit));
  }

GetEncoderParameterList()

Status Image::GetEncoderParameterList ( const CLSID *  clsidEncoder, UINT  size, EncoderParameters *  buffer  )

inline

Definition at line 70 of file gdiplusheaders.h.

  {
    return NotImplemented;  // FIXME: not available: SetStatus(DllExports::GdipGetEncoderParameterList(image, clsidEncoder, size, buffer));
  }

GetEncoderParameterListSize()

UINT Image::GetEncoderParameterListSize ( const CLSID *  clsidEncoder )

inline

Definition at line 75 of file gdiplusheaders.h.

  {
    return 0;  // FIXME: not available:
//     UINT size;
//     SetStatus(DllExports::GdipGetEncoderParameterListSize(image, clsidEncoder, &size));
//     return size;
  }

GetFlags()

UINT Image::GetFlags ( VOID  )

inline

Definition at line 83 of file gdiplusheaders.h.

  {
    UINT flags;
    SetStatus(DllExports::GdipGetImageFlags(image, &flags));
    return flags;
  }

GetFrameCount()

UINT Image::GetFrameCount ( const GUID *  dimensionID )

inline

Definition at line 90 of file gdiplusheaders.h.

  {
    UINT count;
    SetStatus(DllExports::GdipImageGetFrameCount(image, dimensionID, &count));
    return count;
  }

GetFrameDimensionsCount()

UINT Image::GetFrameDimensionsCount ( VOID  )

inline

Definition at line 97 of file gdiplusheaders.h.

  {
    UINT count;
    SetStatus(DllExports::GdipImageGetFrameDimensionsCount(image, &count));
    return count;
  }

GetFrameDimensionsList()

Status Image::GetFrameDimensionsList ( GUID *  dimensionIDs, UINT  count  )

inline

Definition at line 104 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipImageGetFrameDimensionsList(image, dimensionIDs, count));
  }

GetHeight()

UINT Image::GetHeight ( VOID  )

inline

Definition at line 109 of file gdiplusheaders.h.

  {
    UINT height;
    SetStatus(DllExports::GdipGetImageHeight(image, &height));
    return height;
  }

GetHorizontalResolution()

REAL Image::GetHorizontalResolution ( VOID  )

inline

Definition at line 116 of file gdiplusheaders.h.

  {
    REAL resolution;
    SetStatus(DllExports::GdipGetImageHorizontalResolution(image, &resolution));
    return resolution;
  }

GetLastStatus()

Status Image::GetLastStatus ( VOID  )

inline

Definition at line 123 of file gdiplusheaders.h.

  {
    return status;
  }

GetPalette()

Status Image::GetPalette ( ColorPalette *  palette, INT  size  )

inline

Definition at line 128 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipGetImagePalette(image, palette, size));
  }

GetPaletteSize()

INT Image::GetPaletteSize ( VOID  )

inline

Definition at line 133 of file gdiplusheaders.h.

  {
    INT size;
    SetStatus(DllExports::GdipGetImagePaletteSize(image, &size));
    return size;
  }

GetPhysicalDimension()

Status Image::GetPhysicalDimension ( SizeF *  size )

inline

Definition at line 140 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipGetImageDimension(image, size ? &size->Width : NULL, size ? &size->Height : NULL));
  }

GetPixelFormat()

PixelFormat Image::GetPixelFormat ( VOID  )

inline

Definition at line 145 of file gdiplusheaders.h.

  {
    PixelFormat format;
    SetStatus(DllExports::GdipGetImagePixelFormat(image, &format));
    return format;
  }

GetPropertyCount()

UINT Image::GetPropertyCount ( VOID  )

inline

Definition at line 152 of file gdiplusheaders.h.

  {
    UINT numOfProperty;
    SetStatus(DllExports::GdipGetPropertyCount(image, &numOfProperty));
    return numOfProperty;
  }

GetPropertyIdList()

Status Image::GetPropertyIdList ( UINT  numOfProperty, PROPID *  list  )

inline

Definition at line 159 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipGetPropertyIdList(image, numOfProperty, list));
  }

GetPropertyItem()

Status Image::GetPropertyItem ( PROPID  propId, UINT  propSize, PropertyItem *  buffer  )

inline

Definition at line 164 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipGetPropertyItem(image, propId, propSize, buffer));
  }

GetPropertyItemSize()

UINT Image::GetPropertyItemSize ( PROPID  propId )

inline

Definition at line 169 of file gdiplusheaders.h.

  {
    UINT size;
    SetStatus(DllExports::GdipGetPropertyItemSize(image, propId, &size));
    return size;
  }

GetPropertySize()

Status Image::GetPropertySize ( UINT *  totalBufferSize, UINT *  numProperties  )

inline

Definition at line 176 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipGetPropertySize(image, totalBufferSize, numProperties));
  }

GetRawFormat()

Status Image::GetRawFormat ( GUID *  format )

inline

Definition at line 181 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipGetImageRawFormat(image, format));
  }

GetThumbnailImage()

Image* Image::GetThumbnailImage ( UINT  thumbWidth, UINT  thumbHeight, GetThumbnailImageAbort  callback, VOID *  callbackData  )

inline

Definition at line 186 of file gdiplusheaders.h.

  {
    Image *thumbImage = new Image();
    SetStatus(DllExports::GdipGetImageThumbnail(image, thumbWidth, thumbHeight, thumbImage ? &thumbImage->image : NULL, callback, callbackData));
    return thumbImage;
  }

GetType()

ImageType Image::GetType ( VOID  )

inline

Definition at line 193 of file gdiplusheaders.h.

  {
    ImageType type;
    SetStatus(DllExports::GdipGetImageType(image, &type));
    return type;
  }

GetVerticalResolution()

REAL Image::GetVerticalResolution ( VOID  )

inline

Definition at line 200 of file gdiplusheaders.h.

  {
    REAL resolution;
    SetStatus(DllExports::GdipGetImageVerticalResolution(image, &resolution));
    return resolution;
  }

GetWidth()

UINT Image::GetWidth ( VOID  )

inline

Definition at line 207 of file gdiplusheaders.h.

  {
    UINT width;
    SetStatus(DllExports::GdipGetImageWidth(image, &width));
    return width;
  }

RemovePropertyItem()

Status Image::RemovePropertyItem ( PROPID  propId )

inline

Definition at line 214 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipRemovePropertyItem(image, propId));
  }

RotateFlip()

Status Image::RotateFlip ( RotateFlipType  rotateFlipType )

inline

Definition at line 219 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipImageRotateFlip(image, rotateFlipType));
  }

Save() [1/2]

Status Image::Save ( IStream *  stream, const CLSID *  clsidEncoder, const EncoderParameters *  encoderParams  )

inline

Definition at line 224 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipSaveImageToStream(image, stream, clsidEncoder, encoderParams));
  }

Save() [2/2]

Status Image::Save ( const WCHAR *  filename, const CLSID *  clsidEncoder, const EncoderParameters *  encoderParams  )

inline

Definition at line 229 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipSaveImageToFile(image, filename, clsidEncoder, encoderParams));
  }

SaveAdd() [1/2]

Status Image::SaveAdd ( const EncoderParameters *  encoderParams )

inline

Definition at line 234 of file gdiplusheaders.h.

  {
    return NotImplemented;  // FIXME: not available: SetStatus(DllExports::GdipSaveAdd(image, encoderParams));
  }

SaveAdd() [2/2]

Status Image::SaveAdd ( Image *  newImage, const EncoderParameters *  encoderParams  )

inline

Definition at line 239 of file gdiplusheaders.h.

  {
    return NotImplemented;  // FIXME: not available: SetStatus(DllExports::GdipSaveAddImage(image, newImage ? newImage->image : NULL, encoderParams));
  }

SelectActiveFrame()

Status Image::SelectActiveFrame ( const GUID *  dimensionID, UINT  frameIndex  )

inline

Definition at line 244 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipImageSelectActiveFrame(image, dimensionID, frameIndex));
  }

SetPalette()

Status Image::SetPalette ( const ColorPalette *  palette )

inline

Definition at line 249 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipSetImagePalette(image, palette));
  }

SetPropertyItem()

Status Image::SetPropertyItem ( const PropertyItem *  item )

inline

Definition at line 254 of file gdiplusheaders.h.

  {
    return SetStatus(DllExports::GdipSetPropertyItem(image, item));
  }

SetStatus()

Status Image::SetStatus ( Status  status ) const

inlineprivate

Definition at line 268 of file gdiplusheaders.h.

  {
    if (status == Ok)
      return status;
    this->status = status;
    return status;
  }

Referenced by Clone(), GetAllPropertyItems(), GetBounds(), GetFlags(), GetFrameCount(), GetFrameDimensionsCount(), GetFrameDimensionsList(), GetHeight(), GetHorizontalResolution(), GetPalette(), GetPaletteSize(), GetPhysicalDimension(), GetPixelFormat(), GetPropertyCount(), GetPropertyIdList(), GetPropertyItem(), GetPropertyItemSize(), GetPropertySize(), GetRawFormat(), GetThumbnailImage(), GetType(), GetVerticalResolution(), GetWidth(), RemovePropertyItem(), RotateFlip(), Save(), SelectActiveFrame(), SetPalette(), and SetPropertyItem().

Friends And Related Function Documentation

Graphics

friend class Graphics

friend

Definition at line 25 of file gdiplusheaders.h.

Member Data Documentation

image

GpImage* Image::image

private

Definition at line 266 of file gdiplusheaders.h.

Referenced by Clone(), and GetThumbnailImage().

status

Status Image::status

mutableprivate

Definition at line 265 of file gdiplusheaders.h.

Referenced by GetLastStatus(), and SetStatus().

---

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

• sdk/include/psdk/gdiplusheaders.h