#include <atlimage.h>

Collaboration diagram for ATL::CImage:

[legend]

Classes
class	CInitGDIPlus

struct	MYBITMAPINFOEX

Public Types
enum	{ createAlphaChannel = 1 }

enum	DIBOrientation { DIBOR_DEFAULT , DIBOR_TOPDOWN , DIBOR_BOTTOMUP }

enum	ExcludeFlags { excludeGIF = 0x01 , excludeBMP = 0x02 , excludeEMF = 0x04 , excludeWMF = 0x08 , excludeJPEG = 0x10 , excludePNG = 0x20 , excludeTIFF = 0x40 , excludeIcon = 0x80 , excludeOther = 0x80000000 , excludeDefaultLoad = 0 , excludeDefaultSave = excludeIcon \| excludeEMF \| excludeWMF }

Public Member Functions
	CImage () noexcept

virtual	~CImage () noexcept

	operator HBITMAP () noexcept

void	Attach (HBITMAP hBitmap, DIBOrientation eOrientation=DIBOR_DEFAULT) noexcept

HBITMAP	Detach () noexcept

HDC	GetDC () const noexcept

void	ReleaseDC () const noexcept

BOOL	AlphaBlend (HDC hDestDC, int xDest, int yDest, int nDestWidth, int nDestHeight, int xSrc, int ySrc, int nSrcWidth, int nSrcHeight, BYTE bSrcAlpha=0xFF, BYTE bBlendOp=AC_SRC_OVER) const

BOOL	AlphaBlend (HDC hDestDC, int xDest, int yDest, BYTE bSrcAlpha=0xFF, BYTE bBlendOp=AC_SRC_OVER) const

BOOL	AlphaBlend (HDC hDestDC, const POINT &pointDest, BYTE bSrcAlpha=0xFF, BYTE bBlendOp=AC_SRC_OVER) const

BOOL	AlphaBlend (HDC hDestDC, const RECT &rectDest, const RECT &rectSrc, BYTE bSrcAlpha=0xFF, BYTE bBlendOp=AC_SRC_OVER) const

BOOL	BitBlt (HDC hDestDC, int xDest, int yDest, int nDestWidth, int nDestHeight, int xSrc, int ySrc, DWORD dwROP=SRCCOPY) const noexcept

BOOL	BitBlt (HDC hDestDC, int xDest, int yDest, DWORD dwROP=SRCCOPY) const noexcept

BOOL	BitBlt (HDC hDestDC, const POINT &pointDest, DWORD dwROP=SRCCOPY) const noexcept

BOOL	BitBlt (HDC hDestDC, const RECT &rectDest, const POINT &pointSrc, DWORD dwROP=SRCCOPY) const noexcept

BOOL	Create (int nWidth, int nHeight, int nBPP, DWORD dwFlags=0) noexcept

BOOL	CreateEx (int nWidth, int nHeight, int nBPP, DWORD eCompression, const DWORD *pdwBitmasks=NULL, DWORD dwFlags=0) noexcept

void	Destroy () noexcept

BOOL	Draw (HDC hDestDC, int xDest, int yDest, int nDestWidth, int nDestHeight, int xSrc, int ySrc, int nSrcWidth, int nSrcHeight) const noexcept

BOOL	Draw (HDC hDestDC, const RECT &rectDest, const RECT &rectSrc) const noexcept

BOOL	Draw (HDC hDestDC, int xDest, int yDest) const noexcept

BOOL	Draw (HDC hDestDC, const POINT &pointDest) const noexcept

BOOL	Draw (HDC hDestDC, int xDest, int yDest, int nDestWidth, int nDestHeight) const noexcept

BOOL	Draw (HDC hDestDC, const RECT &rectDest) const noexcept

void *	GetBits () noexcept

const void *	GetBits () const noexcept

int	GetBPP () const noexcept

void	GetColorTable (UINT iFirstColor, UINT nColors, RGBQUAD *prgbColors) const noexcept

int	GetHeight () const noexcept

int	GetMaxColorTableEntries () const noexcept

int	GetPitch () const noexcept

COLORREF	GetPixel (int x, int y) const noexcept

void *	GetPixelAddress (int x, int y) noexcept

const void *	GetPixelAddress (int x, int y) const noexcept

COLORREF	GetTransparentColor () const noexcept

int	GetWidth () const noexcept

bool	IsDIBSection () const noexcept

bool	IsIndexed () const noexcept

bool	IsNull () const noexcept

HRESULT	Load (LPCTSTR pszFileName) noexcept

HRESULT	Load (IStream *pStream) noexcept

void	LoadFromResource (HINSTANCE hInstance, LPCTSTR pszResourceName) noexcept

void	LoadFromResource (HINSTANCE hInstance, UINT nIDResource) noexcept

BOOL	MaskBlt (HDC hDestDC, int xDest, int yDest, int nDestWidth, int nDestHeight, int xSrc, int ySrc, HBITMAP hbmMask, int xMask, int yMask, DWORD dwROP=SRCCOPY) const noexcept

BOOL	MaskBlt (HDC hDestDC, const RECT &rectDest, const POINT &pointSrc, HBITMAP hbmMask, const POINT &pointMask, DWORD dwROP=SRCCOPY) const noexcept

BOOL	MaskBlt (HDC hDestDC, int xDest, int yDest, HBITMAP hbmMask, DWORD dwROP=SRCCOPY) const noexcept

BOOL	MaskBlt (HDC hDestDC, const POINT &pointDest, HBITMAP hbmMask, DWORD dwROP=SRCCOPY) const noexcept

BOOL	PlgBlt (HDC hDestDC, const POINT *pPoints, int xSrc, int ySrc, int nSrcWidth, int nSrcHeight, HBITMAP hbmMask=NULL, int xMask=0, int yMask=0) const noexcept

BOOL	PlgBlt (HDC hDestDC, const POINT *pPoints, HBITMAP hbmMask=NULL) const noexcept

BOOL	PlgBlt (HDC hDestDC, const POINT *pPoints, const RECT &rectSrc, HBITMAP hbmMask, const POINT &pointMask) const noexcept

BOOL	PlgBlt (HDC hDestDC, const POINT *pPoints, const RECT &rectSrc, HBITMAP hbmMask=NULL) const noexcept

HRESULT	Save (IStream pStream, GUID guidFileType) const noexcept

HRESULT	Save (LPCTSTR pszFileName, REFGUID guidFileType=GUID_NULL) const noexcept

void	SetColorTable (UINT iFirstColor, UINT nColors, const RGBQUAD *prgbColors) noexcept

void	SetPixel (int x, int y, COLORREF color) noexcept

void	SetPixelIndexed (int x, int y, int iIndex) noexcept

void	SetPixelRGB (int x, int y, BYTE r, BYTE g, BYTE b) noexcept

COLORREF	SetTransparentColor (COLORREF rgbTransparent) noexcept

BOOL	StretchBlt (HDC hDestDC, int xDest, int yDest, int nDestWidth, int nDestHeight, int xSrc, int ySrc, int nSrcWidth, int nSrcHeight, DWORD dwROP=SRCCOPY) const noexcept

BOOL	StretchBlt (HDC hDestDC, int xDest, int yDest, int nDestWidth, int nDestHeight, DWORD dwROP=SRCCOPY) const noexcept

BOOL	StretchBlt (HDC hDestDC, const RECT &rectDest, DWORD dwROP=SRCCOPY) const noexcept

BOOL	StretchBlt (HDC hDestDC, const RECT &rectDest, const RECT &rectSrc, DWORD dwROP=SRCCOPY) const noexcept

BOOL	TransparentBlt (HDC hDestDC, int xDest, int yDest, int nDestWidth, int nDestHeight, int xSrc, int ySrc, int nSrcWidth, int nSrcHeight, UINT crTransparent=CLR_INVALID) const noexcept

BOOL	TransparentBlt (HDC hDestDC, int xDest, int yDest, int nDestWidth, int nDestHeight, UINT crTransparent=CLR_INVALID) const noexcept

BOOL	TransparentBlt (HDC hDestDC, const RECT &rectDest, UINT crTransparent=CLR_INVALID) const noexcept

BOOL	TransparentBlt (HDC hDestDC, const RECT &rectDest, const RECT &rectSrc, UINT crTransparent=CLR_INVALID) const noexcept

Static Public Member Functions
static void	ReleaseGDIPlus ()

static BOOL	IsTransparencySupported () noexcept

