libCZI
Reading and Writing CZI documents made easy
Loading...
Searching...
No Matches
libCZI::IBitmapData Class Referenceabstract

#include <libCZI_Pixels.h>

Public Member Functions

virtual PixelType GetPixelType () const =0
 
virtual IntSize GetSize () const =0
 
virtual BitmapLockInfo Lock ()=0
 
virtual void Unlock ()=0
 
std::uint32_t GetWidth () const
 
std::uint32_t GetHeight () const
 

Detailed Description

This interface is used to represent a bitmap.

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.

Member Function Documentation

◆ GetHeight()

std::uint32_t libCZI::IBitmapData::GetHeight ( ) const
inline

Gets the height of the bitmap in pixels.

Returns
The height in pixels

◆ GetPixelType()

virtual PixelType libCZI::IBitmapData::GetPixelType ( ) const
pure virtual

Gets pixel type.

Returns
The pixel type.

◆ GetSize()

virtual IntSize libCZI::IBitmapData::GetSize ( ) const
pure virtual

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

Returns
The size (in pixels).

◆ GetWidth()

std::uint32_t libCZI::IBitmapData::GetWidth ( ) const
inline

Gets the width of the bitmap in pixels.

Returns
The width in pixels.

◆ Lock()

virtual BitmapLockInfo libCZI::IBitmapData::Lock ( )
pure virtual

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

The BitmapLockInfo returned must only be considered to be valid until Unlock is called. It is legal to call Lock multiple time (also from different threads concurrently). In any case, calls to Lock and Unlock must be balanced. It is considered to be a fatal error if the object is destroyed when it is locked.

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

◆ Unlock()

virtual void libCZI::IBitmapData::Unlock ( )
pure virtual

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

The BitmapLockInfo returned must only be considered to be valid until Unlock is called.


The documentation for this class was generated from the following file: