OCIO_NAMESPACE::DynamicProperty Class Reference

#include <OpenColorTransforms.h>

Public Member Functions
virtual DynamicPropertyType	getType () const noexcept=0
DynamicProperty &	operator= (const DynamicProperty &)=delete
	DynamicProperty (const DynamicProperty &)=delete
virtual	~DynamicProperty ()=default
	Do not use (needed only for pybind11). More...

Protected Member Functions
	DynamicProperty ()=default

Detailed Description

Allows transform parameter values to be set on-the-fly (after finalization). For example, to modify the exposure in a viewport. Dynamic properties can be accessed from the CPUProcessor or GpuShaderCreator to change values between processing.

OCIO::ConstConfigRcPtr config = OCIO::GetCurrentConfig();
OCIO::ConstProcessorRcPtr processor = config->getProcessor(colorSpace1, colorSpace2);
OCIO::ConstCPUProcessorRcPtr cpuProcessor = processor->getDefaultCPUProcessor();

if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_EXPOSURE))
{
    // Get the in-memory implementation of the dynamic property.
    OCIO::DynamicPropertyRcPtr dynProp =
        cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_EXPOSURE);
    // Get the interface used to change the double value.
    OCIO::DynamicPropertyDoubleRcPtr exposure =
        OCIO::DynamicPropertyValue::AsDouble(dynProp);
    // Update of the dynamic property instance with the new value.
    exposure->setValue(1.1f);
}
if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_PRIMARY))
{
    OCIO::DynamicPropertyRcPtr dynProp =
        cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_PRIMARY);
    OCIO::DynamicPropertyGradingPrimaryRcPtr primaryProp =
        OCIO::DynamicPropertyValue::AsGradingPrimary(dynProp);
    OCIO::GradingPrimary primary = primaryProp->getValue();
    primary.m_saturation += 0.1f;
    rgbCurveProp->setValue(primary);
}
if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_RGBCURVE))
{
    OCIO::DynamicPropertyRcPtr dynProp =
        cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_RGBCURVE);
    OCIO::DynamicPropertyGradingRGBCurveRcPtr rgbCurveProp =
        OCIO::DynamicPropertyValue::AsGradingRGBCurve(dynProp);
    OCIO::ConstGradingRGBCurveRcPtr rgbCurve = rgbCurveProp->getValue()->createEditableCopy();
    OCIO::GradingBSplineCurveRcPtr rCurve = rgbCurve->getCurve(OCIO::RGB_RED);
    rCurve->getControlPoint(1).m_y += 0.1f;
    rgbCurveProp->setValue(rgbCurve);
}

Definition at line 691 of file OpenColorTransforms.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::DynamicProperty::DynamicProperty ( const DynamicProperty &  )

delete

virtual OCIO_NAMESPACE::DynamicProperty::~DynamicProperty ( )

virtualdefault

Do not use (needed only for pybind11).

OCIO_NAMESPACE::DynamicProperty::DynamicProperty ( )

protecteddefault

Member Function Documentation

virtual DynamicPropertyType OCIO_NAMESPACE::DynamicProperty::getType ( ) const

pure virtualnoexcept

DynamicProperty& OCIO_NAMESPACE::DynamicProperty::operator= ( const DynamicProperty &  )

delete

---

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

• OpenColorIO/OpenColorTransforms.h