static HRESULT	GetImporterFilterString (CSimpleString &strImporters, CSimpleArray< GUID > &aguidFileTypes, LPCTSTR pszAllFilesDescription=NULL, DWORD dwExclude=excludeDefaultLoad, TCHAR chSeparator=TEXT('\|'))

static HRESULT	GetExporterFilterString (CSimpleString &strExporters, CSimpleArray< GUID > &aguidFileTypes, LPCTSTR pszAllFilesDescription=NULL, DWORD dwExclude=excludeDefaultSave, TCHAR chSeparator=TEXT('\|'))

Private Member Functions
LPCWSTR	GetFileExtension (LPCWSTR pszFileName) const

COLORREF	RGBFromPaletteIndex (int iIndex) const

void	AttachInternal (HBITMAP hBitmap, DIBOrientation eOrientation, LONG iTransColor) noexcept

BOOL	CreateInternal (int nWidth, int nHeight, int nBPP, DWORD eCompression, const DWORD *pdwBitmasks=NULL, DWORD dwFlags=0) noexcept

	CImage (const CImage &)=delete

CImage &	operator= (const CImage &)=delete

Static Private Member Functions
static bool	ShouldExcludeFormat (REFGUID guidFileType, DWORD dwExclude)

static HRESULT	BuildCodecFilterString (const Gdiplus::ImageCodecInfo *pCodecs, UINT cCodecs, CSimpleString &strFilter, CSimpleArray< GUID > &aguidFileTypes, LPCTSTR pszAllFilesDescription, DWORD dwExclude, TCHAR chSeparator)

static bool	InitGDIPlus () noexcept

static CLSID	FindCodecForExtension (LPCTSTR dotext, const Gdiplus::ImageCodecInfo *pCodecs, UINT nCodecs)

static CLSID	FindCodecForFileType (REFGUID guidFileType, const Gdiplus::ImageCodecInfo *pCodecs, UINT nCodecs)

static Gdiplus::ImageCodecInfo *	_getAllEncoders (UINT &cEncoders)

static Gdiplus::ImageCodecInfo *	_getAllDecoders (UINT &cDecoders)

Private Attributes
HBITMAP	m_hBitmap = NULL

HBITMAP	m_hOldBitmap = NULL

INT	m_nWidth = 0

INT	m_nHeight = 0

INT	m_nPitch = 0

INT	m_nBPP = 0

LPVOID	m_pBits = NULL

BOOL	m_bHasAlphaChannel = FALSE

BOOL	m_bIsDIBSection = FALSE

COLORREF	m_clrTransparentColor = CLR_INVALID

HDC	m_hDC = NULL

LONG	m_nDCRefCount = 0

Static Private Attributes
static CInitGDIPlus	s_gdiplus

Detailed Description

Definition at line 23 of file atlimage.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
createAlphaChannel

Definition at line 27 of file atlimage.h.

    {
        createAlphaChannel = 1      // enable alpha
    };

◆ DIBOrientation

enum ATL::CImage::DIBOrientation

Enumerator
DIBOR_DEFAULT
DIBOR_TOPDOWN
DIBOR_BOTTOMUP

Definition at line 33 of file atlimage.h.

    {
        DIBOR_DEFAULT,              // default
        DIBOR_TOPDOWN,              // top-down DIB
        DIBOR_BOTTOMUP              // bottom-up DIB
    };

◆ ExcludeFlags

enum ATL::CImage::ExcludeFlags

Enumerator
excludeGIF
excludeBMP
excludeEMF
excludeWMF
excludeJPEG
excludePNG
excludeTIFF
excludeIcon
excludeOther
excludeDefaultLoad
excludeDefaultSave

Definition at line 691 of file atlimage.h.

    {
        excludeGIF          = 0x01,
        excludeBMP          = 0x02,
        excludeEMF          = 0x04,
        excludeWMF          = 0x08,
        excludeJPEG         = 0x10,
        excludePNG          = 0x20,
        excludeTIFF         = 0x40,
        excludeIcon         = 0x80,
        excludeOther        = 0x80000000,
        excludeDefaultLoad  = 0,
        excludeDefaultSave  = excludeIcon | excludeEMF | excludeWMF
    };

Constructor & Destructor Documentation

◆ CImage() [1/2]

ATL::CImage::CImage ( )

inlinenoexcept

Definition at line 40 of file atlimage.h.

    {
        s_gdiplus.IncreaseCImageCount();
    }

◆ ~CImage()

virtual ATL::CImage::~CImage ( )

inlinevirtualnoexcept

Definition at line 45 of file atlimage.h.

    {
        Destroy();
        s_gdiplus.DecreaseCImageCount();
    }

◆ CImage() [2/2]

ATL::CImage::CImage ( const CImage & )

privatedelete

Member Function Documentation

◆ _getAllDecoders()

static Gdiplus::ImageCodecInfo * ATL::CImage::_getAllDecoders ( UINT & cDecoders )

inlinestaticprivate

Definition at line 1104 of file atlimage.h.

    {
        UINT total_size = 0;
        s_gdiplus.GetImageDecodersSize(&cDecoders, &total_size);
        if (total_size == 0)
            return NULL;  // failure
 
        Gdiplus::ImageCodecInfo *ret;
        ret = new Gdiplus::ImageCodecInfo[total_size / sizeof(ret[0])];
        if (ret == NULL)
        {
            cDecoders = 0;
            return NULL;  // failure
        }
 
        s_gdiplus.GetImageDecoders(cDecoders, total_size, ret);
        return ret; // needs delete[]
    }

Referenced by GetImporterFilterString().

◆ _getAllEncoders()

static Gdiplus::ImageCodecInfo * ATL::CImage::_getAllEncoders ( UINT & cEncoders )

inlinestaticprivate

Definition at line 1085 of file atlimage.h.

    {
        UINT total_size = 0;
        s_gdiplus.GetImageEncodersSize(&cEncoders, &total_size);
        if (total_size == 0)
            return NULL;  // failure
 
        Gdiplus::ImageCodecInfo *ret;
        ret = new Gdiplus::ImageCodecInfo[total_size / sizeof(ret[0])];
        if (ret == NULL)
        {
            cEncoders = 0;
            return NULL;  // failure
        }
 
        s_gdiplus.GetImageEncoders(cEncoders, total_size, ret);
        return ret; // needs delete[]
    }

Referenced by GetExporterFilterString(), and Save().

◆ AlphaBlend() [1/4]

BOOL ATL::CImage::AlphaBlend	(	HDC	hDestDC,
		const POINT &	pointDest,
		BYTE	bSrcAlpha = `0xFF`,
		BYTE	bBlendOp = `AC_SRC_OVER`
	)		const

inline

Definition at line 146 of file atlimage.h.

    {
        return AlphaBlend(hDestDC, pointDest.x, pointDest.y, bSrcAlpha, bBlendOp);
    }

◆ AlphaBlend() [2/4]

BOOL ATL::CImage::AlphaBlend	(	HDC	hDestDC,
		const RECT &	rectDest,
		const RECT &	rectSrc,
		BYTE	bSrcAlpha = `0xFF`,
		BYTE	bBlendOp = `AC_SRC_OVER`
	)		const

inline

Definition at line 151 of file atlimage.h.

    {
        return AlphaBlend(hDestDC, rectDest.left, rectDest.top,
                          rectDest.right - rectDest.left,
                          rectDest.bottom - rectDest.top,
                          rectSrc.left, rectSrc.top,
                          rectSrc.right - rectSrc.left,
                          rectSrc.bottom - rectSrc.top,
                          bSrcAlpha, bBlendOp);
    }

◆ AlphaBlend() [3/4]

BOOL ATL::CImage::AlphaBlend	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		BYTE	bSrcAlpha = `0xFF`,
		BYTE	bBlendOp = `AC_SRC_OVER`
	)		const

inline

Definition at line 138 of file atlimage.h.

    {
        int width = GetWidth();
        int height = GetHeight();
        return AlphaBlend(hDestDC, xDest, yDest, width, height, 0, 0,
                          width, height, bSrcAlpha, bBlendOp);
    }

◆ AlphaBlend() [4/4]

BOOL ATL::CImage::AlphaBlend	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		int	nDestWidth,
		int	nDestHeight,
		int	xSrc,
		int	ySrc,
		int	nSrcWidth,
		int	nSrcHeight,
		BYTE	bSrcAlpha = `0xFF`,
		BYTE	bBlendOp = `AC_SRC_OVER`
	)		const

inline

