Bitmap Class Reference

#include <gdiplusheaders.h>

Inheritance diagram for Bitmap:

Collaboration diagram for Bitmap:

Public Member Functions
	Bitmap (INT width, INT height, Graphics *target)
	Bitmap (const BITMAPINFO *gdiBitmapInfo, VOID *gdiBitmapData)
	Bitmap (INT width, INT height, PixelFormat format)
	Bitmap (HBITMAP hbm, HPALETTE hpal)
	Bitmap (INT width, INT height, INT stride, PixelFormat format, BYTE *scan0)
	Bitmap (const WCHAR *filename, BOOL useIcm)
	Bitmap (HINSTANCE hInstance, const WCHAR *bitmapName)
	Bitmap (HICON hicon)
	Bitmap (IStream *stream, BOOL useIcm)
Bitmap *	Clone (const Rect &rect, PixelFormat format)
Bitmap *	Clone (const RectF &rect, PixelFormat format)
Bitmap *	Clone (REAL x, REAL y, REAL width, REAL height, PixelFormat format)
Bitmap *	Clone (INT x, INT y, INT width, INT height, PixelFormat format)
Status	GetHBITMAP (const Color &colorBackground, HBITMAP *hbmReturn)
Status	GetHICON (HICON *hicon)
Status	GetPixel (INT x, INT y, Color *color)
Status	LockBits (const Rect *rect, UINT flags, PixelFormat format, BitmapData *lockedBitmapData)
Status	SetPixel (INT x, INT y, const Color &color)
Status	SetResolution (REAL xdpi, REAL ydpi)
Status	UnlockBits (BitmapData *lockedBitmapData)
Public Member Functions inherited from Image
	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 Bitmap *	FromBITMAPINFO (const BITMAPINFO *gdiBitmapInfo, VOID *gdiBitmapData)
static Bitmap *	FromFile (const WCHAR *filename, BOOL useEmbeddedColorManagement)
static Bitmap *	FromHBITMAP (HBITMAP hbm, HPALETTE hpal)
static Bitmap *	FromHICON (HICON hicon)
static Bitmap *	FromResource (HINSTANCE hInstance, const WCHAR *bitmapName)
static Bitmap *	FromStream (IStream *stream, BOOL useEmbeddedColorManagement)
Static Public Member Functions inherited from Image
static Image *	FromFile (const WCHAR *filename, BOOL useEmbeddedColorManagement=FALSE)
static Image *	FromStream (IStream *stream, BOOL useEmbeddedColorManagement=FALSE)

Protected Member Functions
	Bitmap ()
	Bitmap (GpBitmap *nativeBitmap)
GpBitmap *	GetNativeBitmap () const
Protected Member Functions inherited from Image
	Image ()
	Image (GpImage *image, Status status)
Status	SetStatus (Status status) const
void	SetNativeImage (GpImage *image)

Friends
class	CachedBitmap

Additional Inherited Members
Protected Attributes inherited from Image
GpImage *	nativeImage
Status	lastStatus

Detailed Description

Definition at line 378 of file gdiplusheaders.h.

Constructor & Destructor Documentation

Bitmap() [1/11]

Bitmap::Bitmap ( INT  width, INT  height, Graphics *  target  )

inline

Definition at line 388 of file gdiplusheaders.h.

    {
        GpBitmap *bitmap = NULL;
        lastStatus = DllExports::GdipCreateBitmapFromGraphics(width, height, target ? getNat(target) : NULL, &bitmap);
        SetNativeImage(bitmap);
    }

Bitmap() [2/11]

Bitmap::Bitmap ( const BITMAPINFO *  gdiBitmapInfo, VOID *  gdiBitmapData  )

inline

Definition at line 395 of file gdiplusheaders.h.

    {
        GpBitmap *bitmap = NULL;
        lastStatus = DllExports::GdipCreateBitmapFromGdiDib(gdiBitmapInfo, gdiBitmapData, &bitmap);
        SetNativeImage(bitmap);
    }

Bitmap() [3/11]

Bitmap::Bitmap ( INT  width, INT  height, PixelFormat  format  )

inline

Definition at line 402 of file gdiplusheaders.h.

    {
        GpBitmap *bitmap = NULL;
        lastStatus = DllExports::GdipCreateBitmapFromScan0(width, height, 0, format, NULL, &bitmap);
        SetNativeImage(bitmap);
    }

Bitmap() [4/11]

Bitmap::Bitmap ( HBITMAP  hbm, HPALETTE  hpal  )

inline

Definition at line 409 of file gdiplusheaders.h.

    {
        GpBitmap *bitmap = NULL;
        lastStatus = DllExports::GdipCreateBitmapFromHBITMAP(hbm, hpal, &bitmap);
        SetNativeImage(bitmap);
    }

