OCIO_NAMESPACE::GradingToneTransform Class Reference

#include <OpenColorTransforms.h>

Inheritance diagram for OCIO_NAMESPACE::GradingToneTransform:

Public Member Functions
TransformType	getTransformType () const noexceptoverride
virtual const FormatMetadata &	getFormatMetadata () const noexcept=0
virtual FormatMetadata &	getFormatMetadata () noexcept=0
virtual bool	equals (const GradingToneTransform &other) const noexcept=0
virtual GradingStyle	getStyle () const noexcept=0
	Adjusts the behavior of the transform for log, linear, or video color space encodings. More...
virtual void	setStyle (GradingStyle style) noexcept=0
	Will reset value to style's defaults if style is not the current style. More...
virtual const GradingTone &	getValue () const =0
virtual void	setValue (const GradingTone &values)=0
virtual bool	isDynamic () const noexcept=0
virtual void	makeDynamic () noexcept=0
virtual void	makeNonDynamic () noexcept=0
	GradingToneTransform (const GradingToneTransform &)=delete
GradingToneTransform &	operator= (const GradingToneTransform &)=delete
virtual	~GradingToneTransform ()=default
	Do not use (needed only for pybind11). More...
Public Member Functions inherited from OCIO_NAMESPACE::Transform
virtual TransformRcPtr	createEditableCopy () const =0
virtual TransformDirection	getDirection () const noexcept=0
virtual void	setDirection (TransformDirection dir) noexcept=0
	Note that this only affects the evaluation and not the values stored in the object. More...
virtual void	validate () const
	Will throw if data is not valid. More...
	Transform (const Transform &)=delete
Transform &	operator= (const Transform &)=delete
virtual	~Transform ()=default
	Do not use (needed only for pybind11). More...

Static Public Member Functions
static GradingToneTransformRcPtr	Create (GradingStyle style)
	Creates an instance of GradingToneTransform. More...

Protected Member Functions
	GradingToneTransform ()=default
Protected Member Functions inherited from OCIO_NAMESPACE::Transform
	Transform ()=default

Detailed Description

Tonal color correction controls.

This transform is for making fine adjustments to tone reproduction in specific tonal ranges.

There are five tonal controls and each one has two parameters to control its range:

• Blacks (start, width)
• Shadows(start, pivot)
• Midtones(center, width)
• Highlights(start, pivot)
• Whites(start, width)

The transform has three styles that adjust the response and default ranges for linear, logarithimic, and video color encodings. The defaults vary based on the style. When the style is linear, the units for start/width/etc. are photographic stops relative to 0.18.

Each control allows R, G, B adjustments and a Master adjustment.

There is also an S-contrast control for imparting an S-shape curve.

The controls are dynamic, so they may be adjusted even after the Transform has been included in a Processor.

Definition at line 1278 of file OpenColorTransforms.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::GradingToneTransform::GradingToneTransform ( const GradingToneTransform &  )

delete

virtual OCIO_NAMESPACE::GradingToneTransform::~GradingToneTransform ( )

virtualdefault

Do not use (needed only for pybind11).

OCIO_NAMESPACE::GradingToneTransform::GradingToneTransform ( )

protecteddefault

Member Function Documentation

static GradingToneTransformRcPtr OCIO_NAMESPACE::GradingToneTransform::Create ( GradingStyle  style )

static

Creates an instance of GradingToneTransform.

virtual bool OCIO_NAMESPACE::GradingToneTransform::equals ( const GradingToneTransform &  other ) const

pure virtualnoexcept

virtual const FormatMetadata& OCIO_NAMESPACE::GradingToneTransform::getFormatMetadata ( ) const

pure virtualnoexcept

virtual FormatMetadata& OCIO_NAMESPACE::GradingToneTransform::getFormatMetadata ( )

pure virtualnoexcept

virtual GradingStyle OCIO_NAMESPACE::GradingToneTransform::getStyle ( ) const

pure virtualnoexcept

Adjusts the behavior of the transform for log, linear, or video color space encodings.

TransformType OCIO_NAMESPACE::GradingToneTransform::getTransformType ( ) const

inlineoverridevirtualnoexcept

Implements OCIO_NAMESPACE::Transform.

Definition at line 1284 of file OpenColorTransforms.h.

virtual const GradingTone& OCIO_NAMESPACE::GradingToneTransform::getValue ( ) const

pure virtual

virtual bool OCIO_NAMESPACE::GradingToneTransform::isDynamic ( ) const

pure virtualnoexcept

Parameters can be made dynamic so the values can be changed through the CPU or GPU processor, but if there are several GradingToneTransform only one can have dynamic parameters.

virtual void OCIO_NAMESPACE::GradingToneTransform::makeDynamic ( )

pure virtualnoexcept

virtual void OCIO_NAMESPACE::GradingToneTransform::makeNonDynamic ( )

pure virtualnoexcept

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

delete

virtual void OCIO_NAMESPACE::GradingToneTransform::setStyle ( GradingStyle  style )

pure virtualnoexcept

Will reset value to style's defaults if style is not the current style.

virtual void OCIO_NAMESPACE::GradingToneTransform::setValue ( const GradingTone &  values )

pure virtual

---

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

• OpenColorIO/OpenColorTransforms.h