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 ()
virtual	~Image ()
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 ()
UINT	GetFrameCount (const GUID *dimensionID)
UINT	GetFrameDimensionsCount ()
Status	GetFrameDimensionsList (GUID *dimensionIDs, UINT count)
UINT	GetHeight ()
REAL	GetHorizontalResolution ()
Status	GetLastStatus ()
Status	GetPalette (ColorPalette *palette, INT size)
INT	GetPaletteSize ()
Status	GetPhysicalDimension (SizeF *size)
PixelFormat	GetPixelFormat ()
UINT	GetPropertyCount ()
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 ()
REAL	GetVerticalResolution ()
UINT	GetWidth ()
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 ()
	Image (GpImage *image, Status status)
Status	SetStatus (Status status) const
void	SetNativeImage (GpImage *image)

Protected Attributes
GpImage *	nativeImage
Status	lastStatus

Private Member Functions
	Image (const Image &)
Image &	operator= (const Image &)

Friends
class	Graphics
class	TextureBrush
GpImage *&	getNat (const Image *image)

Detailed Description

Definition at line 22 of file gdiplusheaders.h.

Constructor & Destructor Documentation

Image() [1/5]

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

inline

Definition at line 28 of file gdiplusheaders.h.

                                                                    : nativeImage(NULL)
    {
        if (useEmbeddedColorManagement)
            lastStatus = DllExports::GdipLoadImageFromStreamICM(stream, &nativeImage);
        else
            lastStatus = DllExports::GdipLoadImageFromStream(stream, &nativeImage);
    }

Image() [2/5]

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

inline

Definition at line 36 of file gdiplusheaders.h.

                                                                          : nativeImage(NULL)
    {
        if (useEmbeddedColorManagement)
            lastStatus = DllExports::GdipLoadImageFromFileICM(filename, &nativeImage);
        else
            lastStatus = DllExports::GdipLoadImageFromFile(filename, &nativeImage);
    }

~Image()

virtual Image::~Image ( )

inlinevirtual

Definition at line 52 of file gdiplusheaders.h.

    {
        DllExports::GdipDisposeImage(nativeImage);
    }

Image() [3/5]

Image::Image ( )

inlineprotected

Definition at line 342 of file gdiplusheaders.h.

    {
    }

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

Image() [4/5]

Image::Image ( GpImage *  image, Status  status  )

inlineprotected

Definition at line 346 of file gdiplusheaders.h.

                                         : nativeImage(image), lastStatus(status)
    {
    }

Image() [5/5]

Image::Image ( const Image &  )

private

Member Function Documentation

Clone()

Image* Image::Clone ( )

inline

Definition at line 45 of file gdiplusheaders.h.

    {
        GpImage *cloneimage = NULL;
        SetStatus(DllExports::GdipCloneImage(nativeImage, &cloneimage));
        return new Image(cloneimage, lastStatus);
    }

Referenced by Bitmap::Clone().

FromFile()

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

inlinestatic

Definition at line 58 of file gdiplusheaders.h.

    {
        return new Image(filename, useEmbeddedColorManagement);
    }

FromStream()

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

inlinestatic

Definition at line 64 of file gdiplusheaders.h.

    {
        return new Image(stream, useEmbeddedColorManagement);
    }

GetAllPropertyItems()

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

inline

Definition at line 70 of file gdiplusheaders.h.

    {
        if (allItems == NULL)
            return SetStatus(InvalidParameter);
        return SetStatus(DllExports::GdipGetAllPropertyItems(nativeImage, totalBufferSize, numProperties, allItems));
    }

GetBounds()

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

inline

Definition at line 78 of file gdiplusheaders.h.

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

GetEncoderParameterList()

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

inline

Definition at line 84 of file gdiplusheaders.h.

    {
#if 1
        return SetStatus(NotImplemented);
#else
        return SetStatus(DllExports::GdipGetEncoderParameterList(nativeImage, clsidEncoder, size, buffer));
#endif
    }

GetEncoderParameterListSize()

UINT Image::GetEncoderParameterListSize ( const CLSID *  clsidEncoder )

inline

Definition at line 94 of file gdiplusheaders.h.

    {
        UINT size = 0;
        SetStatus(DllExports::GdipGetEncoderParameterListSize(nativeImage, clsidEncoder, &size));
        return size;
    }

GetFlags()

UINT Image::GetFlags ( )

inline

Definition at line 102 of file gdiplusheaders.h.

    {
        UINT flags = 0;
        SetStatus(DllExports::GdipGetImageFlags(nativeImage, &flags));
        return flags;
    }

GetFrameCount()

UINT Image::GetFrameCount ( const GUID *  dimensionID )

inline

Definition at line 110 of file gdiplusheaders.h.

    {
        UINT count = 0;
        SetStatus(DllExports::GdipImageGetFrameCount(nativeImage, dimensionID, &count));
        return count;
    }

GetFrameDimensionsCount()