Definition at line 119 of file atlimage.h.

    {
        ATLASSERT(IsTransparencySupported());
 
        BLENDFUNCTION bf;
        bf.BlendOp = bBlendOp;
        bf.BlendFlags = 0;
        bf.SourceConstantAlpha = bSrcAlpha;
        bf.AlphaFormat = AC_SRC_ALPHA;
 
        GetDC();
        BOOL ret = ::AlphaBlend(hDestDC, xDest, yDest, nDestWidth, nDestHeight,
                                m_hDC, xSrc, ySrc, nSrcWidth, nSrcHeight, bf);
        ReleaseDC();
        return ret;
    }

◆ Attach()

void ATL::CImage::Attach	(	HBITMAP	hBitmap,
		DIBOrientation	eOrientation = `DIBOR_DEFAULT`
	)

inlinenoexcept

Definition at line 61 of file atlimage.h.

    {
        AttachInternal(hBitmap, eOrientation, -1);
    }

Referenced by Load(), LoadFromResource(), Test_BitmapEntry(), Test_CompatBitmapEntry(), and Test_DIBSectionEntry().

◆ AttachInternal()

void ATL::CImage::AttachInternal	(	HBITMAP	hBitmap,
		DIBOrientation	eOrientation,
		LONG	iTransColor
	)

inlineprivatenoexcept

Definition at line 1123 of file atlimage.h.

    {
        Destroy();
 
        DIBSECTION ds;
        BITMAP& bm = ds.dsBm;
 
        m_bIsDIBSection = (::GetObjectW(hBitmap, sizeof(ds), &ds) == sizeof(ds));
 
        if (!m_bIsDIBSection && !::GetObjectW(hBitmap, sizeof(bm), &bm))
            return;
 
        m_hBitmap = hBitmap;
        m_nWidth = bm.bmWidth;
        m_nHeight = bm.bmHeight;
        m_nBPP = bm.bmBitsPixel;
        m_bHasAlphaChannel = (bm.bmBitsPixel == 32);
        m_clrTransparentColor = CLR_INVALID;
 
        m_nPitch = 0;
        m_pBits = NULL;
        if (m_bIsDIBSection)
        {
            if (eOrientation == DIBOR_DEFAULT)
                eOrientation = ((ds.dsBmih.biHeight < 0) ? DIBOR_TOPDOWN : DIBOR_BOTTOMUP);
 
            LPBYTE pb = (LPBYTE)bm.bmBits;
            if (eOrientation == DIBOR_BOTTOMUP)
            {
                m_nPitch = -bm.bmWidthBytes;
                m_pBits = pb + bm.bmWidthBytes * (m_nHeight - 1);
            }
            else
            {
                m_nPitch = bm.bmWidthBytes;
                m_pBits = pb;
            }
        }
    }

Referenced by Attach(), and CreateInternal().

◆ BitBlt() [1/4]

BOOL ATL::CImage::BitBlt	(	HDC	hDestDC,
		const POINT &	pointDest,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 179 of file atlimage.h.

    {
        return BitBlt(hDestDC, pointDest.x, pointDest.y, dwROP);
    }

◆ BitBlt() [2/4]

BOOL ATL::CImage::BitBlt	(	HDC	hDestDC,
		const RECT &	rectDest,
		const POINT &	pointSrc,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 184 of file atlimage.h.

    {
        return BitBlt(hDestDC, rectDest.left, rectDest.top,
                      rectDest.right - rectDest.left,
                      rectDest.bottom - rectDest.top,
                      pointSrc.x, pointSrc.y, dwROP);
    }

◆ BitBlt() [3/4]

BOOL ATL::CImage::BitBlt	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 173 of file atlimage.h.

    {
        return BitBlt(hDestDC, xDest, yDest,
                      GetWidth(), GetHeight(), 0, 0, dwROP);
    }

◆ BitBlt() [4/4]

BOOL ATL::CImage::BitBlt	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		int	nDestWidth,
		int	nDestHeight,
		int	xSrc,
		int	ySrc,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 163 of file atlimage.h.

    {
        GetDC();
        BOOL ret = ::BitBlt(hDestDC, xDest, yDest, nDestWidth, nDestHeight,
                            m_hDC, xSrc, ySrc, dwROP);
        ReleaseDC();
        return ret;
    }

Referenced by BitBlt().

◆ BuildCodecFilterString()

static HRESULT ATL::CImage::BuildCodecFilterString	(	const Gdiplus::ImageCodecInfo *	pCodecs,
		UINT	cCodecs,
		CSimpleString &	strFilter,
		CSimpleArray< GUID > &	aguidFileTypes,
		LPCTSTR	pszAllFilesDescription,
		DWORD	dwExclude,
		TCHAR	chSeparator
	)

inlinestaticprivate

Definition at line 728 of file atlimage.h.

    {
        if (!pCodecs || !cCodecs)
        {
            strFilter += chSeparator;
            return E_FAIL;
        }
 
        if (pszAllFilesDescription)
        {
            strFilter += pszAllFilesDescription;
 
            BOOL bFirst = TRUE;
            CString extensions;
            for (UINT i = 0; i < cCodecs; ++i)
            {
                if (ShouldExcludeFormat(pCodecs[i].FormatID, dwExclude))
                    continue;
 
                if (bFirst)
                    bFirst = FALSE;
                else
                    extensions += TEXT(';');
 
                CString ext(pCodecs[i].FilenameExtension);
                extensions += ext;
            }
 
            strFilter += chSeparator;
            strFilter += extensions;
            strFilter += chSeparator;
 
            aguidFileTypes.Add(GUID_NULL);
        }
 
        for (UINT i = 0; i < cCodecs; ++i)
        {
            if (ShouldExcludeFormat(pCodecs[i].FormatID, dwExclude))
                continue;
 
            CString extensions(pCodecs[i].FilenameExtension);
 
            CString desc(pCodecs[i].FormatDescription);
            strFilter += desc;
            strFilter += TEXT(" (");
            strFilter += extensions;
            strFilter += TEXT(")");
            strFilter += chSeparator;
            strFilter += extensions;
            strFilter += chSeparator;
 
            aguidFileTypes.Add(pCodecs[i].FormatID);
        }
 
        strFilter += chSeparator;
        return S_OK;
    }

Referenced by GetExporterFilterString(), and GetImporterFilterString().

◆ Create()

BOOL ATL::CImage::Create	(	int	nWidth,
		int	nHeight,
		int	nBPP,
		DWORD	dwFlags = `0`
	)

inlinenoexcept

Definition at line 193 of file atlimage.h.

    {
        return CreateEx(nWidth, nHeight, nBPP, BI_RGB, NULL, dwFlags);
    }

◆ CreateEx()

BOOL ATL::CImage::CreateEx	(	int	nWidth,
		int	nHeight,
		int	nBPP,
		DWORD	eCompression,
		const DWORD *	pdwBitmasks = `NULL`,
		DWORD	dwFlags = `0`
	)

inlinenoexcept

Definition at line 198 of file atlimage.h.

    {
        return CreateInternal(nWidth, nHeight, nBPP, eCompression, pdwBitmasks, dwFlags);
    }

Referenced by Create().

◆ CreateInternal()

BOOL ATL::CImage::CreateInternal	(	int	nWidth,
		int	nHeight,
		int	nBPP,
		DWORD	eCompression,
		const DWORD *	pdwBitmasks = `NULL`,
		DWORD	dwFlags = `0`
	)

inlineprivatenoexcept

Definition at line 1164 of file atlimage.h.

    {
        ATLASSERT(nWidth != 0);
        ATLASSERT(nHeight != 0);
 
        // initialize BITMAPINFO extension
        MYBITMAPINFOEX bi;
        ZeroMemory(&bi, sizeof(bi));
        bi.bmiHeader.biSize = sizeof(BITMAPINFOHEADER);
        bi.bmiHeader.biWidth = nWidth;
        bi.bmiHeader.biHeight = nHeight;
        bi.bmiHeader.biPlanes = 1;
        bi.bmiHeader.biBitCount = nBPP;
        bi.bmiHeader.biCompression = eCompression;
 
        // is there alpha channel?
        bool bHasAlphaCh;
        bHasAlphaCh = (nBPP == 32 && (dwFlags & createAlphaChannel));
 
        // get orientation
        DIBOrientation eOrientation;
        eOrientation = ((nHeight > 0) ? DIBOR_BOTTOMUP : DIBOR_TOPDOWN);
 
        // does it have bit fields?
        if (eCompression == BI_BITFIELDS)
        {
            if (nBPP == 16 || nBPP == 32)
            {
                // store the mask data
                LPDWORD pdwMask = reinterpret_cast<LPDWORD>(bi.bmiColors);
                pdwMask[0] = pdwBitmasks[0];
                pdwMask[1] = pdwBitmasks[1];
                pdwMask[2] = pdwBitmasks[2];
            }
            else
            {
                return FALSE;
            }
        }
        else
        {
            ATLASSERT(pdwBitmasks == NULL);
            if (pdwBitmasks)
                return FALSE;
        }
 
        // create a DIB section
        HDC hDC = ::CreateCompatibleDC(NULL);
        ATLASSERT(hDC);
        HBITMAP hbm = ::CreateDIBSection(hDC, &bi, DIB_RGB_COLORS, NULL, NULL, 0);
        ATLASSERT(hbm);
        ::DeleteDC(hDC);
 
        // attach it
        AttachInternal(hbm, eOrientation, -1);
        m_bHasAlphaChannel = bHasAlphaCh;
 
        return hbm != NULL;
    }

Referenced by CreateEx().

◆ Destroy()

void ATL::CImage::Destroy ( )

inlinenoexcept

Definition at line 204 of file atlimage.h.

    {
        if (m_hBitmap)
        {
            ::DeleteObject(Detach());
        }
    }

Referenced by AttachInternal(), and ~CImage().

◆ Detach()

HBITMAP ATL::CImage::Detach ( )

inlinenoexcept

Definition at line 66 of file atlimage.h.

    {
        m_hOldBitmap = NULL;
        m_nWidth = m_nHeight = m_nPitch = m_nBPP = 0;
        m_pBits = NULL;
 
        m_bHasAlphaChannel = m_bIsDIBSection = FALSE;
        m_clrTransparentColor = CLR_INVALID;
 
        HBITMAP hBitmap = m_hBitmap;
        m_hBitmap = NULL;
        return hBitmap;
    }

Referenced by Destroy().

◆ Draw() [1/6]

BOOL ATL::CImage::Draw	(	HDC	hDestDC,
		const POINT &	pointDest
	)		const

inlinenoexcept

Definition at line 250 of file atlimage.h.

    {
        return Draw(hDestDC, pointDest.x, pointDest.y);
    }

◆ Draw() [2/6]

BOOL ATL::CImage::Draw	(	HDC	hDestDC,
		const RECT &	rectDest
	)		const

inlinenoexcept

Definition at line 260 of file atlimage.h.

    {
        return Draw(hDestDC, rectDest.left, rectDest.top,
                    rectDest.right - rectDest.left,
                    rectDest.bottom - rectDest.top);
    }

◆ Draw() [3/6]

BOOL ATL::CImage::Draw	(	HDC	hDestDC,
		const RECT &	rectDest,
		const RECT &	rectSrc
	)		const

inlinenoexcept

Definition at line 237 of file atlimage.h.

    {
        return Draw(hDestDC, rectDest.left, rectDest.top,
                    rectDest.right - rectDest.left,
                    rectDest.bottom - rectDest.top,
                    rectSrc.left, rectSrc.top,
                    rectSrc.right - rectSrc.left,
                    rectSrc.bottom - rectSrc.top);
    }

◆ Draw() [4/6]

BOOL ATL::CImage::Draw	(	HDC	hDestDC,
		int	xDest,
		int	yDest
	)		const

inlinenoexcept

Definition at line 246 of file atlimage.h.

    {
        return Draw(hDestDC, xDest, yDest, GetWidth(), GetHeight());
    }

◆ Draw() [5/6]

BOOL ATL::CImage::Draw	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		int	nDestWidth,
		int	nDestHeight
	)		const

inlinenoexcept

Definition at line 254 of file atlimage.h.

    {
        return Draw(hDestDC, xDest, yDest, nDestWidth, nDestHeight,
                    0, 0, GetWidth(), GetHeight());
    }

◆ Draw() [6/6]

BOOL ATL::CImage::Draw	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		int	nDestWidth,
		int	nDestHeight,
		int	xSrc,
		int	ySrc,
		int	nSrcWidth,
		int	nSrcHeight
	)		const

