Class IBitonalBitmapData

Class IBitonalBitmapData#

Class Documentation#

class IBitonalBitmapData#

This interface is used to represent a bitonal bitmap - i.e. a bitmap where each pixel is represented by a single bit.

In order to access the pixel data, the Lock-method must be called. The information returned from the Lock-method is to be considered valid only until Unlock is called. If a bitmap is destroyed while it is locked, this is considered to be a fatal error. It is legal to call Lock multiple times, but the calls to Lock and Unlock must be balanced.

Public Functions

IBitonalBitmapData() = default#

Default constructor.

virtual IntSize GetSize() const = 0#

Gets the size of the bitmap (i.e. its width and height in pixels).

Returns:

The size (in pixels).

virtual BitonalBitmapLockInfo Lock() = 0#

Gets a data structure allowing for direct access of the bitmap.

Returns:

The BitmapLockInfo allowing to directly access the data representing the bitmap.

virtual void Unlock() = 0#

Inform the bitmap object that the data (previously retrieved by a call to Lock) is no longer used.

virtual int GetLockCount() const = 0#

Get the lock count. Note that this value is only momentarily valid.

Returns:

The lock count.

virtual ~IBitonalBitmapData() = default#
IBitonalBitmapData(const IBitonalBitmapData &other) = delete#

Copy-Constructor - deleted.

IBitonalBitmapData(IBitonalBitmapData &&other) noexcept = delete#

move constructor - deleted.

IBitonalBitmapData &operator=(IBitonalBitmapData &&other) noexcept = delete#

move assignment - deleted.

IBitonalBitmapData &operator=(const IBitonalBitmapData &other) = delete#

Copy assignment operator - deleted.

inline std::uint32_t GetWidth() const#

Gets the width of the bitmap in pixels.

Returns:

The width in pixels.

inline std::uint32_t GetHeight() const#

Gets the height of the bitmap in pixels.

Returns:

The height in pixels

Contents