Class TAcceleratedBitmapSpec

class TAcceleratedBitmapSpec;

Description

A utility class that provides access to the contents of a bitmap.

The bitmap can be a hardware bitmap (RHardwareBitmap), or an ordinary bitmap (CFbsBitmap). An object of this class is used as a parameter by several accelerated graphics operations, e.g. TGopBitBlt, to specify the source bitmap for the operation.

Members

Defined in TAcceleratedBitmapSpec:

• EBitmapIsStatic
• EBitmapNeedsLocking
• EFbsBitmapThe bitmap is of type CFbsBitmap.
• EHardwareBitmapThe bitmap is of type RHardwareBitmap.
• ENoBitmapThe object was created using the default constructor, and has no type.
• GetInfo(TAcceleratedBitmapInfo &)const
• Handle()constReturns the handle to the bitmap.
• Lock(TBitmapLockCount &)Prevents a bitmap from moving in memory. TAcceleratedBitmapSpec::Lock(TBitmapLoc...
• Lock(TBitmapLockCount &,TAcceleratedBitmapInfo &)Prevents a bitmap from moving in memory. TAcceleratedBitmapSpec::Lock(TBitmapLoc...
• TAcceleratedBitmapLock
• TAcceleratedBitmapSpec()Default constructor. Use one of the other constructor overloads instead.
• TAcceleratedBitmapSpec(CFbsBitmap *)
• TAcceleratedBitmapSpec(RHardwareBitmap)
• TAcceleratedBitmapTypeIdentifies the type of the bitmap.
• Type()constReturns the type of the bitmap. The type is assigned during construction.
• Unlock(TBitmapLockCount &)Frees a bitmap after a call to TAcceleratedBitmapSpec::Lock(TBitmapLockCount &am...

inline TAcceleratedBitmapSpec();

Description

Default constructor. Use one of the other constructor overloads instead.

IMPORT_C TAcceleratedBitmapSpec(CFbsBitmap *aBitmap);

Description

Parameters

IMPORT_C TAcceleratedBitmapSpec(RHardwareBitmap aBitmap);

Description

Parameters

IMPORT_C TInt GetInfo(TAcceleratedBitmapInfo &aInfo) const;

Description

Parameters

Return value

inline void Lock(TBitmapLockCount &aCount);

Description

Prevents a bitmap from moving in memory. TAcceleratedBitmapSpec::Lock(TBitmapLockCount &) should be called before accessing the bitmap and TAcceleratedBitmapSpec::Unlock(TBitmapLockCount &) immediately afterwards. Although it is not necessary to lock and unlock some types of bitmap, it is a small overhead, and it is recommended that you always do it.

If a bitmap is already locked, all uses of the TAcceleratedBitmapSpec::Lock(TBitmapLockCount &) and TAcceleratedBitmapSpec::Unlock(TBitmapLockCount &) methods within the same thread must use the same TBitmapLockCount object, even if TAcceleratedBitmapSpec::Lock(TBitmapLockCount &) and TAcceleratedBitmapSpec::Unlock(TBitmapLockCount &) are called by different instances of TAcceleratedBitmapSpec.

Parameters

inline void Lock(TBitmapLockCount &aCount, TAcceleratedBitmapInfo &aInfo);

Description

Prevents a bitmap from moving in memory. TAcceleratedBitmapSpec::Lock(TBitmapLockCount &) should be called before accessing the bitmap and TAcceleratedBitmapSpec::Unlock(TBitmapLockCount &) immediately afterwards. Although it is not necessary to lock and unlock some types of bitmap, it is a small overhead, and it is recommended that you always do it. Also updates a TAcceleratedBitmapInfo structure with any information that may have changed, (typically the bitmap's memory address).

If a bitmap is already locked, all uses of the TAcceleratedBitmapSpec::Lock(TBitmapLockCount &) and TAcceleratedBitmapSpec::Unlock(TBitmapLockCount &) methods within the same thread must use the same TBitmapLockCount object, even if TAcceleratedBitmapSpec::Lock(TBitmapLockCount &) and TAcceleratedBitmapSpec::Unlock(TBitmapLockCount &) are called by different instances of TAcceleratedBitmapSpec.

Parameters

inline void Unlock(TBitmapLockCount &aCount);

Description

Frees a bitmap after a call to TAcceleratedBitmapSpec::Lock(TBitmapLockCount &). A call to TAcceleratedBitmapSpec::Unlock(TBitmapLockCount &) must be made for each corresponding call to TAcceleratedBitmapSpec::Lock(TBitmapLockCount &). This function should be called as soon as any bitmap access has finished. If, after the TAcceleratedBitmapSpec::Unlock(TBitmapLockCount &) operation, no more calls to TAcceleratedBitmapSpec::Lock(TBitmapLockCount &) are outstanding on the bitmap, the bitmap is free to be moved in memory again.

If a bitmap is already locked, all uses of the TAcceleratedBitmapSpec::Lock(TBitmapLockCount &) and TAcceleratedBitmapSpec::Unlock(TBitmapLockCount &) methods within the same thread must use the same TBitmapLockCount object, even if TAcceleratedBitmapSpec::Lock(TBitmapLockCount &) and TAcceleratedBitmapSpec::Unlock(TBitmapLockCount &) are called by different instances of TAcceleratedBitmapSpec.

Parameters

inline TAcceleratedBitmapType Type() const;

Description

Returns the type of the bitmap. The type is assigned during construction.

Return value

inline TInt Handle() const;

Description

Returns the handle to the bitmap.

Return value

TAcceleratedBitmapType

Description

Identifies the type of the bitmap.

TAcceleratedBitmapSpec::Type()const returns this value.

See also:

• CFbsBitmapNote that this class is not intended for user derivation. A bitmap managed by th...

TAcceleratedBitmapLock

Description