libCZI::IDecoder Class Reference

The interface used for operating image decoder. That is the simplest possible interface at this point... More...

#include <libCZI_Site.h>

Public Member Functions
virtual std::shared_ptr< libCZI::IBitmapData >	Decode (const void *ptrData, size_t size, libCZI::PixelType pixelType, std::uint32_t width, std::uint32_t height)=0

Detailed Description

The interface used for operating image decoder. That is the simplest possible interface at this point...

Member Function Documentation

Decode()

virtual std::shared_ptr< libCZI::IBitmapData > libCZI::IDecoder::Decode ( const void *  ptrData, size_t  size, libCZI::PixelType  pixelType, std::uint32_t  width, std::uint32_t  height  )

pure virtual

Passing in a block of raw data, decode the image and return a bitmap object.

Remarks

This method is intended to be called concurrently, implementors should make no assumption about concurrency.

In case of an error (of whatever kind) the method is expected to throw an exception.

Parameters

ptrData	Pointer to a a block of memory (which contains the encoded image).
size	The size of the memory block pointed by ptrData.
pixelType	The pixel type of the expected bitmap.
width	The width of the expected bitmap, used for validation purposes only.
height	The height of the expected bitmap, used for validation purposes only.

Returns

A bitmap object with the decoded data.

---

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

• libCZI/libCZI_Site.h