inlinenoexcept

Definition at line 212 of file atlimage.h.

    {
        ATLASSERT(IsTransparencySupported());
        if (m_bHasAlphaChannel)
        {
            return AlphaBlend(hDestDC, xDest, yDest, nDestWidth, nDestHeight,
                              xSrc, ySrc, nSrcWidth, nSrcHeight);
        }
        else if (m_clrTransparentColor != CLR_INVALID)
        {
            COLORREF rgb;
            if ((m_clrTransparentColor & 0xFF000000) == 0x01000000)
                rgb = RGBFromPaletteIndex(m_clrTransparentColor & 0xFF);
            else
                rgb = m_clrTransparentColor;
            return TransparentBlt(hDestDC, xDest, yDest, nDestWidth, nDestHeight,
                                  xSrc, ySrc, nSrcWidth, nSrcHeight, rgb);
        }
        else
        {
            return StretchBlt(hDestDC, xDest, yDest, nDestWidth, nDestHeight,
                              xSrc, ySrc, nSrcWidth, nSrcHeight);
        }
    }

Referenced by Draw().

◆ FindCodecForExtension()

static CLSID ATL::CImage::FindCodecForExtension	(	LPCTSTR	dotext,
		const Gdiplus::ImageCodecInfo *	pCodecs,
		UINT	nCodecs
	)

inlinestaticprivate

Definition at line 1042 of file atlimage.h.

    {
        for (UINT i = 0; i < nCodecs; ++i)
        {
            CString strSpecs(pCodecs[i].FilenameExtension);
            int ichOld = 0, ichSep;
            for (;;)
            {
                ichSep = strSpecs.Find(TEXT(';'), ichOld);
 
                CString strSpec;
                if (ichSep < 0)
                    strSpec = strSpecs.Mid(ichOld);
                else
                    strSpec = strSpecs.Mid(ichOld, ichSep - ichOld);
 
                int ichDot = strSpec.ReverseFind(TEXT('.'));
                if (ichDot >= 0)
                    strSpec = strSpec.Mid(ichDot);
 
                if (!dotext || strSpec.CompareNoCase(dotext) == 0)
                    return pCodecs[i].Clsid;
 
                if (ichSep < 0)
                    break;
 
                ichOld = ichSep + 1;
            }
        }
        return CLSID_NULL;
    }

Referenced by Save().

◆ FindCodecForFileType()

static CLSID ATL::CImage::FindCodecForFileType	(	REFGUID	guidFileType,
		const Gdiplus::ImageCodecInfo *	pCodecs,
		UINT	nCodecs
	)

inlinestaticprivate

Definition at line 1075 of file atlimage.h.

    {
        for (UINT iInfo = 0; iInfo < nCodecs; ++iInfo)
        {
            if (::IsEqualGUID(pCodecs[iInfo].FormatID, guidFileType))
                return pCodecs[iInfo].Clsid;
        }
        return CLSID_NULL;
    }

Referenced by Save().

◆ GetBits() [1/2]

const void * ATL::CImage::GetBits ( ) const

inlinenoexcept

Definition at line 273 of file atlimage.h.

    {
        return const_cast<CImage*>(this)->GetBits();
    }

◆ GetBits() [2/2]

void * ATL::CImage::GetBits ( )

inlinenoexcept

Definition at line 267 of file atlimage.h.

    {
        ATLASSERT(IsDIBSection());
        return m_pBits;
    }

Referenced by GetBits(), GetPixelAddress(), and Test_DIBSectionEntry().

◆ GetBPP()

int ATL::CImage::GetBPP ( ) const

inlinenoexcept

Definition at line 278 of file atlimage.h.

    {
        ATLASSERT(m_hBitmap);
        return m_nBPP;
    }

Referenced by GetPixelAddress(), IsIndexed(), Test_BitmapEntry(), Test_DIBSectionEntry(), and Test_ResBitmap().

◆ GetColorTable()

void ATL::CImage::GetColorTable	(	UINT	iFirstColor,
		UINT	nColors,
		RGBQUAD *	prgbColors
	)		const

inlinenoexcept

Definition at line 284 of file atlimage.h.

    {
        ATLASSERT(IsDIBSection());
        GetDC();
        ::GetDIBColorTable(m_hDC, iFirstColor, nColors, prgbColors);
        ReleaseDC();
    }

Referenced by RGBFromPaletteIndex(), and Test_DIBSectionEntry().

