Synergy Color Management Component - SDK -  2018.0.80
SYNCOLOR::DynamicProperty Struct Reference

Dynamic property structure definition. More...

Classes

union  Values
 Dynamic property value types definition and union member names. More...
 

Public Types

enum  Ids { Exposure, Contrast, Gamma, Bypass }
 List of available color transform dynamic properties. More...
 

Public Member Functions

 DynamicProperty (Ids ID)
 Constructor. More...
 

Static Public Member Functions

static const char * getName (Ids ID)
 Dynamic property name. More...
 

Public Attributes

Ids id
 Dynamic property ID. More...
 
union
SYNCOLOR::DynamicProperty::Values 
value
 Union instance containing the property value. More...
 

Detailed Description

Dynamic property structure definition.

A dynamic property is a modifiable parameter that affects the result produced by a color transform. A specific color transform may or may not have dynamic properties. If it does, each dynamic property will be one of the properties defined in the SYNCOLOR::DynamicProperty::Ids list.

This structure is generic for all dynamic properties. When obtaining or setting a dynamic property value, the appropriate member of the SYNCOLOR::DynamicProperty::Values union needs to be read or set. See the SYNCOLOR::DynamicProperty::Ids list for the members to use for each property.

Member Enumeration Documentation

List of available color transform dynamic properties.

Enumerator
Exposure 

Image exposure value (double floating point value).

Contrast 

Image contrast value (double floating point value).

Gamma 

Image gamma value (double floating point value).

Bypass 

Bypass color transform section, typically a look sub-transform also known as the LOOK_SWITCH property (boolean value).

Constructor & Destructor Documentation

SYNCOLOR::DynamicProperty::DynamicProperty ( Ids  ID)
inline

Constructor.

Parameters
IDDynamic property ID.
See also
SYNCOLOR::DynamicProperty::Ids

Member Function Documentation

static const char* SYNCOLOR::DynamicProperty::getName ( Ids  ID)
static

Dynamic property name.

Parameters
IDProperty ID.
Returns
Property name string..
Note
This string is not to be freed.

Member Data Documentation

Ids SYNCOLOR::DynamicProperty::id

Dynamic property ID.

union SYNCOLOR::DynamicProperty::Values SYNCOLOR::DynamicProperty::value

Union instance containing the property value.