Bitmap() [5/11]

Bitmap::Bitmap ( INT  width, INT  height, INT  stride, PixelFormat  format, BYTE *  scan0  )

inline

Definition at line 416 of file gdiplusheaders.h.

    {
        GpBitmap *bitmap = NULL;
        lastStatus = DllExports::GdipCreateBitmapFromScan0(width, height, stride, format, scan0, &bitmap);
        SetNativeImage(bitmap);
    }

Bitmap() [6/11]

Bitmap::Bitmap ( const WCHAR *  filename, BOOL  useIcm  )

inline

Definition at line 423 of file gdiplusheaders.h.

    {
        GpBitmap *bitmap = NULL;
 
        if (useIcm)
            lastStatus = DllExports::GdipCreateBitmapFromFileICM(filename, &bitmap);
        else
            lastStatus = DllExports::GdipCreateBitmapFromFile(filename, &bitmap);
 
        SetNativeImage(bitmap);
    }

Bitmap() [7/11]

Bitmap::Bitmap ( HINSTANCE  hInstance, const WCHAR *  bitmapName  )

inline

Definition at line 435 of file gdiplusheaders.h.

    {
        GpBitmap *bitmap = NULL;
        lastStatus = DllExports::GdipCreateBitmapFromResource(hInstance, bitmapName, &bitmap);
        SetNativeImage(bitmap);
    }

Bitmap() [8/11]

Bitmap::Bitmap ( HICON  hicon )

inline

Definition at line 442 of file gdiplusheaders.h.

    {
        GpBitmap *bitmap = NULL;
        lastStatus = DllExports::GdipCreateBitmapFromHICON(hicon, &bitmap);
        SetNativeImage(bitmap);
    }

Bitmap() [9/11]

Bitmap::Bitmap ( IStream *  stream, BOOL  useIcm  )

inline

Definition at line 449 of file gdiplusheaders.h.

    {
        GpBitmap *bitmap = NULL;
        if (useIcm)
            lastStatus = DllExports::GdipCreateBitmapFromStreamICM(stream, &bitmap);
        else
            lastStatus = DllExports::GdipCreateBitmapFromStream(stream, &bitmap);
        SetNativeImage(bitmap);
    }

Bitmap() [10/11]

Bitmap::Bitmap ( )

inlineprotected

Definition at line 596 of file gdiplusheaders.h.

    {
    }

Referenced by Clone(), FromBITMAPINFO(), FromFile(), FromHBITMAP(), FromHICON(), FromResource(), and FromStream().

Bitmap() [11/11]

Bitmap::Bitmap ( GpBitmap *  nativeBitmap )

inlineprotected

Definition at line 600 of file gdiplusheaders.h.

    {
        lastStatus = Ok;
        SetNativeImage(nativeBitmap);
    }

Member Function Documentation

Clone() [1/4]

Bitmap * Bitmap::Clone ( const Rect &  rect, PixelFormat  format  )

inline

Definition at line 460 of file gdiplusheaders.h.

    {
        return Clone(rect.X, rect.Y, rect.Width, rect.Height, format);
    }

Clone() [2/4]

Bitmap * Bitmap::Clone ( const RectF &  rect, PixelFormat  format  )

inline

Definition at line 466 of file gdiplusheaders.h.

    {
        return Clone(rect.X, rect.Y, rect.Width, rect.Height, format);
    }

Clone() [3/4]

Bitmap * Bitmap::Clone ( INT  x, INT  y, INT  width, INT  height, PixelFormat  format  )

inline

Definition at line 490 of file gdiplusheaders.h.

    {
        GpBitmap *bitmap = NULL;
        lastStatus = DllExports::GdipCloneBitmapAreaI(x, y, width, height, format, GetNativeBitmap(), &bitmap);
 
        if (lastStatus != Ok)
            return NULL;
 
        Bitmap *newBitmap = new Bitmap(bitmap);
        if (newBitmap == NULL)
        {
            DllExports::GdipDisposeImage(bitmap);
        }
 
        return newBitmap;
    }

Clone() [4/4]

Bitmap * Bitmap::Clone ( REAL  x, REAL  y, REAL  width, REAL  height, PixelFormat  format  )

inline

Definition at line 472 of file gdiplusheaders.h.

    {
        GpBitmap *bitmap = NULL;
        lastStatus = DllExports::GdipCloneBitmapArea(x, y, width, height, format, GetNativeBitmap(), &bitmap);
 
        if (lastStatus != Ok)
            return NULL;
 
        Bitmap *newBitmap = new Bitmap(bitmap);
        if (newBitmap == NULL)
        {
            DllExports::GdipDisposeImage(bitmap);
        }
 
        return newBitmap;
    }