◆ GetDC()

HDC ATL::CImage::GetDC ( ) const

inlinenoexcept

Definition at line 80 of file atlimage.h.

    {
        ATLASSERT(m_nDCRefCount >= 0);
        if (::InterlockedIncrement(&m_nDCRefCount) == 1)
        {
            ATLASSERT(m_hDC == NULL);
            ATLASSERT(m_hOldBitmap == NULL);
 
            m_hDC = ::CreateCompatibleDC(NULL);
            ATLASSERT(m_hDC != NULL);
 
            m_hOldBitmap = (HBITMAP)::SelectObject(m_hDC, m_hBitmap);
            ATLASSERT(m_hOldBitmap != NULL);
        }
 
        return m_hDC;
    }

Referenced by AlphaBlend(), BitBlt(), GetColorTable(), GetPixel(), MaskBlt(), PlgBlt(), SetColorTable(), SetPixel(), SetPixelIndexed(), StretchBlt(), Test_DIBSectionEntry(), and TransparentBlt().

◆ GetExporterFilterString()

static HRESULT ATL::CImage::GetExporterFilterString	(	CSimpleString &	strExporters,
		CSimpleArray< GUID > &	aguidFileTypes,
		LPCTSTR	pszAllFilesDescription = `NULL`,
		DWORD	dwExclude = `excludeDefaultSave`,
		TCHAR	chSeparator = `TEXT('\|')`
	)

inlinestatic

Definition at line 817 of file atlimage.h.

    {
        if (!InitGDIPlus())
            return E_FAIL;
 
        UINT cEncoders = 0;
        Gdiplus::ImageCodecInfo* pEncoders = _getAllEncoders(cEncoders);
        HRESULT hr = BuildCodecFilterString(pEncoders,
                                            cEncoders,
                                            strExporters,
                                            aguidFileTypes,
                                            pszAllFilesDescription,
                                            dwExclude,
                                            chSeparator);
        delete[] pEncoders;
        return hr;
    }

Referenced by CMainWindow::GetSaveFileName(), and Test_Exporter().

◆ GetFileExtension()

LPCWSTR ATL::CImage::GetFileExtension ( LPCWSTR pszFileName ) const

inlineprivate

Definition at line 1024 of file atlimage.h.

    {
        LPCWSTR pch = wcsrchr(pszFileName, L'\\');
        if (pch == NULL)
            pch = wcsrchr(pszFileName, L'/');
        pch = (pch ? wcsrchr(pch, L'.') : wcsrchr(pszFileName, L'.'));
        return (pch ? pch : (pszFileName + ::lstrlenW(pszFileName)));
    }

Referenced by Save().

◆ GetHeight()

int ATL::CImage::GetHeight ( ) const

inlinenoexcept

Definition at line 293 of file atlimage.h.

    {
        ATLASSERT(m_hBitmap);
        return m_nHeight;
    }

Referenced by AlphaBlend(), BitBlt(), Draw(), MaskBlt(), PlgBlt(), StretchBlt(), Test_BitmapEntry(), Test_CompatBitmapEntry(), Test_DIBSectionEntry(), Test_ResBitmap(), and TransparentBlt().

◆ GetImporterFilterString()

static HRESULT ATL::CImage::GetImporterFilterString	(	CSimpleString &	strImporters,
		CSimpleArray< GUID > &	aguidFileTypes,
		LPCTSTR	pszAllFilesDescription = `NULL`,
		DWORD	dwExclude = `excludeDefaultLoad`,
		TCHAR	chSeparator = `TEXT('\|')`
	)

inlinestatic

Definition at line 794 of file atlimage.h.

    {
        if (!InitGDIPlus())
            return E_FAIL;
 
        UINT cDecoders = 0;
        Gdiplus::ImageCodecInfo* pDecoders = _getAllDecoders(cDecoders);
        HRESULT hr = BuildCodecFilterString(pDecoders,
                                            cDecoders,
                                            strImporters,
                                            aguidFileTypes,
                                            pszAllFilesDescription,
                                            dwExclude,
                                            chSeparator);
        delete[] pDecoders;
        return hr;
    }

Referenced by CMainWindow::GetOpenFileName(), and Test_Importer().

◆ GetMaxColorTableEntries()

int ATL::CImage::GetMaxColorTableEntries ( ) const

inlinenoexcept

Definition at line 299 of file atlimage.h.

    {
        ATLASSERT(IsDIBSection());
        switch (m_nBPP)
        {
            case 1: case 4: case 8:
                return (1 << m_nBPP);
 
            case 16: case 24: case 32:
            default:
                return 0;
        }
    }

Referenced by Test_DIBSectionEntry().

◆ GetPitch()

int ATL::CImage::GetPitch ( ) const

inlinenoexcept

Definition at line 313 of file atlimage.h.

    {
        ATLASSERT(IsDIBSection());
        return m_nPitch;
    }

Referenced by GetPixelAddress(), Test_DIBSectionEntry(), and Test_ResBitmap().

◆ GetPixel()

COLORREF ATL::CImage::GetPixel	(	int	x,
		int	y
	)		const

inlinenoexcept

Definition at line 319 of file atlimage.h.

    {
        GetDC();
        COLORREF ret = ::GetPixel(m_hDC, x, y);
        ReleaseDC();
        return ret;
    }

Referenced by GetPixel(), and Test_DIBSectionEntry().

◆ GetPixelAddress() [1/2]

const void * ATL::CImage::GetPixelAddress	(	int	x,
		int	y
	)		const

inlinenoexcept

Definition at line 336 of file atlimage.h.

    {
        return const_cast<CImage*>(this)->GetPixelAddress(x, y);
    }

◆ GetPixelAddress() [2/2]

void * ATL::CImage::GetPixelAddress	(	int	x,
		int	y
	)

inlinenoexcept

Definition at line 327 of file atlimage.h.

    {
        ATLASSERT(IsDIBSection());
        BYTE *pb = (BYTE *)GetBits();
        pb += GetPitch() * y;
        pb += (GetBPP() * x) / 8;
        return pb;
    }

Referenced by GetPixelAddress(), and Test_PixelAddress().

◆ GetTransparentColor()

COLORREF ATL::CImage::GetTransparentColor ( ) const

inlinenoexcept

Definition at line 341 of file atlimage.h.

    {
        return m_clrTransparentColor;
    }

Referenced by Test_DIBSectionEntry().

◆ GetWidth()

int ATL::CImage::GetWidth ( ) const

inlinenoexcept

Definition at line 346 of file atlimage.h.

    {
        ATLASSERT(m_hBitmap);
        return m_nWidth;
    }

Referenced by AlphaBlend(), BitBlt(), Draw(), MaskBlt(), PlgBlt(), StretchBlt(), Test_BitmapEntry(), Test_CompatBitmapEntry(), Test_DIBSectionEntry(), Test_ResBitmap(), and TransparentBlt().

◆ InitGDIPlus()

static bool ATL::CImage::InitGDIPlus ( )

inlinestaticprivatenoexcept

Definition at line 1005 of file atlimage.h.

    {
        return s_gdiplus.Init();
    }

Referenced by GetExporterFilterString(), GetImporterFilterString(), Load(), and Save().

◆ IsDIBSection()

bool ATL::CImage::IsDIBSection ( ) const

inlinenoexcept

Definition at line 352 of file atlimage.h.

    {
        ATLASSERT(m_hBitmap);
        return m_bIsDIBSection;
    }

Referenced by GetBits(), GetColorTable(), GetMaxColorTableEntries(), GetPitch(), GetPixelAddress(), IsIndexed(), SetColorTable(), Test_BitmapEntry(), Test_CompatBitmapEntry(), and Test_DIBSectionEntry().

◆ IsIndexed()

bool ATL::CImage::IsIndexed ( ) const

inlinenoexcept

Definition at line 358 of file atlimage.h.

    {
        ATLASSERT(IsDIBSection());
        return GetBPP() <= 8;
    }

Referenced by SetPixelIndexed().

◆ IsNull()

bool ATL::CImage::IsNull ( ) const

inlinenoexcept

Definition at line 364 of file atlimage.h.

    {
        return m_hBitmap == NULL;
    }

Referenced by Test_BitmapEntry(), Test_CompatBitmapEntry(), Test_DIBSectionEntry(), and Test_ResBitmap().

◆ IsTransparencySupported()

static BOOL ATL::CImage::IsTransparencySupported ( )

inlinestaticnoexcept

