KernelBitmap Class Reference

To encapsulate bitmaps, which are implemented in the OIL layer. Kernel code is only allowed to use this interface. OIL code is allowed to use the specific OILy functions that can be done via the OILBitmap pointer. More...

#include <bitmap.h>

Inheritance diagram for KernelBitmap:

List of all members.

Public Member Functions
	KernelBitmap (OILBitmap *pBitmap=NULL, BOOL Temp=FALSE)
	Constructor for kernel bitmaps. Attaches to the OILBitmap and increases its usage count.
	KernelBitmap (const KernelBitmap &)
	Copy constructor for kernel bitmaps. MAintains usage count on OILBitmap.
	KernelBitmap (UINT32, UINT32, UINT32, UINT32, BOOL Temp=FALSE)
	Constructor for kernel bitmaps which attaches it to a blank OILbitmap. Actually, the OILBitmap isn't really blank, it is entirely uninitialised i.e its contents will be random (including its palette if it has one).
	~KernelBitmap ()
	Destructor. Detaches any current OILBitmap.
INT32	operator== (const KernelBitmap &)
KernelBitmap &	operator= (const KernelBitmap &)
	Assigns one KernelBitmap to another while maintaining usage count on OILBitmap.
OILBitmap *	GetActualBitmap () const
BOOL	IsOK () const
	Tell if KernelBitmap is OK.
virtual BOOL	WritePalette (BaseCamelotFilter *pFilter)
	Exports the palette out to the file using the BaseCamelotFilter supplied. This means that it is being written to a web or native file. At present, used by the code when outputting an 8bpp JPEG to squirt the palette into the record so that we can convert it back to 8bpp using the palette on loading.
virtual BOOL	Convert24To8 (RGBTRIPLE *pPalette, UINT32 NumberOfPaletteEntries)
	Converts the OILbitmap from its present 24bpp form into an 8bpp form which should closely match the one that was exported.
void	PlotPixel (INT32 x, INT32 y, Pixel32bpp NewValue)
	Plots a 32bpp pixel to a deep bitmap (16, 24, or 32bpp).
void	PlotPixel (INT32 x, INT32 y, PixelGreyscale NewValue)
	Plots an 8bpp (0..255) pixel to any type of bitmap The pixel is taken to be a greyscale, and is truncated or expanded as appropriate to fit the greyscale value into the destination bitmap pixel format.
Pixel32bpp	ReadPixel32bpp (INT32 x, INT32 y, BOOL UsePalette=TRUE) const
	reads a pixel
INT32	ReturnPaletteIndexUsed (INT32 x, INT32 y) const
PixelGreyscale	ReadPixelGreyscale (INT32 x, INT32 y) const
	Reads a pixel as a greyscale intensity value (0..255).
ADDR	GetBitmapBits () const
	Helper function to get the actual bits (as in Bitmap).
BitmapList *	GetParentBitmapList ()
BOOL	IsUsedInDocument (Document *pDoc, BOOL bIncludeHidden=FALSE)
	Finds if this bitmap is being used in a specified document or not.
void	Attach (BitmapList *=NULL)
	Adds this kernel bitmap to the specified document bitmap list.
void	Detach ()
	Removes this kernel bitmap from it's current document bitmap list.
UINT32	GetWidth () const
	Finds the width of this bitmap.
UINT32	GetHeight () const
	Finds the height of this bitmap.
UINT32	GetBPP ()
	Finds the colour resolution of this bitmap.
UINT32	GetNumPaletteEntries () const
	Finds the number of colours colour in this bitmap.
INT32	GetRecommendedWidth ()
	Finds the recommended width of the bitmap.
INT32	GetRecommendedHeight ()
	Finds the recommended height of the bitmap.
void	SetRecommendedWidth (INT32)
	Sets the recommended width of the bitmap.
void	SetRecommendedHeight (INT32)
	Sets the recommended height of the bitmap.