FromBITMAPINFO()

static Bitmap * Bitmap::FromBITMAPINFO ( const BITMAPINFO *  gdiBitmapInfo, VOID *  gdiBitmapData  )

inlinestatic

Definition at line 508 of file gdiplusheaders.h.

    {
        return new Bitmap(gdiBitmapInfo, gdiBitmapData);
    }

FromFile()

static Bitmap * Bitmap::FromFile ( const WCHAR *  filename, BOOL  useEmbeddedColorManagement  )

inlinestatic

Definition at line 519 of file gdiplusheaders.h.

    {
        return new Bitmap(filename, useEmbeddedColorManagement);
    }

Referenced by CAppScrnshotPreview::DisplayFile().

FromHBITMAP()

static Bitmap * Bitmap::FromHBITMAP ( HBITMAP  hbm, HPALETTE  hpal  )

inlinestatic

Definition at line 525 of file gdiplusheaders.h.

    {
        return new Bitmap(hbm, hpal);
    }

FromHICON()

static Bitmap * Bitmap::FromHICON ( HICON  hicon )

inlinestatic

Definition at line 531 of file gdiplusheaders.h.

    {
        return new Bitmap(hicon);
    }

FromResource()

static Bitmap * Bitmap::FromResource ( HINSTANCE  hInstance, const WCHAR *  bitmapName  )

inlinestatic

Definition at line 537 of file gdiplusheaders.h.

    {
        return new Bitmap(hInstance, bitmapName);
    }

FromStream()

static Bitmap * Bitmap::FromStream ( IStream *  stream, BOOL  useEmbeddedColorManagement  )

inlinestatic

Definition at line 543 of file gdiplusheaders.h.

    {
        return new Bitmap(stream, useEmbeddedColorManagement);
    }

GetHBITMAP()

Status Bitmap::GetHBITMAP ( const Color &  colorBackground, HBITMAP *  hbmReturn  )

inline

Definition at line 549 of file gdiplusheaders.h.

    {
        return SetStatus(
            DllExports::GdipCreateHBITMAPFromBitmap(GetNativeBitmap(), hbmReturn, colorBackground.GetValue()));
    }

GetHICON()

Status Bitmap::GetHICON ( HICON *  hicon )

inline

Definition at line 556 of file gdiplusheaders.h.

    {
        return SetStatus(DllExports::GdipCreateHICONFromBitmap(GetNativeBitmap(), hicon));
    }

GetNativeBitmap()

GpBitmap * Bitmap::GetNativeBitmap ( ) const

inlineprotected

Definition at line 607 of file gdiplusheaders.h.

    {
        return static_cast<GpBitmap *>(nativeImage);
    }

Referenced by Clone(), GetHBITMAP(), GetHICON(), GetPixel(), LockBits(), SetPixel(), SetResolution(), and UnlockBits().

GetPixel()

Status Bitmap::GetPixel ( INT  x, INT  y, Color *  color  )

inline

Definition at line 562 of file gdiplusheaders.h.

    {
        ARGB argb;
        Status s = SetStatus(DllExports::GdipBitmapGetPixel(GetNativeBitmap(), x, y, &argb));
        if (color)
            color->SetValue(argb);
        return s;
    }

LockBits()

Status Bitmap::LockBits ( const Rect *  rect, UINT  flags, PixelFormat  format, BitmapData *  lockedBitmapData  )

inline

Definition at line 572 of file gdiplusheaders.h.

    {
        return SetStatus(DllExports::GdipBitmapLockBits(GetNativeBitmap(), rect, flags, format, lockedBitmapData));
    }

SetPixel()

Status Bitmap::SetPixel ( INT  x, INT  y, const Color &  color  )

inline

Definition at line 578 of file gdiplusheaders.h.

    {
        return SetStatus(DllExports::GdipBitmapSetPixel(GetNativeBitmap(), x, y, color.GetValue()));
    }

SetResolution()

Status Bitmap::SetResolution ( REAL  xdpi, REAL  ydpi  )

inline

Definition at line 584 of file gdiplusheaders.h.

    {
        return SetStatus(DllExports::GdipBitmapSetResolution(GetNativeBitmap(), xdpi, ydpi));
    }

UnlockBits()

Status Bitmap::UnlockBits ( BitmapData *  lockedBitmapData )

inline

Definition at line 590 of file gdiplusheaders.h.

    {
        return SetStatus(DllExports::GdipBitmapUnlockBits(GetNativeBitmap(), lockedBitmapData));
    }

Friends And Related Function Documentation

CachedBitmap

friend class CachedBitmap

friend

Definition at line 380 of file gdiplusheaders.h.

---

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

• sdk/include/psdk/gdiplusheaders.h