Bitmap Class Reference

This reference page is linked to from the following overview topics:

---

Class Description

The main class for working with bitmaps.

Inheritance diagram for Bitmap:

Public Member Functions
def	ChannelsPresent
def	ClampColor
def	ClampColorA
def	ClampScaleColor
def	ClampScaleColorA
def	ClearFlag
def	Close
def	CloseAll
def	CopyImage
def	CreateChannels
def	CropImage
def	DeleteChannels
def	DeleteStorage
def	DeleteThis
def	Display
def	Fill
def	FromDib
def	GetAspect
def	GetFlags
def	GetGamma
def	GetHasFilter
def	GetHeight
def	GetMaxAlphaLevel
def	GetMaxRGBLevel
def	GetModifyID
def	GetScaleColors
def	GetStorage
def	GetWidth
def	GetWindow
def	GoTo
def	HasAlpha
def	HasPreMultipliedAlpha
def	IncrModifyID
def	IsDithered
def	IsHighDynamicRange
def	IsPaletted
def	OpenOutput
def	Print
def	ScaleColor
def	ScaleColorA
def	SetCroppingValues
def	SetDither
def	SetFilter
def	SetFlag
def	SetModifyID
def	SetScaleColors
def	SetStorage
def	ShowProgressLine
def	ToDib
def	ToggleFlag
def	UnDisplay
def	Write
def	WriteAll
Public Member Functions inherited from BaseInterfaceServer
def	GetInterfaceAt
def	GetNumInterfaces
Public Member Functions inherited from InterfaceServer
def	GetInterface
Public Member Functions inherited from Wrapper
def	GetUnwrappedPtr

Static Public Attributes
tuple	ClampColor = staticmethod(ClampColor)
tuple	ClampColorA = staticmethod(ClampColorA)
tuple	ScaleColor = staticmethod(ScaleColor)
tuple	ScaleColorA = staticmethod(ScaleColorA)
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from BaseInterfaceServer
tuple	Interfaces = _swig_property(lambda self: (self.GetInterfaceAt(i) for i in xrange(self.GetNumInterfaces())))
tuple	NumInterfaces = _swig_property(GetNumInterfaces)
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from InterfaceServer
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from Wrapper
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Member Function Documentation

def ChannelsPresent

(

self

)

ChannelsPresent(Bitmap self) -> ULONG

def ClampColor

(

args

)

ClampColor(Color64 outValue, HDRColor inValue)

def ClampColorA

(

args

)

ClampColorA(Color64 outValue, HDRColor inValue)

def ClampScaleColor	(		self,
			args
	)

ClampScaleColor(Bitmap self, Color64 outValue, HDRColor inValue)

def ClampScaleColorA	(		self,
			args
	)

ClampScaleColorA(Bitmap self, Color64 outValue, HDRColor inValue)

def ClearFlag	(		self,
			args
	)

ClearFlag(Bitmap self, DWORD flag)

def Close	(		self,
			args
	)

Close(Bitmap self, BitmapInfo bi, int flag=BMM_CLOSE_COMPLETE) -> bool
Close(Bitmap self, BitmapInfo bi) -> bool

def CloseAll	(		self,
			args
	)

CloseAll(Bitmap self, int flag=BMM_CLOSE_COMPLETE) -> bool
CloseAll(Bitmap self) -> bool

def CopyImage	(		self,
			args
	)

CopyImage(Bitmap self, Bitmap other, int operation, Color64 fillcolor) -> bool
CopyImage(Bitmap self, Bitmap other, int operation, HDRColor fillcolor) -> bool
CopyImage(Bitmap self, Bitmap other, int operation, int fillindex) -> bool

def CreateChannels	(		self,
			args
	)

CreateChannels(Bitmap self, ULONG channelIDs) -> ULONG

def CropImage	(		self,
			args
	)

CropImage(Bitmap self, int width, int height, Color64 fillcolor) -> bool
CropImage(Bitmap self, int width, int height, HDRColor fillcolor) -> bool
CropImage(Bitmap self, int width, int height, int fillindex) -> bool

def DeleteChannels	(		self,
			args
	)

DeleteChannels(Bitmap self, ULONG channelIDs)

def DeleteStorage

(

self

)

DeleteStorage(Bitmap self)

def DeleteThis

(

self

)

DeleteThis(Bitmap self)

def Display	(		self,
			args
	)

Display(Bitmap self, wchar_t const * title=None, int position=BMM_CN, bool autonomous=False, bool savebutton=True) -> bool
Display(Bitmap self, wchar_t const * title=None, int position=BMM_CN, bool autonomous=False) -> bool
Display(Bitmap self, wchar_t const * title=None, int position=BMM_CN) -> bool
Display(Bitmap self, wchar_t const * title=None) -> bool
Display(Bitmap self) -> bool