UINT Image::GetFrameDimensionsCount ( )

inline

Definition at line 118 of file gdiplusheaders.h.

    {
        UINT count = 0;
        SetStatus(DllExports::GdipImageGetFrameDimensionsCount(nativeImage, &count));
        return count;
    }

GetFrameDimensionsList()

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

inline

Definition at line 126 of file gdiplusheaders.h.

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

GetHeight()

UINT Image::GetHeight ( )

inline

Definition at line 132 of file gdiplusheaders.h.

    {
        UINT height = 0;
        SetStatus(DllExports::GdipGetImageHeight(nativeImage, &height));
        return height;
    }

Referenced by CAppScrnshotPreview::GetRequestedWidth(), and CAppScrnshotPreview::PaintOnDC().

GetHorizontalResolution()

REAL Image::GetHorizontalResolution ( )

inline

Definition at line 140 of file gdiplusheaders.h.

    {
        REAL resolution = 0.0f;
        SetStatus(DllExports::GdipGetImageHorizontalResolution(nativeImage, &resolution));
        return resolution;
    }

GetLastStatus()

Status Image::GetLastStatus ( )

inline

Definition at line 148 of file gdiplusheaders.h.

    {
        return lastStatus;
    }

Referenced by CAppScrnshotPreview::DisplayFile().

GetPalette()

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

inline

Definition at line 154 of file gdiplusheaders.h.

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

GetPaletteSize()

INT Image::GetPaletteSize ( )

inline

Definition at line 160 of file gdiplusheaders.h.

    {
        INT size = 0;
        SetStatus(DllExports::GdipGetImagePaletteSize(nativeImage, &size));
        return size;
    }

GetPhysicalDimension()

Status Image::GetPhysicalDimension ( SizeF *  size )

inline

Definition at line 168 of file gdiplusheaders.h.

    {
        if (size == NULL)
            return SetStatus(InvalidParameter);

        return SetStatus(DllExports::GdipGetImageDimension(nativeImage, &size->Width, &size->Height));
    }

GetPixelFormat()

PixelFormat Image::GetPixelFormat ( )

inline

Definition at line 177 of file gdiplusheaders.h.

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

GetPropertyCount()

UINT Image::GetPropertyCount ( )

inline

Definition at line 185 of file gdiplusheaders.h.

    {
        UINT numOfProperty = 0;
        SetStatus(DllExports::GdipGetPropertyCount(nativeImage, &numOfProperty));
        return numOfProperty;
    }

GetPropertyIdList()

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

inline

Definition at line 193 of file gdiplusheaders.h.

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

GetPropertyItem()

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

inline

Definition at line 199 of file gdiplusheaders.h.

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

GetPropertyItemSize()

UINT Image::GetPropertyItemSize ( PROPID  propId )

inline

Definition at line 205 of file gdiplusheaders.h.

    {
        UINT size = 0;
        SetStatus(DllExports::GdipGetPropertyItemSize(nativeImage, propId, &size));
        return size;
    }

GetPropertySize()

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

inline

Definition at line 213 of file gdiplusheaders.h.

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

GetRawFormat()

Status Image::GetRawFormat ( GUID *  format )

inline

Definition at line 219 of file gdiplusheaders.h.

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

GetThumbnailImage()

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

inline

Definition at line 225 of file gdiplusheaders.h.

    {
        GpImage *thumbImage = NULL;
        SetStatus(DllExports::GdipGetImageThumbnail(
            nativeImage, thumbWidth, thumbHeight, &thumbImage, callback, callbackData));
        Image *newImage = new Image(thumbImage, lastStatus);
        if (newImage == NULL)
        {
            DllExports::GdipDisposeImage(thumbImage);
        }
        return newImage;
    }

GetType()

ImageType Image::GetType ( )

inline

Definition at line 239 of file gdiplusheaders.h.

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

GetVerticalResolution()

REAL Image::GetVerticalResolution ( )

inline

Definition at line 247 of file gdiplusheaders.h.

    {
        REAL resolution = 0.0f;
        SetStatus(DllExports::GdipGetImageVerticalResolution(nativeImage, &resolution));
        return resolution;
    }

GetWidth()

UINT Image::GetWidth ( )

inline

Definition at line 255 of file gdiplusheaders.h.

    {
        UINT width = 0;
        SetStatus(DllExports::GdipGetImageWidth(nativeImage, &width));
        return width;
    }

Referenced by CAppScrnshotPreview::GetRequestedWidth(), and CAppScrnshotPreview::PaintOnDC().

operator=()

Image& Image::operator= ( const Image &  )

private

RemovePropertyItem()

Status Image::RemovePropertyItem ( PROPID  propId )

inline

Definition at line 263 of file gdiplusheaders.h.

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

RotateFlip()

Status Image::RotateFlip ( RotateFlipType  rotateFlipType )

inline

Definition at line 269 of file gdiplusheaders.h.

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

Save() [1/2]

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

