OCIO_NAMESPACE::GradingPrimaryTransform Class Reference

#include <OpenColorTransforms.h>

Inheritance diagram for OCIO_NAMESPACE::GradingPrimaryTransform:

Public Member Functions
TransformType	getTransformType () const noexceptoverride
virtual const FormatMetadata &	getFormatMetadata () const noexcept=0
virtual FormatMetadata &	getFormatMetadata () noexcept=0
virtual bool	equals (const GradingPrimaryTransform &other) const noexcept=0
	Checks if this equals other. More...
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 GradingPrimary &	getValue () const =0
virtual void	setValue (const GradingPrimary &values)=0
	Throws if value is not valid. More...
virtual bool	isDynamic () const noexcept=0
virtual void	makeDynamic () noexcept=0
virtual void	makeNonDynamic () noexcept=0
	GradingPrimaryTransform (const GradingPrimaryTransform &)=delete
GradingPrimaryTransform &	operator= (const GradingPrimaryTransform &)=delete
virtual	~GradingPrimaryTransform ()=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 GradingPrimaryTransformRcPtr	Create (GradingStyle style)
	Creates an instance of GradingPrimaryTransform. More...

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

Detailed Description

Primary color correction controls.

This transform is for making basic color correction adjustments to an image such as brightness, contrast, or saturation.

The controls are customized for linear, logarithmic, and video color encodings.

• Linear controls: Exposure, Contrast, Pivot, Offset, Saturation, Black Clip, White Clip.
• Log controls: Brightness, Contrast, Pivot, Log Gamma, Saturation, Black Clip, White Clip, Black Pivot White Pivot.
• Video controls : Lift, Gamma, Gain, Offset, Saturation, Black Clip, White Clip, Black Pivot White Pivot.

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

Definition at line 1136 of file OpenColorTransforms.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::GradingPrimaryTransform::GradingPrimaryTransform ( const GradingPrimaryTransform &  )

delete

virtual OCIO_NAMESPACE::GradingPrimaryTransform::~GradingPrimaryTransform ( )

virtualdefault

Do not use (needed only for pybind11).

OCIO_NAMESPACE::GradingPrimaryTransform::GradingPrimaryTransform ( )

protecteddefault

Member Function Documentation

static GradingPrimaryTransformRcPtr OCIO_NAMESPACE::GradingPrimaryTransform::Create ( GradingStyle  style )

static

Creates an instance of GradingPrimaryTransform.

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

pure virtualnoexcept

Checks if this equals other.

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

pure virtualnoexcept

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

pure virtualnoexcept

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

pure virtualnoexcept

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

TransformType OCIO_NAMESPACE::GradingPrimaryTransform::getTransformType ( ) const

inlineoverridevirtualnoexcept

Implements OCIO_NAMESPACE::Transform.

Definition at line 1142 of file OpenColorTransforms.h.

virtual const GradingPrimary& OCIO_NAMESPACE::GradingPrimaryTransform::getValue ( ) const

pure virtual

virtual bool OCIO_NAMESPACE::GradingPrimaryTransform::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 GradingPrimaryTransform only one can have dynamic parameters.

virtual void OCIO_NAMESPACE::GradingPrimaryTransform::makeDynamic ( )

pure virtualnoexcept

virtual void OCIO_NAMESPACE::GradingPrimaryTransform::makeNonDynamic ( )

pure virtualnoexcept

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

delete

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

pure virtualnoexcept

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

virtual void OCIO_NAMESPACE::GradingPrimaryTransform::setValue ( const GradingPrimary &  values )

pure virtual

Throws if value is not valid.

---

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

• OpenColorIO/OpenColorTransforms.h