BOOL	SetTransparencyIndex (INT32)
	Finds the Transparent index colour of a bitmap if one exists.
BOOL	GetTransparencyIndex (INT32 *pIndex)
	Finds the Transparent index colour of a bitmap if one exists.
BOOL	IsTransparent ()
	Determines if a bitmap is not totally opaque.
BOOL	IsDefaultBitmap ()
	To find out if the bitmap is the default bitmap or not. This is used by the native/web saving code to see if the bitmap is the default one and if so save a reference to it.
BOOL	HasBeenDeleted ()
	Tests whether or not the OIL bitmap attached to the kernel bitmap class has been deleted.
BOOL	IsGreyscale ()
	Finds if this bitmap is greyscale or not.
BOOL	IsLossy ()
	Finds if this bitmap is lossy or not.
void	SetOriginalSource (BitmapSource *pFileBuffer=NULL, BaseBitmapFilter *pImportFilter=NULL)
	Sets the original bitmap file associated with this reference.
BOOL	GetOriginalSource (BitmapSource **ppFileBuffer=NULL, BaseBitmapFilter **ppImportFilter=NULL)
	Gets the original bitmap file buffer associated with this reference.
BOOL	CreateGreyscaleVersion (BOOL ForceGreyBmp=FALSE)
	Creates a greyscale version of this bitmap.
BOOL	DestroyGreyscaleVersion ()
	Destroys the greyscale version of this bitmap.
OILBitmap *	GetGreyscaleVersion (BOOL ForceGreyBmp=FALSE)
	Gets the greyscale version of this bitmap.
OILBitmap *	ExtractOILBitmap ()
	Extracts the OILBitmap from this kernel bitmap AND DELETES THIS KERNEL BITMAP.
void	GenerateGreyscaleTable ()
BOOL	SetAsFractal ()
	Set this bitmap as a fractal bitmap.
BOOL	SetAsGreyscale ()
	Set this bitmap as a greyscale bitmap This is used to inform the bitmap that it is a greyscale 8bpp bitmap. This is because when we create a grteyscale OILBitmap and attach a KernelBitmap to it, there is no way to indicate to the system that it's a true greyscale bitmap, which is necessary to stop it farting around and making a new copy of the bitmap when someone calls GetGreyscaleVersion(). This is used by the airbrush stroke provider when it generates a greyscale bitmap for use as a transparency mask.
BOOL	SetAsLossy (BOOL bLossy=TRUE)
	Set this bitmap' lossy flag.
UINT32	GetDelay ()
	Returns m_AnimDelay for an OilBitmap.
void	SetDelay (UINT32 Delay)
	Sets the m_AnimDelay memeber for an OilBitmap.
BOOL	GetInterpolation ()
	Returns m_bInterpolation for an OilBitmap.
void	SetInterpolation (BOOL bInterpolation)
	Sets the m_bInterpolation member for an OilBitmap.
void	SetAnimationRestoreType (GIFDisposalMethod Type)
	Sets the GIF restore type for an OilBitmap.
GIFDisposalMethod	GetAnimationRestoreType () const
	Returns the GIF restore type for an OilBitmap.
void	SetLeftOffset (UINT32 LeftOffset)
	Sets the left offset for an OilBitmap.
UINT32	GetLeftOffset () const
	Gets the left offset for an OilBitmap.
void	SetTopOffset (UINT32 TopOffset)
	Sets the top offset for an OilBitmap.
UINT32	GetTopOffset () const
	Gets the top offset for an OilBitmap.
BOOL	IsBrowserPalette () const
	To see if the palette attached to this bitmap is browser compatible.
BOOL	ArePalettesTheSame (const LPLOGPALETTE pLogPalette, const INT32 TransColour=-1)
	To see if the palette attached to this bitmap is browser compatible. It runs through the colours in a browser palette and checks to see if they are all present. The ordering is not checked and so the palette may be different from the one that we actually use.