Definition at line 686 of file atlimage.h.

    {
        return TRUE;
    }

Referenced by AlphaBlend(), Draw(), MaskBlt(), PlgBlt(), and TransparentBlt().

◆ Load() [1/2]

HRESULT ATL::CImage::Load ( IStream * pStream )

inlinenoexcept

Definition at line 398 of file atlimage.h.

    {
        if (!InitGDIPlus())
            return E_FAIL;
 
        // create GpBitmap from stream
        using namespace Gdiplus;
        GpBitmap *pBitmap = NULL;
        if (s_gdiplus.CreateBitmapFromStream(pStream, &pBitmap) != Ok)
        {
            return E_FAIL;
        }
 
        // get bitmap handle
        HBITMAP hbm = NULL;
        Color color(0xFF, 0xFF, 0xFF);
        Status status = s_gdiplus.CreateHBITMAPFromBitmap(pBitmap, &hbm, color.GetValue());
 
        // delete Bitmap
        s_gdiplus.DisposeImage(pBitmap);
 
        // attach it
        if (status == Ok)
            Attach(hbm);
        return (status == Ok ? S_OK : E_FAIL);
    }

◆ Load() [2/2]

HRESULT ATL::CImage::Load ( LPCTSTR pszFileName )

inlinenoexcept

Definition at line 369 of file atlimage.h.

    {
        if (!InitGDIPlus())
            return E_FAIL;
 
        // convert the file name string into Unicode
        CStringW pszNameW(pszFileName);
 
        // create a GpBitmap object from file
        using namespace Gdiplus;
        GpBitmap *pBitmap = NULL;
        if (s_gdiplus.CreateBitmapFromFile(pszNameW, &pBitmap) != Ok)
        {
            return E_FAIL;
        }
 
        // get bitmap handle
        HBITMAP hbm = NULL;
        Color color(0xFF, 0xFF, 0xFF);
        Status status = s_gdiplus.CreateHBITMAPFromBitmap(pBitmap, &hbm, color.GetValue());
 
        // delete GpBitmap
        s_gdiplus.DisposeImage(pBitmap);
 
        // attach it
        if (status == Ok)
            Attach(hbm);
        return (status == Ok ? S_OK : E_FAIL);
    }

Referenced by Test_DIBSectionEntry().

◆ LoadFromResource() [1/2]

void ATL::CImage::LoadFromResource	(	HINSTANCE	hInstance,
		LPCTSTR	pszResourceName
	)

inlinenoexcept

Definition at line 426 of file atlimage.h.

    {
        HANDLE hHandle = ::LoadImage(hInstance, pszResourceName,
                                     IMAGE_BITMAP, 0, 0, LR_CREATEDIBSECTION);
        Attach(reinterpret_cast<HBITMAP>(hHandle));
    }

Referenced by LoadFromResource(), and Test_ResBitmap().

◆ LoadFromResource() [2/2]

void ATL::CImage::LoadFromResource	(	HINSTANCE	hInstance,
		UINT	nIDResource
	)

inlinenoexcept

Definition at line 432 of file atlimage.h.

    {
        LoadFromResource(hInstance, MAKEINTRESOURCE(nIDResource));
    }

◆ MaskBlt() [1/4]