inline

Definition at line 275 of file gdiplusheaders.h.

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

Save() [2/2]

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

inline

Definition at line 281 of file gdiplusheaders.h.

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

SaveAdd() [1/2]

Status Image::SaveAdd ( const EncoderParameters *  encoderParams )

inline

Definition at line 287 of file gdiplusheaders.h.

    {
        return SetStatus(DllExports::GdipSaveAdd(nativeImage, encoderParams));
    }

SaveAdd() [2/2]

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

inline

Definition at line 293 of file gdiplusheaders.h.

    {
#if 1
        // FIXME: Not available yet
        return SetStatus(NotImplemented);
#else
        if (!newImage)
            return SetStatus(InvalidParameter);

        return SetStatus(DllExports::GdipSaveAddImage(nativeImage, getNat(newImage), encoderParams));
#endif
    }

SelectActiveFrame()

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

inline

Definition at line 307 of file gdiplusheaders.h.

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

SetNativeImage()

void Image::SetNativeImage ( GpImage *  image )

inlineprotected

Definition at line 359 of file gdiplusheaders.h.

    {
        nativeImage = image;
    }

Referenced by Bitmap::Bitmap(), and Metafile::Metafile().

SetPalette()

Status Image::SetPalette ( const ColorPalette *  palette )

inline

Definition at line 313 of file gdiplusheaders.h.

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

SetPropertyItem()

Status Image::SetPropertyItem ( const PropertyItem *  item )

inline

Definition at line 319 of file gdiplusheaders.h.

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

SetStatus()

Status Image::SetStatus ( Status  status ) const

inlineprotected

Definition at line 351 of file gdiplusheaders.h.

    {
        if (status != Ok)
            lastStatus = status;
        return status;
    }

Referenced by Clone(), GetAllPropertyItems(), GetBounds(), Metafile::GetDownLevelRasterizationLimit(), GetEncoderParameterList(), GetEncoderParameterListSize(), GetFlags(), GetFrameCount(), GetFrameDimensionsCount(), GetFrameDimensionsList(), Bitmap::GetHBITMAP(), GetHeight(), Metafile::GetHENHMETAFILE(), Bitmap::GetHICON(), GetHorizontalResolution(), Metafile::GetMetafileHeader(), GetPalette(), GetPaletteSize(), GetPhysicalDimension(), Bitmap::GetPixel(), GetPixelFormat(), GetPropertyCount(), GetPropertyIdList(), GetPropertyItem(), GetPropertyItemSize(), GetPropertySize(), GetRawFormat(), GetThumbnailImage(), GetType(), GetVerticalResolution(), GetWidth(), Bitmap::LockBits(), Metafile::PlayRecord(), RemovePropertyItem(), RotateFlip(), Save(), SaveAdd(), SelectActiveFrame(), Metafile::SetDownLevelRasterizationLimit(), SetPalette(), Bitmap::SetPixel(), SetPropertyItem(), Bitmap::SetResolution(), and Bitmap::UnlockBits().

Friends And Related Function Documentation

getNat

GpImage*& getNat ( const Image *  image )

friend

Definition at line 372 of file gdiplusheaders.h.

    {
        return const_cast<Image *>(image)->nativeImage;
    }

Referenced by Bitmap::Bitmap(), and SaveAdd().

Graphics

friend class Graphics

friend

Definition at line 25 of file gdiplusheaders.h.

TextureBrush

friend class TextureBrush

friend

Definition at line 26 of file gdiplusheaders.h.

Member Data Documentation

lastStatus

Status Image::lastStatus

mutableprotected

Definition at line 340 of file gdiplusheaders.h.

Referenced by Bitmap::Bitmap(), Clone(), Bitmap::Clone(), GetLastStatus(), GetThumbnailImage(), Image(), Metafile::Metafile(), and SetStatus().

nativeImage

GpImage* Image::nativeImage

protected

Definition at line 339 of file gdiplusheaders.h.

Referenced by Clone(), GetAllPropertyItems(), GetBounds(), GetEncoderParameterList(), GetEncoderParameterListSize(), GetFlags(), GetFrameCount(), GetFrameDimensionsCount(), GetFrameDimensionsList(), GetHeight(), GetHorizontalResolution(), getNat(), Bitmap::GetNativeBitmap(), Metafile::GetNativeMetafile(), GetPalette(), GetPaletteSize(), GetPhysicalDimension(), GetPixelFormat(), GetPropertyCount(), GetPropertyIdList(), GetPropertyItem(), GetPropertyItemSize(), GetPropertySize(), GetRawFormat(), GetThumbnailImage(), GetType(), GetVerticalResolution(), GetWidth(), Image(), RemovePropertyItem(), RotateFlip(), Save(), SaveAdd(), SelectActiveFrame(), SetNativeImage(), SetPalette(), SetPropertyItem(), and ~Image().

---

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

• sdk/include/psdk/gdiplusheaders.h