def Fill	(		self,
			args
	)

Fill(Bitmap self, int r, int g, int b, int alpha) -> bool
Fill(Bitmap self, HDRColor fillColor) -> bool
Fill(Bitmap self, Color64 fillColor) -> bool

def FromDib	(		self,
			args
	)

FromDib(Bitmap self, PBITMAPINFO pbmi) -> bool

def GetAspect

(

self

)

GetAspect(Bitmap self) -> float

def GetFlags

(

self

)

GetFlags(Bitmap self) -> DWORD

def GetGamma

(

self

)

GetGamma(Bitmap self) -> float

def GetHasFilter

(

self

)

GetHasFilter(Bitmap self) -> bool

def GetHeight

(

self

)

GetHeight(Bitmap self) -> int

def GetMaxAlphaLevel

(

self

)

GetMaxAlphaLevel(Bitmap self) -> int

def GetMaxRGBLevel

(

self

)

GetMaxRGBLevel(Bitmap self) -> int

def GetModifyID

(

self

)

GetModifyID(Bitmap self) -> DWORD

def GetScaleColors

(

self

)

GetScaleColors(Bitmap self) -> bool

def GetStorage

(

self

)

GetStorage(Bitmap self) -> BitmapStorage

def GetWidth

(

self

)

GetWidth(Bitmap self) -> int

def GetWindow

(

self

)

GetWindow(Bitmap self) -> HWND

def GoTo	(		self,
			args
	)

GoTo(Bitmap self, BitmapInfo bi) -> BMMRES

def HasAlpha

(

self

)

HasAlpha(Bitmap self) -> int

def HasPreMultipliedAlpha

(

self

)

HasPreMultipliedAlpha(Bitmap self) -> int

def IncrModifyID

(

self

)

IncrModifyID(Bitmap self)

def IsDithered

(

self

)

IsDithered(Bitmap self) -> int

def IsHighDynamicRange

(

self

)

IsHighDynamicRange(Bitmap self) -> int

def IsPaletted

(

self

)

IsPaletted(Bitmap self) -> int

def OpenOutput	(		self,
			args
	)

OpenOutput(Bitmap self, BitmapInfo bi) -> BMMRES

def Print	(		self,
			silent = False
	)

Print(Bitmap self, bool silent=False)
Print(Bitmap self)

def ScaleColor

(

args

)

ScaleColor(Color64 outValue, HDRColor inValue)

def ScaleColorA

(

args

)

ScaleColorA(Color64 outValue, HDRColor inValue)

def SetCroppingValues	(		self,
			args
	)

SetCroppingValues(Bitmap self, float u, float v, float w, float h, bool placeImage)

def SetDither	(		self,
			args
	)

SetDither(Bitmap self, UINT ditherType) -> bool

def SetFilter	(		self,
			args
	)

SetFilter(Bitmap self, UINT filterType) -> bool

def SetFlag	(		self,
			args
	)

SetFlag(Bitmap self, DWORD flag)

def SetModifyID	(		self,
			args
	)

SetModifyID(Bitmap self, DWORD m)

def SetScaleColors	(		self,
			args
	)

SetScaleColors(Bitmap self, bool on)

def SetStorage	(		self,
			args
	)

SetStorage(Bitmap self, BitmapStorage storage) -> bool

def ShowProgressLine	(		self,
			args
	)

ShowProgressLine(Bitmap self, int y)

def ToDib	(		self,
			depth = 24,
			gam = None,
			dither = True,
			displayGamma = True
	)

ToDib(Bitmap self, int depth=24, UWORD * gam=None, bool dither=True, bool displayGamma=True) -> PBITMAPINFO
ToDib(Bitmap self, int depth=24, UWORD * gam=None, bool dither=True) -> PBITMAPINFO
ToDib(Bitmap self, int depth=24, UWORD * gam=None) -> PBITMAPINFO
ToDib(Bitmap self, int depth=24) -> PBITMAPINFO
ToDib(Bitmap self) -> PBITMAPINFO

def ToggleFlag	(		self,
			args
	)

ToggleFlag(Bitmap self, DWORD flag)

def UnDisplay

(

self

)

UnDisplay(Bitmap self) -> bool

def Write	(		self,
			args
	)

Write(Bitmap self, BitmapInfo bi, int frame=BMM_SINGLEFRAME) -> BMMRES
Write(Bitmap self, BitmapInfo bi) -> BMMRES

def WriteAll	(		self,
			args
	)

WriteAll(Bitmap self, int frame=BMM_SINGLEFRAME) -> BMMRES
WriteAll(Bitmap self) -> BMMRES