BOOL ATL::CImage::MaskBlt	(	HDC	hDestDC,
		const POINT &	pointDest,
		HBITMAP	hbmMask,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 464 of file atlimage.h.

    {
        return MaskBlt(hDestDC, pointDest.x, pointDest.y, hbmMask, dwROP);
    }

◆ MaskBlt() [2/4]

BOOL ATL::CImage::MaskBlt	(	HDC	hDestDC,
		const RECT &	rectDest,
		const POINT &	pointSrc,
		HBITMAP	hbmMask,
		const POINT &	pointMask,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 450 of file atlimage.h.

    {
        return MaskBlt(hDestDC, rectDest.left, rectDest.top,
            rectDest.right - rectDest.left, rectDest.bottom - rectDest.top,
            pointSrc.x, pointSrc.y, hbmMask, pointMask.x, pointMask.y, dwROP);
    }

◆ MaskBlt() [3/4]

BOOL ATL::CImage::MaskBlt	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		HBITMAP	hbmMask,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 458 of file atlimage.h.

    {
        return MaskBlt(hDestDC, xDest, yDest, GetWidth(), GetHeight(),
                       0, 0, hbmMask, 0, 0, dwROP);
    }

◆ MaskBlt() [4/4]

BOOL ATL::CImage::MaskBlt	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		int	nDestWidth,
		int	nDestHeight,
		int	xSrc,
		int	ySrc,
		HBITMAP	hbmMask,
		int	xMask,
		int	yMask,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 437 of file atlimage.h.

    {
        ATLASSERT(IsTransparencySupported());
        GetDC();
        BOOL ret = ::MaskBlt(hDestDC, xDest, yDest, nDestWidth, nDestHeight,
                             m_hDC, xSrc, ySrc,
                             hbmMask, xMask, yMask, dwROP);
        ReleaseDC();
        return ret;
    }

Referenced by MaskBlt().

◆ operator HBITMAP()

ATL::CImage::operator HBITMAP ( )

inlinenoexcept

Definition at line 51 of file atlimage.h.

    {
        return m_hBitmap;
    }

◆ operator=()

CImage & ATL::CImage::operator= ( const CImage & )

privatedelete

◆ PlgBlt() [1/4]

BOOL ATL::CImage::PlgBlt	(	HDC	hDestDC,
		const POINT *	pPoints,
		const RECT &	rectSrc,
		HBITMAP	hbmMask,
		const POINT &	pointMask
	)		const

inlinenoexcept

Definition at line 489 of file atlimage.h.

    {
        return PlgBlt(hDestDC, pPoints, rectSrc.left, rectSrc.top,
            rectSrc.right - rectSrc.left, rectSrc.bottom - rectSrc.top,
            hbmMask, pointMask.x, pointMask.y);
    }

◆ PlgBlt() [2/4]

BOOL ATL::CImage::PlgBlt	(	HDC	hDestDC,
		const POINT *	pPoints,
		const RECT &	rectSrc,
		HBITMAP	hbmMask = `NULL`
	)		const

inlinenoexcept

Definition at line 496 of file atlimage.h.

    {
        POINT pointMask = {0, 0};
        return PlgBlt(hDestDC, pPoints, rectSrc, hbmMask, pointMask);
    }

◆ PlgBlt() [3/4]

BOOL ATL::CImage::PlgBlt	(	HDC	hDestDC,
		const POINT *	pPoints,
		HBITMAP	hbmMask = `NULL`
	)		const

inlinenoexcept

Definition at line 483 of file atlimage.h.

    {
        return PlgBlt(hDestDC, pPoints, 0, 0, GetWidth(), GetHeight(),
                      hbmMask);
    }

◆ PlgBlt() [4/4]

BOOL ATL::CImage::PlgBlt	(	HDC	hDestDC,
		const POINT *	pPoints,
		int	xSrc,
		int	ySrc,
		int	nSrcWidth,
		int	nSrcHeight,
		HBITMAP	hbmMask = `NULL`,
		int	xMask = `0`,
		int	yMask = `0`
	)		const

inlinenoexcept

Definition at line 470 of file atlimage.h.

    {
        ATLASSERT(IsTransparencySupported());
        GetDC();
        BOOL ret = ::PlgBlt(hDestDC, pPoints, m_hDC,
                            xSrc, ySrc, nSrcWidth, nSrcHeight,
                            hbmMask, xMask, yMask);
        ReleaseDC();
        return ret;
    }

Referenced by PlgBlt().

◆ ReleaseDC()

void ATL::CImage::ReleaseDC ( ) const

inlinenoexcept

Definition at line 98 of file atlimage.h.

    {
        ATLASSERT(m_nDCRefCount > 0);
 
        if (::InterlockedDecrement(&m_nDCRefCount) != 0)
            return;
 
        if (m_hOldBitmap)
        {
            ATLASSERT(m_hDC != NULL);
            ::SelectObject(m_hDC, m_hOldBitmap);
            m_hOldBitmap = NULL;
        }
 
        if (m_hDC)
        {
            ::DeleteDC(m_hDC);
            m_hDC = NULL;
        }
    }

Referenced by AlphaBlend(), BitBlt(), GetColorTable(), GetPixel(), MaskBlt(), PlgBlt(), SetColorTable(), SetPixel(), SetPixelIndexed(), StretchBlt(), Test_DIBSectionEntry(), TransparentBlt(), and ATL::CImageDC::~CImageDC().

◆ ReleaseGDIPlus()

static void ATL::CImage::ReleaseGDIPlus ( )

inlinestatic

Definition at line 56 of file atlimage.h.

    {
        s_gdiplus.ReleaseGDIPlus();
    }

◆ RGBFromPaletteIndex()

COLORREF ATL::CImage::RGBFromPaletteIndex ( int iIndex ) const

inlineprivate

Definition at line 1033 of file atlimage.h.

    {
        RGBQUAD table[256];
        GetColorTable(0, 256, table);
        RGBQUAD& quad =  table[iIndex];
        return RGB(quad.rgbRed, quad.rgbGreen, quad.rgbBlue);
    }

Referenced by Draw().

◆ Save() [1/2]

HRESULT ATL::CImage::Save	(	IStream *	pStream,
		GUID *	guidFileType
	)		const

inlinenoexcept

Definition at line 503 of file atlimage.h.

    {
        if (!InitGDIPlus())
            return E_FAIL;
 
        using namespace Gdiplus;
        ATLASSERT(m_hBitmap);
 
        // Get encoders
        UINT cEncoders = 0;
        ImageCodecInfo* pEncoders = _getAllEncoders(cEncoders);
 
        // Get Codec
        CLSID clsid = FindCodecForFileType(*guidFileType, pEncoders, cEncoders);
        delete[] pEncoders;
 
        // create a GpBitmap from HBITMAP
        GpBitmap *pBitmap = NULL;
        s_gdiplus.CreateBitmapFromHBITMAP(m_hBitmap, NULL, &pBitmap);
 
        // save to stream
        Status status;
        status = s_gdiplus.SaveImageToStream(pBitmap, pStream, &clsid, NULL);
 
        // destroy GpBitmap
        s_gdiplus.DisposeImage(pBitmap);
 
        return (status == Ok ? S_OK : E_FAIL);
    }

Referenced by Test_DIBSectionEntry().

◆ Save() [2/2]

HRESULT ATL::CImage::Save	(	LPCTSTR	pszFileName,
		REFGUID	guidFileType = `GUID_NULL`
	)		const

inlinenoexcept

Definition at line 533 of file atlimage.h.

    {
        if (!InitGDIPlus())
            return E_FAIL;
 
        using namespace Gdiplus;
        ATLASSERT(m_hBitmap);
 
        // convert the file name string into Unicode
        CStringW pszNameW(pszFileName);
 
        // Get encoders
        UINT cEncoders = 0;
        ImageCodecInfo* pEncoders = _getAllEncoders(cEncoders);
 
        // if the file type is null, get the file type from extension
        CLSID clsid;
        if (::IsEqualGUID(guidFileType, GUID_NULL))
        {
            CString strExt(GetFileExtension(pszNameW));
            clsid = FindCodecForExtension(strExt, pEncoders, cEncoders);
        }
        else
        {
            clsid = FindCodecForFileType(guidFileType, pEncoders, cEncoders);
        }
        delete[] pEncoders;
 
        // create a GpBitmap from HBITMAP
        GpBitmap *pBitmap = NULL;
        s_gdiplus.CreateBitmapFromHBITMAP(m_hBitmap, NULL, &pBitmap);
 
        // save to file
        Status status = s_gdiplus.SaveImageToFile(pBitmap, pszNameW, &clsid, NULL);
 
        // destroy GpBitmap
        s_gdiplus.DisposeImage(pBitmap);
 
        return (status == Ok ? S_OK : E_FAIL);
    }

◆ SetColorTable()

void ATL::CImage::SetColorTable	(	UINT	iFirstColor,
		UINT	nColors,
		const RGBQUAD *	prgbColors
	)

inlinenoexcept

Definition at line 575 of file atlimage.h.

    {
        ATLASSERT(IsDIBSection());
        GetDC();
        ::SetDIBColorTable(m_hDC, iFirstColor, nColors, prgbColors);
        ReleaseDC();
    }

◆ SetPixel()

void ATL::CImage::SetPixel	(	int	x,
		int	y,
		COLORREF	color
	)

inlinenoexcept

Definition at line 584 of file atlimage.h.

    {
        GetDC();
        ::SetPixelV(m_hDC, x, y, color);
        ReleaseDC();
    }

Referenced by SetPixelRGB(), and Test_DIBSectionEntry().

◆ SetPixelIndexed()

void ATL::CImage::SetPixelIndexed	(	int	x,
		int	y,
		int	iIndex
	)

inlinenoexcept

Definition at line 591 of file atlimage.h.

    {
        ATLASSERT(IsIndexed());
        GetDC();
        ::SetPixelV(m_hDC, x, y, PALETTEINDEX(iIndex));
        ReleaseDC();
    }

◆ SetPixelRGB()

void ATL::CImage::SetPixelRGB	(	int	x,
		int	y,
		BYTE	r,
		BYTE	g,
		BYTE	b
	)

inlinenoexcept

Definition at line 599 of file atlimage.h.

    {
        SetPixel(x, y, RGB(r, g, b));
    }

◆ SetTransparentColor()

COLORREF ATL::CImage::SetTransparentColor ( COLORREF rgbTransparent )

inlinenoexcept

Definition at line 604 of file atlimage.h.

    {
        ATLASSERT(m_hBitmap);
        COLORREF rgbOldColor = m_clrTransparentColor;
        m_clrTransparentColor = rgbTransparent;
        return rgbOldColor;
    }

◆ ShouldExcludeFormat()

static bool ATL::CImage::ShouldExcludeFormat	(	REFGUID	guidFileType,
		DWORD	dwExclude
	)

inlinestaticprivate

Definition at line 707 of file atlimage.h.

    {
        if (::IsEqualGUID(guidFileType, Gdiplus::ImageFormatGIF))
            return !!(dwExclude & excludeGIF);
        if (::IsEqualGUID(guidFileType, Gdiplus::ImageFormatBMP))
            return !!(dwExclude & excludeBMP);
        if (::IsEqualGUID(guidFileType, Gdiplus::ImageFormatEMF))
            return !!(dwExclude & excludeEMF);
        if (::IsEqualGUID(guidFileType, Gdiplus::ImageFormatWMF))
            return !!(dwExclude & excludeWMF);
        if (::IsEqualGUID(guidFileType, Gdiplus::ImageFormatJPEG))
            return !!(dwExclude & excludeJPEG);
        if (::IsEqualGUID(guidFileType, Gdiplus::ImageFormatPNG))
            return !!(dwExclude & excludePNG);
        if (::IsEqualGUID(guidFileType, Gdiplus::ImageFormatTIFF))
            return !!(dwExclude & excludeTIFF);
        if (::IsEqualGUID(guidFileType, Gdiplus::ImageFormatIcon))
            return !!(dwExclude & excludeIcon);
        return ((dwExclude & excludeOther) == excludeOther);
    }

Referenced by BuildCodecFilterString().

◆ StretchBlt() [1/4]

BOOL ATL::CImage::StretchBlt	(	HDC	hDestDC,
		const RECT &	rectDest,
		const RECT &	rectSrc,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 637 of file atlimage.h.

    {
        return StretchBlt(hDestDC, rectDest.left, rectDest.top,
                          rectDest.right - rectDest.left,
                          rectDest.bottom - rectDest.top,
                          rectSrc.left, rectSrc.top,
                          rectSrc.right - rectSrc.left,
                          rectSrc.bottom - rectSrc.top, dwROP);
    }

◆ StretchBlt() [2/4]

BOOL ATL::CImage::StretchBlt	(	HDC	hDestDC,
		const RECT &	rectDest,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 630 of file atlimage.h.

    {
        return StretchBlt(hDestDC, rectDest.left, rectDest.top,
                          rectDest.right - rectDest.left,
                          rectDest.bottom - rectDest.top, dwROP);
    }

◆ StretchBlt() [3/4]

BOOL ATL::CImage::StretchBlt	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		int	nDestWidth,
		int	nDestHeight,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 623 of file atlimage.h.

    {
        return StretchBlt(hDestDC, xDest, yDest, nDestWidth, nDestHeight,
                          0, 0, GetWidth(), GetHeight(), dwROP);
    }

◆ StretchBlt() [4/4]

BOOL ATL::CImage::StretchBlt	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		int	nDestWidth,
		int	nDestHeight,
		int	xSrc,
		int	ySrc,
		int	nSrcWidth,
		int	nSrcHeight,
		DWORD	dwROP = `SRCCOPY`
	)		const

inlinenoexcept

Definition at line 612 of file atlimage.h.

    {
        GetDC();
        BOOL ret = ::StretchBlt(hDestDC, xDest, yDest, nDestWidth, nDestHeight,
                                m_hDC, xSrc, ySrc, nSrcWidth, nSrcHeight, dwROP);
        ReleaseDC();
        return ret;
    }

Referenced by Draw(), and StretchBlt().

◆ TransparentBlt() [1/4]

BOOL ATL::CImage::TransparentBlt	(	HDC	hDestDC,
		const RECT &	rectDest,
		const RECT &	rectSrc,
		UINT	crTransparent = `CLR_INVALID`
	)		const

inlinenoexcept

Definition at line 676 of file atlimage.h.

    {
        return TransparentBlt(hDestDC, rectDest.left, rectDest.top,
            rectDest.right - rectDest.left, rectDest.bottom - rectDest.left,
            rectSrc.left, rectSrc.top, rectSrc.right - rectSrc.left,
            rectSrc.bottom - rectSrc.top, crTransparent);
    }

◆ TransparentBlt() [2/4]

BOOL ATL::CImage::TransparentBlt	(	HDC	hDestDC,
		const RECT &	rectDest,
		UINT	crTransparent = `CLR_INVALID`
	)		const

inlinenoexcept

Definition at line 669 of file atlimage.h.

    {
        return TransparentBlt(hDestDC, rectDest.left, rectDest.top,
                              rectDest.right - rectDest.left,
                              rectDest.bottom - rectDest.top, crTransparent);
    }

◆ TransparentBlt() [3/4]

BOOL ATL::CImage::TransparentBlt	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		int	nDestWidth,
		int	nDestHeight,
		int	xSrc,
		int	ySrc,
		int	nSrcWidth,
		int	nSrcHeight,
		UINT	crTransparent = `CLR_INVALID`
	)		const

inlinenoexcept

Definition at line 648 of file atlimage.h.

    {
        ATLASSERT(IsTransparencySupported());
        GetDC();
        BOOL ret = ::TransparentBlt(hDestDC, xDest, yDest,
                                    nDestWidth, nDestHeight,
                                    m_hDC, xSrc, ySrc,
                                    nSrcWidth, nSrcHeight, crTransparent);
        ReleaseDC();
        return ret;
    }

◆ TransparentBlt() [4/4]

BOOL ATL::CImage::TransparentBlt	(	HDC	hDestDC,
		int	xDest,
		int	yDest,
		int	nDestWidth,
		int	nDestHeight,
		UINT	crTransparent = `CLR_INVALID`
	)		const

inlinenoexcept

Definition at line 662 of file atlimage.h.

    {
        return TransparentBlt(hDestDC, xDest, yDest, nDestWidth, nDestHeight,
                              0, 0, GetWidth(), GetHeight(), crTransparent);
    }

Member Data Documentation

◆ m_bHasAlphaChannel

BOOL ATL::CImage::m_bHasAlphaChannel = FALSE

private

Definition at line 1018 of file atlimage.h.

Referenced by AttachInternal(), CreateInternal(), Detach(), and Draw().

◆ m_bIsDIBSection

BOOL ATL::CImage::m_bIsDIBSection = FALSE

private

Definition at line 1019 of file atlimage.h.

Referenced by AttachInternal(), Detach(), and IsDIBSection().

◆ m_clrTransparentColor

COLORREF ATL::CImage::m_clrTransparentColor = CLR_INVALID

private

Definition at line 1020 of file atlimage.h.

Referenced by AttachInternal(), Detach(), Draw(), GetTransparentColor(), and SetTransparentColor().

◆ m_hBitmap

HBITMAP ATL::CImage::m_hBitmap = NULL

private

Definition at line 1011 of file atlimage.h.

Referenced by AttachInternal(), Destroy(), Detach(), GetBPP(), GetDC(), GetHeight(), GetWidth(), IsDIBSection(), IsNull(), operator HBITMAP(), Save(), and SetTransparentColor().

◆ m_hDC

HDC ATL::CImage::m_hDC = NULL

mutableprivate

Definition at line 1021 of file atlimage.h.

Referenced by AlphaBlend(), BitBlt(), GetColorTable(), GetDC(), GetPixel(), MaskBlt(), PlgBlt(), ReleaseDC(), SetColorTable(), SetPixel(), SetPixelIndexed(), StretchBlt(), and TransparentBlt().

◆ m_hOldBitmap

HBITMAP ATL::CImage::m_hOldBitmap = NULL

mutableprivate

Definition at line 1012 of file atlimage.h.

Referenced by Detach(), GetDC(), and ReleaseDC().

◆ m_nBPP

INT ATL::CImage::m_nBPP = 0

private

Definition at line 1016 of file atlimage.h.

Referenced by AttachInternal(), Detach(), GetBPP(), and GetMaxColorTableEntries().

◆ m_nDCRefCount

LONG ATL::CImage::m_nDCRefCount = 0

mutableprivate

Definition at line 1022 of file atlimage.h.

Referenced by GetDC(), and ReleaseDC().

◆ m_nHeight

INT ATL::CImage::m_nHeight = 0

private

Definition at line 1014 of file atlimage.h.

Referenced by AttachInternal(), Detach(), and GetHeight().

◆ m_nPitch

INT ATL::CImage::m_nPitch = 0

private

Definition at line 1015 of file atlimage.h.

Referenced by AttachInternal(), Detach(), and GetPitch().

◆ m_nWidth

INT ATL::CImage::m_nWidth = 0

private

Definition at line 1013 of file atlimage.h.

Referenced by AttachInternal(), Detach(), and GetWidth().

◆ m_pBits

LPVOID ATL::CImage::m_pBits = NULL

private

Definition at line 1017 of file atlimage.h.

Referenced by AttachInternal(), Detach(), and GetBits().

◆ s_gdiplus

DECLSPEC_SELECTANY CImage::CInitGDIPlus ATL::CImage::s_gdiplus

staticprivate

Definition at line 1003 of file atlimage.h.

Referenced by _getAllDecoders(), _getAllEncoders(), CImage(), InitGDIPlus(), Load(), ReleaseGDIPlus(), Save(), and ~CImage().

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

sdk/lib/atl/atlimage.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ DIBOrientation

◆ ExcludeFlags

Constructor & Destructor Documentation

◆ CImage() [1/2]

◆ ~CImage()

◆ CImage() [2/2]

Member Function Documentation

◆ _getAllDecoders()

◆ _getAllEncoders()

◆ AlphaBlend() [1/4]

◆ AlphaBlend() [2/4]

◆ AlphaBlend() [3/4]

◆ AlphaBlend() [4/4]

◆ Attach()

◆ AttachInternal()

◆ BitBlt() [1/4]

◆ BitBlt() [2/4]

◆ BitBlt() [3/4]

◆ BitBlt() [4/4]

◆ BuildCodecFilterString()

◆ Create()

◆ CreateEx()

◆ CreateInternal()

◆ Destroy()

◆ Detach()

◆ Draw() [1/6]

◆ Draw() [2/6]

◆ Draw() [3/6]

◆ Draw() [4/6]

◆ Draw() [5/6]

◆ Draw() [6/6]

◆ FindCodecForExtension()

◆ FindCodecForFileType()

◆ GetBits() [1/2]

◆ GetBits() [2/2]

◆ GetBPP()

◆ GetColorTable()

◆ GetDC()

◆ GetExporterFilterString()

◆ GetFileExtension()

◆ GetHeight()

◆ GetImporterFilterString()

◆ GetMaxColorTableEntries()

◆ GetPitch()

◆ GetPixel()

◆ GetPixelAddress() [1/2]

◆ GetPixelAddress() [2/2]

◆ GetTransparentColor()

◆ GetWidth()

◆ InitGDIPlus()

◆ IsDIBSection()

◆ IsIndexed()

◆ IsNull()

◆ IsTransparencySupported()

◆ Load() [1/2]

◆ Load() [2/2]

◆ LoadFromResource() [1/2]

◆ LoadFromResource() [2/2]

◆ MaskBlt() [1/4]

◆ MaskBlt() [2/4]

◆ MaskBlt() [3/4]

◆ MaskBlt() [4/4]

◆ operator HBITMAP()

◆ operator=()

◆ PlgBlt() [1/4]

◆ PlgBlt() [2/4]

◆ PlgBlt() [3/4]

◆ PlgBlt() [4/4]

◆ ReleaseDC()