UINT32	GetHorizontalDPI () const
	Retrieve information on this bitmap.
UINT32	GetVerticalDPI () const
	Retrieve information on this bitmap.
void	SetName (String_256 &NewName)
	Set information on this bitmap.
String_256 &	GetName ()
	Retrieve information on this bitmap.
LPBITMAPINFO	GetBitmapInfo ()
	To get at the BITMAPINFO that this bitmap may have.
LPRGBQUAD	GetPaletteForBitmap ()
	To get at the RGBQUAD palette that this bitmap may have.
LPBITMAPINFOHEADER	GetBitmapInfoHeader ()
	To get at the BITMAPINFOHEADER that this bitmap should have.
void	SetUsedByBrush (BOOL Used)
BOOL	IsUsedByBrush ()
virtual void	SetXPEInfo (KernelBitmap *pMasterBitmap, IXMLDOMDocumentPtr pNewEditList)
	Sets the XPE edit list document for this bitmap.
virtual void	GetXPEInfo (KernelBitmap *&refMasterBitmap, IXMLDOMDocumentPtr &refEditList, BOOL bEnsureList=FALSE)
	Gets the stored XPE information for this bitmap.
virtual BOOL	IsXPEMaster ()
	Gets the XPE master status of this bitmap by searching the bitmap list.
virtual BOOL	DestroyXPEInfo ()
	Aks the user whether he wants to destroy XPE info.
virtual void	ReplaceOILBitmap (LPBYTE pBits, LPBITMAPINFO pInfo)
	Remove the OIL bitmap from memory if it can be constructed from master and edits.
Static Public Member Functions
static KernelBitmap *	MakeKernelBitmap (OILBitmap *pBitmap=NULL, Document *pDoc=NULL, BOOL bAlwaysNew=FALSE)
	Makes a KernelBitmap from an OIL bitmap. Will use an existing one if the OILBitmap is already in use in the Doc.
static void	SetCreateTracker (List *pList)
static BOOL	ImportBitmap (CCLexFile *pFile, BaseBitmapFilter *pBitmapFilter, BaseCamelotFilter *pFilter, BOOL IsCompressed, RGBTRIPLE *pPalette, UINT32 NumberOfPaletteEntries, KernelBitmap **ppImportedBitmap, BOOL *IsNew)
	Imports a bitmap, and checks to see if the bitmap already exist, returning a pointer to the existing bitmap if possible, or creates a new one.
static BOOL	ImportBitmap (Filter *pFilter, const BitmapInfo *pInfo, INT32 BitmapType, KernelBitmap **, BOOL *)
	Imports a bitmap, and checks to see if the bitmap already exist, returning a pointer to the existing bitmap if possible, or creates a new one.
static KernelBitmap *	TryAndUseExistingBitmap (OILBitmap *pOILBitmap, Document *pDoc, BOOL *IsNew)
	Imports a bitmap, and checks to see if the bitmap already exist, returning a pointer to the existing bitmap if possible, or creates a new one.
Public Attributes
OILBitmap *	ActualBitmap
Static Public Attributes
static List *	s_pTrackerList = NULL
Protected Attributes
BitmapList *	m_pParentList
BOOL	m_bDontDeleteActualBitmap: 1
BOOL	m_bFractalAttached: 1
BOOL	m_bUsedByBrush: 1
Friends
class	BitmapList

---

Detailed Description

To encapsulate bitmaps, which are implemented in the OIL layer. Kernel code is only allowed to use this interface. OIL code is allowed to use the specific OILy functions that can be done via the OILBitmap pointer.

Author:

Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>

Date:

11/8/94

Definition at line 483 of file bitmap.h.

---

Constructor & Destructor Documentation

KernelBitmap::KernelBitmap (  OILBitmap *  pBitmap = NULL, BOOL  IsTemp = FALSE )

