libCZI
Reading and Writing CZI documents made easy
libCZI::DisplaySettingsPOD Struct Reference

#include <libCZI_Metadata.h>

Static Public Member Functions

static LIBCZI_API libCZI::IDisplaySettingsCreateIDisplaySetting (const DisplaySettingsPOD &pod)
 
static LIBCZI_API std::shared_ptr< libCZI::IDisplaySettingsCreateIDisplaySettingSp (const DisplaySettingsPOD &pod)
 

Public Attributes

std::map< int, ChannelDisplaySettingsPODchannelDisplaySettings
 The channel display settings. Key is the channel index, and value is the POD-channel-display-data structure.
 

Detailed Description

This POD ("plain-old-data") structure is intended to capture all information found inside an IChannelDisplaySetting-object. It allows for easy modification of the information.

Member Function Documentation

◆ CreateIDisplaySetting()

static LIBCZI_API libCZI::IDisplaySettings* libCZI::DisplaySettingsPOD::CreateIDisplaySetting ( const DisplaySettingsPOD pod)
static

Creates an IDisplaySettings-object from the specified DisplaySettingsPOD-structure.

Parameters
podThe ChannelDisplaySettingsPOD-structure.
Returns
The newly created IDisplaySettings-object.

◆ CreateIDisplaySettingSp()

static LIBCZI_API std::shared_ptr<libCZI::IDisplaySettings> libCZI::DisplaySettingsPOD::CreateIDisplaySettingSp ( const DisplaySettingsPOD pod)
static

Creates an IDisplaySettings-object from the specified DisplaySettingsPOD-structure, and return it as a shared pointer.

Parameters
podThe ChannelDisplaySettingsPOD-structure.
Returns
The newly created IDisplaySettings-object inside a shared pointer.

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