SFBDIB

Wrapper Class for the IDIB interface.

#include <SFBDIB.h.hpp>

class SFBDIB : public SFBBitmap;

SFMTYPEDEFWRAPPER(SFBDIB)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
O	O	O	O

Reference

BREW API IDIB

Member

Public Functions
`Void`	FlushPalette( `Void` ) This function flush the palette.
`BytePtr`	GetBuffer( `Void` ) Get the bitmap buffer.
`UInt08`	GetColorScheme( `Void` ) Get the Color Scheme.
`UInt08`	GetDepth( `Void` ) Get the size (bit number) of the pixels.
`UInt16`	GetHeight( `Void` ) Get the height of bitmap.
`UInt32Ptr`	GetPalette( `Void` ) Get the Color Palette.
`UInt16`	GetPaletteEntries( `Void` ) Get the number of Entries in Palette.
`SInt16`	GetPitch( `Void` ) Get the Pitch.
`SFXSize`	GetSize( `Void` ) Get the size of bitmap.
`NativeColor`	GetTransparent( `Void` ) Get the Transparent of bitmap.
`UInt16`	GetWidth( `Void` ) Get the width of bitmap.
static `SFBDIBSmp`	NewInstance( `SFBBitmapSmpConstRef` bitmap , `SFCErrorPtr` exception = null ) Create a new instance of SFBDIB class.
static `SFBDIBSmp`	NewInstance( `SFBBitmapSmpConstRef` bitmap , `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new instance of SFBDIB class.
`Void`	SetBuffer( `BytePtr` param ) Set the bitmap buffer.
`Void`	SetColorScheme( `UInt08` param ) Set the Color Scheme.
`Void`	SetDepth( `UInt08` param ) Set the size (bit number) of pixels.
`Void`	SetHeight( `UInt16` param ) Set the height of bitmap.
`Void`	SetPalette( `UInt32Ptr` param ) Set the Color Palette.
`Void`	SetPaletteEntries( `UInt16` param ) Set the number of Entries in Palette.
`Void`	SetPitch( `SInt16` param ) Set the Pitch.
`Void`	SetSize( `SFXSizeConstRef` param ) Set the size of bitmap.
`Void`	SetTransparent( `NativeColor` param ) Set the Transparent of bitmap.
`Void`	SetWidth( `UInt16` param ) Set the width of bitmap
`SFCError`	BltIn( `SInt32` xDest , `SInt32` yDest , `SInt32` dx , `SInt32` dy , `SFBBitmapSmpConstRef` bmpSrc , `SInt32` xSrc , `SInt32` ySrc , `AEERasterOp` rop = AEE_RO_COPY ) (inherits from SFBBitmap) Perform a bit-block transfer of the data corresponding to a rectangle of pixels from a specified source bitmap into this bitmap.
`SFCError`	BltIn( `SFXRectangleConstRef` rcDest , `SFBBitmapSmpConstRef` bmpSrc , `SFXGridConstRef` gridSrc , `AEERasterOp` rop = AEE_RO_COPY ) (inherits from SFBBitmap) Perform a bit-block transfer of the data corresponding to a rectangle of pixels from a specified source bitmap into this bitmap.
`SFCError`	BltIn( `SFXGridConstRef` gridDest , `SFXSizeConstRef` sizeDest , `SFBBitmapSmpConstRef` bmpSrc , `SFXGridConstRef` gridSrc , `AEERasterOp` rop = AEE_RO_COPY ) (inherits from SFBBitmap) Perform a bit-block transfer of the data corresponding to a rectangle of pixels from a specified source bitmap into this bitmap.
`SFCError`	BltOut( `SInt32` xDest , `SInt32` yDest , `SInt32` dx , `SInt32` dy , `SFBBitmapSmpConstRef` bmpDest , `SInt32` xSrc , `SInt32` ySrc , `AEERasterOp` rop = AEE_RO_COPY ) (inherits from SFBBitmap) Perform a bit-block transfer from this bitmap into a specified destination bitmap.
`SFCError`	BltOut( `SFXRectangleConstRef` rcDest , `SFBBitmapSmpConstRef` bmpDest , `SFXGridConstRef` gridSrc , `AEERasterOp` rop = AEE_RO_COPY ) (inherits from SFBBitmap) Perform a bit-block transfer from this bitmap into a specified destination bitmap.
`SFCError`	BltOut( `SFXGridConstRef` gridDest , `SFXSizeConstRef` sizeDest , `SFBBitmapSmpConstRef` bmpDest , `SFXGridConstRef` gridSrc , `AEERasterOp` rop = AEE_RO_COPY ) (inherits from SFBBitmap) Perform a bit-block transfer from this bitmap into a specified destination bitmap.
`NativeColor`	ColorToNative( `SFXRGBColorConstRef` color ) (inherits from SFBBitmap) Convert RGB value into Native value.
`SFCError`	CreateCompatibleBitmap( `SFBBitmapSmpPtr` cloneBmp , `UInt16` width , `UInt16` height ) (inherits from SFBBitmap) Create a new bitmap compatible with this bitmap interface.
`SFBBitmapSmp`	CreateCompatibleBitmap( `SFXSizeConstRef` size ) (inherits from SFBBitmap) Create a new bitmap compatible with this bitmap interface.
`SFCError`	DrawHScanline( `UInt32` y , `UInt32` xMin , `UInt32` xMax , `NativeColor` color , `AEERasterOp` rop = AEE_RO_COPY ) (inherits from SFBBitmap) Draw horizon scan line.
`SFCError`	DrawPixel( `UInt32` x , `UInt32` y , `NativeColor` color , `AEERasterOp` rop = AEE_RO_COPY ) (inherits from SFBBitmap) Draws a single pixel in the bitamp.
`SFCError`	DrawPixel( `SFXPixelConstRef` pixel , `NativeColor` color , `AEERasterOp` rop = AEE_RO_COPY ) (inherits from SFBBitmap) Draws a single pixel in the bitamp.
`SFCError`	FillRect( `SFXRectangleConstRef` rect , `NativeColor` color , `AEERasterOp` rop = AEE_RO_COPY ) (inherits from SFBBitmap) Draw a solid rectangle of a specified color.
`SFCError`	GetInfo( `AEEBitmapInfo*` bmpInfo , `SInt32` size = sizeof(AEEBitmapInfo) ) (inherits from SFBBitmap) Retrieve the dimension of the bitmap.
`SFCError`	GetPixel( `UInt32` x , `UInt32` y , `NativeColor*` color ) (inherits from SFBBitmap) Retrieves the value of a specified pixel.
`SFCError`	GetPixel( `SFXPixelConstRef` pixel , `NativeColor*` color ) (inherits from SFBBitmap) Retrieves the value of a specified pixel.
`NativeColor`	GetPixel( `SFXPixelConstRef` pixel ) (inherits from SFBBitmap) Retrieves the value of a specified pixel.
`SFCError`	GetTransparencyColor( `NativeColor*` color ) (inherits from SFBBitmap) Get the current transparency color of the bitmap. This is used when this bitmap is the source bitmap of a transparent bit blit operation.
`NativeColor`	GetTransparencyColor( `Void` ) (inherits from SFBBitmap) Get the current transparency color of the bitmap. This is used when this bitmap is the source bitmap of a transparent bit blit operation.
`SFCError`	Invalidate( `SFXRectangleConstRef` rect ) (inherits from SFBBitmap) Expand the bitmap's dirty rectangle to include the rectangle passed in the rect parameter.
`Void`	NativeToColor( `NativeColor` nativeColor , `SFXRGBColorPtr` sfxColor ) (inherits from SFBBitmap) Convert Native value into the RGB value.
`SFXRGBColor`	NativeToColor( `NativeColor` color ) (inherits from SFBBitmap) Convert Native value into the RGB value.
`RGBVAL`	NativeToRGB( `NativeColor` color ) (inherits from SFBBitmap) Convert Native color into RGB color.
`SFBBitmapRotSmp`	QueryBitmapRotation( `Void` ) (inherits from SFBBitmap) Query a instance of SFBBitmapRot class (This function is SophiaFramework Extension).
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`NativeColor`	RGBToNative( `RGBVAL` color ) (inherits from SFBBitmap) Convert RGB color into Native color.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFCError`	SetPixels( `UInt32` count , `SFXPixelPtr` pixels , `NativeColor` color , `AEERasterOp` rop = AEE_RO_COPY ) (inherits from SFBBitmap) Draws multiple pixels with the same color.
`SFCError`	SetTransparencyColor( `NativeColor` color ) (inherits from SFBBitmap) Set the transparency color of the bitmap.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for a specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for a specified ClassID's interface using the SFBQuery instance.

SFBDIB::FlushPalette

This function flush the palette.

[ public ]
Void FlushPalette(Void);

Reference

BREW API IDIB_FlushPalette

SFBDIB::GetBuffer

Get the bitmap buffer.

[ public ]
BytePtr GetBuffer(Void);

Return Values

Returns a pointer to pixels matrix.

Reference

SFBDIB::SetBuffer | BREW API IDIB

SFBDIB::GetColorScheme

Get the Color Scheme.

[ public, const ]
UInt08 GetColorScheme(Void);

Reference

SFBDIB::SetColorScheme | BREW API IDIB

SFBDIB::GetDepth

Get the size (bit number) of the pixels.

[ public, const ]
UInt08 GetDepth(Void);

Reference

SFBDIB::SetDepth | BREW API IDIB

SFBDIB::GetHeight

Get the height of bitmap.

[ public, const ]
UInt16 GetHeight(Void);

Reference

SFBDIB::SetHeight | BREW API IDIB

SFBDIB::GetPalette

Get the Color Palette.

[ public ]
UInt32Ptr GetPalette(Void);

Reference

SFBDIB::SetPalette | BREW API IDIB

SFBDIB::GetPaletteEntries

Get the number of Entries in Palette.

[ public, const ]
UInt16 GetPaletteEntries(Void);

Reference

SFBDIB::SetPaletteEntries | BREW API IDIB

SFBDIB::GetPitch

Get the Pitch.

[ public, const ]
SInt16 GetPitch(Void);

Reference

SFBDIB::SetPitch | BREW API IDIB

SFBDIB::GetSize

Get the size of bitmap.

[ public, const ]
SFXSize GetSize(Void);

Reference

SFBDIB::SetSize

SFBDIB::GetTransparent

Get the Transparent of bitmap.

[ public, const ]
NativeColor GetTransparent(Void);

Reference

SFBDIB::SetTransparent | BREW API IDIB

SFBDIB::GetWidth

Get the width of bitmap.

[ public, const ]
UInt16 GetWidth(Void);

Reference

SFBDIB::SetWidth | BREW API IDIB

SFBDIB::NewInstance

Create a new instance of SFBDIB class.

[ public, static ]
SFBDIBSmp NewInstance(
    SFBBitmapSmpConstRef bitmap    // bitmap to get the SFBDIB instance
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBDIBSmp NewInstance(
    SFBBitmapSmpConstRef bitmap    // bitmap to get the SFBDIB instance
    AEECLSID id                    // Class ID for the IDIB interface
    SFCErrorPtr exception = null   // Error
);

SFBDIB::SetBuffer

Set the bitmap buffer.

[ public ]
Void SetBuffer(
    BytePtr param   // pointer to poxels matrix
);

Description

	Warning
	This function is the accessor of IDIB Structure. The other menber variables could not be set by running this function.

Reference

SFBDIB::GetBuffer | BREW API IDIB

SFBDIB::SetColorScheme

Set the Color Scheme.

[ public ]
Void SetColorScheme(
    UInt08 param   // color Scheme to set
);

Description

	Warning
	This function is the accessor of IDIB Structure. The other menber variables could not be set by running this function.

Reference

SFBDIB::GetColorScheme | BREW API IDIB

SFBDIB::SetDepth

Set the size (bit number) of pixels.

[ public ]
Void SetDepth(
    UInt08 param   // size to set
);

Description

	Warning
	This function is the accessor of IDIB Structure. The other menber variables could not be set by running this function.

Reference

SFBDIB::GetDepth | BREW API IDIB

SFBDIB::SetHeight

Set the height of bitmap.

[ public ]
Void SetHeight(
    UInt16 param   // height to set
);

Description

	Warning
	This function is the accessor of IDIB Structure. The other menber variables could not be set by running this function.

Reference

SFBDIB::GetHeight | BREW API IDIB

SFBDIB::SetPalette

Set the Color Palette.

[ public ]
Void SetPalette(
    UInt32Ptr param   // palette to set
);

Description

	Warning
	This function is the accessor of IDIB Structure. The other menber variables could not be set by running this function.

Reference

SFBDIB::GetPalette | BREW API IDIB

SFBDIB::SetPaletteEntries

Set the number of Entries in Palette.

[ public ]
Void SetPaletteEntries(
    UInt16 param   // entry number to set
);

Description

	Warning
	This function is the accessor of IDIB Structure. The other menber variables could not be set by running this function.

Reference

SFBDIB::GetPaletteEntries | BREW API IDIB

SFBDIB::SetPitch

Set the Pitch.

[ public ]
Void SetPitch(
    SInt16 param   // pitch to set
);

Description

	Warning
	This function is the accessor of IDIB Structure. The other menber variables could not be set by running this function.

Reference

SFBDIB::GetPitch | BREW API IDIB

SFBDIB::SetSize

Set the size of bitmap.

[ public ]
Void SetSize(
    SFXSizeConstRef param   // size to set
);

Description

	Warning
	This function is the accessor of IDIB Structure. The other menber variables could not be set by running this function.

Reference

SFBDIB::GetSize | BREW API IDIB

SFBDIB::SetTransparent

Set the Transparent of bitmap.

[ public ]
Void SetTransparent(
    NativeColor param   // transparent to set
);

Description

	Warning
	This function is the accessor of IDIB Structure. The other menber variables could not be set by running this function.

Reference.

SFBDIB::GetTransparent | BREW API IDIB

SFBDIB::SetWidth

Set the width of bitmap

[ public ]
Void SetWidth(
    UInt16 param   // width to set
);

Description

	Warning
	This function is the accessor of IDIB Structure. The other menber variables could not be set by running this function.

Reference

SFBDIB::GetWidth | BREW API IDIB