Constructor for kernel bitmaps. Attaches to the OILBitmap and increases its usage count. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: ?/8/94 Parameters: Pointer  to an OIL bitmap. If NULL then uses default built-in bitmap. [INPUTS] Returns: Errors: - See also: KernelBitmap::IsOK;OILBitmap::Attach Definition at line 294 of file bitmap.cpp. { m_pParentList = NULL; m_bDontDeleteActualBitmap = FALSE; m_bFractalAttached = FALSE; m_bUsedByBrush = FALSE; if (pBitmap == NULL) ActualBitmap = OILBitmap::Attach(); else ActualBitmap = OILBitmap::Attach(pBitmap, IsTemp); if (ActualBitmap && ActualBitmap->IsAFractal()) m_bFractalAttached = TRUE; }

KernelBitmap::KernelBitmap (  const KernelBitmap &  other  )

Copy constructor for kernel bitmaps. MAintains usage count on OILBitmap. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: ?/8/94 Parameters: Another  kernel bitmap. [INPUTS] See also: KernelBitmap::IsOK;OILBitmap::Attach Definition at line 390 of file bitmap.cpp. { m_pParentList = NULL; m_bDontDeleteActualBitmap = FALSE; m_bFractalAttached = FALSE; m_bUsedByBrush = FALSE; ActualBitmap = OILBitmap::Attach( other.ActualBitmap, other.ActualBitmap->IsTemp() ); if (ActualBitmap && ActualBitmap->IsAFractal()) m_bFractalAttached = TRUE; }

KernelBitmap::KernelBitmap (  UINT32  Width, UINT32  Height, UINT32  Depth, UINT32  dpi, BOOL  bTemp = FALSE )

Constructor for kernel bitmaps which attaches it to a blank OILbitmap. Actually, the OILBitmap isn't really blank, it is entirely uninitialised i.e its contents will be random (including its palette if it has one). Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: ?/8/94 Parameters: Bitmap  pxiel width, height & depth and dpi setting. [INPUTS] Returns: Errors: Possible - SetError will be called, use IsOK for result. See also: KernelBitmap::IsOK;OILBitmap::Create Definition at line 417 of file bitmap.cpp. { m_pParentList = NULL; m_bDontDeleteActualBitmap = FALSE; m_bFractalAttached = FALSE; m_bUsedByBrush = FALSE; OILBitmap *bm = OILBitmap::Create( Width, Height, Depth, dpi ); if (bm) ActualBitmap = OILBitmap::Attach( bm, bTemp ); else ActualBitmap = NULL; }

KernelBitmap::~KernelBitmap (   )

Destructor. Detaches any current OILBitmap. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: ?/8/94 See also: OILBitmap::Detach Definition at line 458 of file bitmap.cpp. { if (m_pParentList != NULL) { // If we're still in the bitmap list, then remove us m_pParentList->RemoveItem(this); m_pParentList = NULL; } if (ActualBitmap) { ERROR3IF_OILBMP_PTR_INVALID(ActualBitmap, "Bitmap Error. Found a reference to a deleted bitmap."); // JustinF says: made the above check in retail builds as well, or we'll crash! if (//(INT32) ActualBitmap->m_pColourVersion != 0xFEEEFEEE && //(INT32) ActualBitmap->m_pColourVersion != 0xCDCDCDCD && //(INT32) ActualBitmap->m_pColourVersion != 0xDDDDDDDD && !m_bDontDeleteActualBitmap && !m_bFractalAttached && ActualBitmap->IsTemp()) { delete ActualBitmap; } // AndyH says: what a load of rubbish. // ActualBitmap->m_pColourVersion never evaluates to the constants // given above in the release build. In fact bug 6712 occurs because // we try to delete a KernelBitmap whose OILBitmap has already been // deleted; in turn, this function deletes ActualBitmap (an OILBitmap) // and causes an access violation. // By removing the above 'bodge', such access violations will occur in // debug mode too, as they should. ActualBitmap = NULL; } }

---

Member Function Documentation

BOOL KernelBitmap::ArePalettesTheSame (  const LPLOGPALETTE  pLogPalette, const INT32  TransColour = -1 )

To see if the palette attached to this bitmap is browser compatible. It runs through the colours in a browser palette and checks to see if they are all present. The ordering is not checked and so the palette may be different from the one that we actually use. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 03/07/97 Parameters: pLogPalette  A log palette to check the palette against [INPUTS] TransColour The transparent colour in the palette Returns: True if the bitmap has the same palette as the LOG palette. Definition at line 2017 of file bitmap.cpp. { if (ActualBitmap != NULL) return ActualBitmap->ArePalettesTheSame(pLogPalette, TransColour); return FALSE; }

void KernelBitmap::Attach (  BitmapList *  BmpList = NULL  )

Adds this kernel bitmap to the specified document bitmap list. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Parameters: The  bitmap list to attach this bitmap to. [INPUTS] if NULL then the bitmap is Re-Attached to its old list. -  [OUTPUTS] Returns: Errors: - See also: - Definition at line 1207 of file bitmap.cpp. { if (BmpList == NULL) BmpList = m_pParentList; ERROR3IF(BmpList == NULL, "Warning ... NULL BmpList in KernelBitmap::Attach"); if (BmpList == NULL) return; if (m_pParentList == NULL) { TRACEUSER( "Neville", _T("Attaching KBmp @ %x, to List at %x\n"), this, BmpList ); m_pParentList = BmpList; BmpList->AddItem(this); if (KernelBitmap::s_pTrackerList) { KernelBmpListItem* pItem = new KernelBmpListItem(this); if (pItem) KernelBitmap::s_pTrackerList->AddTail(pItem); } } ActualBitmap->RebuildXPEBitmap(); }

BOOL KernelBitmap::Convert24To8 (  RGBTRIPLE *  pPalette, UINT32  NumberOfPaletteEntries )  [virtual]

Converts the OILbitmap from its present 24bpp form into an 8bpp form which should closely match the one that was exported. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 4/9/96 Parameters: pPalette  - pointer to the palette in RGBTIPLE format to use when converting [INPUTS] NumberOfPaletteEntries - entries in this palette -  [OUTPUTS] Returns: True if worked ok, False otherwise Definition at line 735 of file bitmap.cpp. { ERROR2IF(pPalette == NULL,FALSE,"KernelBitmap::Convert24To8 null pFilter"); ERROR2IF(NumberOfPaletteEntries == 0,FALSE,"KernelBitmap::Convert24To8 NumberOfPaletteEntries = 0"); if (ActualBitmap == NULL) return FALSE; // If the bitmap is already 8bpp then do nothing if (GetBPP() == 8) return TRUE; return ActualBitmap->Convert24To8(pPalette, NumberOfPaletteEntries); }

BOOL KernelBitmap::CreateGreyscaleVersion (  BOOL  ForceGreyBmp = FALSE  )

Creates a greyscale version of this bitmap. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/96 Definition at line 1597 of file bitmap.cpp. { if (ActualBitmap == NULL) return FALSE; ERROR3IF_OILBMP_PTR_INVALID(ActualBitmap, "Bitmap Error. Found a reference to a deleted bitmap."); if (!IsGreyscale()) { // if (GetBPP() == 8 && !ForceGreyBmp) if (!ForceGreyBmp) { // If the bitmap is already a paletted bitmap, then we don't // need to generate a greyscale version, 'cus we can use some // clever palette manipulation GenerateGreyscaleTable(); } else { // Make a new grey level version of the bitmap OILBitmap* pOILBmp = DIBUtil::Create8bppGreyscaleBitmap(this); if (pOILBmp == NULL) return FALSE; pOILBmp->m_bIsGreyscale = TRUE; ActualBitmap->SetGreyscaleVersion(pOILBmp); } } return TRUE; }

BOOL KernelBitmap::DestroyGreyscaleVersion (   )

Destroys the greyscale version of this bitmap. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/96 Definition at line 1640 of file bitmap.cpp. { if (ActualBitmap == NULL) return FALSE; ERROR3IF_OILBMP_PTR_INVALID(ActualBitmap, "Bitmap Error. Found a reference to a deleted bitmap."); return ActualBitmap->DestroyGreyscaleVersion(); }

BOOL KernelBitmap::DestroyXPEInfo (   )  [virtual]

Aks the user whether he wants to destroy XPE info. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 30/01/2004 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if this bitmap has no XPE info or the user agreed it could be destroyed FALSE otherwise Definition at line 1530 of file bitmap.cpp. { if (ActualBitmap==NULL) return TRUE; PORTNOTETRACE("other","KernelBitmap::DestroyXPEInfo - do nothing"); #ifndef EXCLUDE_FROM_XARALX IXMLDOMDocumentPtr pEdits = NULL; OILBitmap* pMaster = NULL; ActualBitmap->GetXPEInfo(pMaster, pEdits); if (pEdits==NULL || pMaster==NULL) return TRUE; INT32 iButton = InformWarning(_R(IDS_XPE_DESTROY_MSG), _R(IDS_CONTINUE), _R(IDS_CANCEL)); if (iButton==1) { ActualBitmap->DestroyXPEInfo(); } return (iButton==1); #else return TRUE; #endif }

void KernelBitmap::Detach (   )

Removes this kernel bitmap from it's current document bitmap list. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: Errors: - See also: - Definition at line 1247 of file bitmap.cpp. { // For each document // If bitmap is used in document // Go though all the documents Document* pDoc = (Document*)GetApplication()->Documents.GetHead(); while (pDoc != NULL) { if (ActualBitmap->IsUsedInDocument(pDoc)) return; // Move onto the next document pDoc = (Document*)GetApplication()->Documents.GetNext(pDoc); } // If we got here then the bitmap is not used in any document // so we can safely vape its data if we can later rebuild it ActualBitmap->RemoveXPEBitmap(); }

OILBitmap * KernelBitmap::ExtractOILBitmap (   )

Extracts the OILBitmap from this kernel bitmap AND DELETES THIS KERNEL BITMAP. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/96 Definition at line 1662 of file bitmap.cpp. { if (ActualBitmap == NULL) return NULL; ERROR3IF_OILBMP_PTR_INVALID(ActualBitmap, "Bitmap Error. Found a reference to a deleted bitmap."); OILBitmap* pBmp = ActualBitmap; if (ActualBitmap->IsInGlobalList()) ActualBitmap->RemoveFromGlobalList(); #ifdef _DEBUG ActualBitmap->m_bIsAttached = FALSE; #endif m_bDontDeleteActualBitmap = TRUE; delete this; return pBmp; }

void KernelBitmap::GenerateGreyscaleTable (   )

Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/96 Definition at line 1726 of file bitmap.cpp. { // if (ActualBitmap == NULL || GetBPP() != 8) if (ActualBitmap == NULL || GetBPP()>8) return; ActualBitmap->GenerateGreyscaleTable(); }

OILBitmap* KernelBitmap::GetActualBitmap (   )  const [inline]

Definition at line 508 of file bitmap.h. { return ActualBitmap; }

GIFDisposalMethod KernelBitmap::GetAnimationRestoreType (   )  const

Returns the GIF restore type for an OilBitmap. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 14/04/97 Definition at line 1885 of file bitmap.cpp. { if (ActualBitmap != NULL) return ActualBitmap->GetAnimationRestoreType(); return GDM_LEAVE; }

ADDR KernelBitmap::GetBitmapBits (   )  const

Helper function to get the actual bits (as in Bitmap). Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/11/96 Returns: The address of the bits of this KernelBitmap NULL if an error occurred Errors: Checks runtime class Definition at line 1177 of file bitmap.cpp. { OILBitmap* pOILy = GetActualBitmap(); if (pOILy == NULL) { TRACE( _T("KernelBitmap::GetBitmapBits() - no OILBitmap") ); return NULL; } ERROR3IF(!pOILy->IS_KIND_OF(OILBitmap), "pOILy isn't"); return pOILy->GetBitmapBits(); }

LPBITMAPINFO KernelBitmap::GetBitmapInfo (   )

To get at the BITMAPINFO that this bitmap may have. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 03/07/97 Returns: The BITMAPINFO for this bitmap or null. BITMAPINFO consists of:- BITMAPINFOHEADER bmiHeader; RGBQUAD bmiColors[1]; This is the real bitmap info header giving the overall size of the export Note: Only use from Winoil code Definition at line 2131 of file bitmap.cpp. { if (ActualBitmap != NULL) return ActualBitmap->GetBitmapInfo(); return NULL; }

LPBITMAPINFOHEADER KernelBitmap::GetBitmapInfoHeader (   )

To get at the BITMAPINFOHEADER that this bitmap should have. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 03/07/97 Returns: The bitmap header for this bitmap or null. BITMAPINFO consists of:- BITMAPINFOHEADER bmiHeader; RGBQUAD bmiColors[1]; Note: Only use from Winoil code Definition at line 2182 of file bitmap.cpp. { if (ActualBitmap != NULL) return ActualBitmap->GetBitmapInfoHeader(); return NULL; }

UINT32 KernelBitmap::GetBPP (   )

Finds the colour resolution of this bitmap. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 12/1/95 Returns: The number of Bits per pixel of this bitmap Errors: - See also: - Definition at line 1280 of file bitmap.cpp. { if (ActualBitmap == NULL) return 0; ERROR3IF_OILBMP_PTR_INVALID(ActualBitmap,"Bitmap Error. Found a reference to a deleted bitmap."); return ActualBitmap->GetBPP(); }

UINT32 KernelBitmap::GetDelay (   )

Returns m_AnimDelay for an OilBitmap. Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> Date: 05/01/96 Definition at line 1818 of file bitmap.cpp. { if (ActualBitmap != NULL) return ActualBitmap->GetBitmapAnimDelay(); return 0; }

OILBitmap * KernelBitmap::GetGreyscaleVersion (  BOOL  ForceGreyBmp = FALSE  )

Gets the greyscale version of this bitmap. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/96 Definition at line 1695 of file bitmap.cpp. { if (ActualBitmap == NULL) return NULL; ERROR3IF_OILBMP_PTR_INVALID(ActualBitmap, "Bitmap Error. Found a reference to a deleted bitmap."); if (IsGreyscale()) return ActualBitmap; OILBitmap* pGreyBmp = ActualBitmap->GetGreyscaleVersion(); if (pGreyBmp == NULL) { // Make a greyscale bitmap CreateGreyscaleVersion(ForceGreyBmp); } return ActualBitmap->GetGreyscaleVersion(); }

UINT32 KernelBitmap::GetHeight (   )  const

Finds the height of this bitmap. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 8/7/97 Returns: The height of this bitmap Definition at line 1320 of file bitmap.cpp. { if (ActualBitmap == NULL) return 0; return ActualBitmap->GetHeight(); }

UINT32 KernelBitmap::GetHorizontalDPI (   )  const

Retrieve information on this bitmap. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/06/97 Returns: The Horizontal DPI of this bitmap Definition at line 2036 of file bitmap.cpp. { if (ActualBitmap != NULL) return ActualBitmap->GetHorizontalDPI(); return 96; }

BOOL KernelBitmap::GetInterpolation (   )

Returns m_bInterpolation for an OilBitmap. Author: Andy_Hills (Xara Group Ltd) <camelotdev@xara.com> Date: 06/10/00 Definition at line 1851 of file bitmap.cpp. { if (ActualBitmap != NULL) return ActualBitmap->GetInterpolation(); return 0; }

UINT32 KernelBitmap::GetLeftOffset (   )  const

Gets the left offset for an OilBitmap. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/06/97 Returns: the current left offset Definition at line 1938 of file bitmap.cpp. { if (ActualBitmap != NULL) return ActualBitmap->GetLeftOffset(); return 0; }

String_256 & KernelBitmap::GetName (   )

Retrieve information on this bitmap. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 20/06/97 Returns: The name of this bitmap Definition at line 2096 of file bitmap.cpp. { if (ActualBitmap != NULL) return ActualBitmap->GetName(); // In the "oh no where's the ActualBitmap" case // The old code used to be: // return String_256(""); // This static dummy object is used for returning in the error case // The original used to return a ptr to a local variable, which is a tad dangerous. // This solution is not ideal, because there's a permanent instance of an object // that will probably never be used. static String_256 Dummy(""); return Dummy; }

UINT32 KernelBitmap::GetNumPaletteEntries (   )  const

Finds the number of colours colour in this bitmap. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 8/7/97 Returns: The number of palette entries of this bitmap Definition at line 1339 of file bitmap.cpp. { if (ActualBitmap == NULL) return 0; return ActualBitmap->GetNumPaletteEntries(); }

BOOL KernelBitmap::GetOriginalSource (  BitmapSource **  pSource = NULL, BaseBitmapFilter **  ppImportFilter = NULL )

Gets the original bitmap file buffer associated with this reference. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 8/8/96 Parameters: pSource,ptr  to a void ptr to update to point at the original BitmapSource [INPUTS] ppFilterName, ptr to a BaseBitmapFilter ptr to update to point at the filter to use to decode the bitmap If both these inputs are NULL, then the function will simply return whether an original file exists or not. Parameters: The  input pointers are set if an original file is available, otherwise they [OUTPUTS] are left unchanged. Returns: TRUE, if an original file is available, and the pointers were set if non NULL. FALSE, if no orginal files is available. Definition at line 1399 of file bitmap.cpp. { if (ActualBitmap == NULL) return FALSE; ERROR3IF_OILBMP_PTR_INVALID(ActualBitmap, "Bitmap Error. Found a reference to a deleted bitmap."); // The OILBitmap has the reference in it return ActualBitmap->GetOriginalSource(pSource, ppImportFilter); }

LPRGBQUAD KernelBitmap::GetPaletteForBitmap (   )

To get at the RGBQUAD palette that this bitmap may have. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 03/07/97 Returns: The palette for this bitmap or null. BITMAPINFO consists of:- BITMAPINFOHEADER bmiHeader; RGBQUAD bmiColors[1]; This is the real bitmap info header giving the overall size of the export Note: Only use from Winoil code Definition at line 2157 of file bitmap.cpp. { if (ActualBitmap != NULL) return ActualBitmap->GetPaletteForBitmap(); return NULL; }

BitmapList* KernelBitmap::GetParentBitmapList (   )  [inline]

Definition at line 538 of file bitmap.h. { return m_pParentList; }

INT32 KernelBitmap::GetRecommendedHeight (   )

Finds the recommended height of the bitmap. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/96 Returns: The current recommended height of the bitmap in Millipoints Definition at line 1118 of file bitmap.cpp. { INT32 Height = 0; if (ActualBitmap) { Height = ActualBitmap->GetRecommendedHeight(); } return Height; }

INT32 KernelBitmap::GetRecommendedWidth (   )

Finds the recommended width of the bitmap. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/96 Returns: The current recommended width of the bitmap in Millipoints Definition at line 1095 of file bitmap.cpp. { INT32 Width = 0; if (ActualBitmap) { Width = ActualBitmap->GetRecommendedWidth(); } return Width; }

UINT32 KernelBitmap::GetTopOffset (   )  const

Gets the top offset for an OilBitmap. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/06/97 Returns: the current top offset Definition at line 1974 of file bitmap.cpp. { if (ActualBitmap != NULL) return ActualBitmap->GetTopOffset();