HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OCIO_NAMESPACE::ExponentWithLinearTransform Class Referenceabstract

#include <OpenColorTransforms.h>

+ Inheritance diagram for OCIO_NAMESPACE::ExponentWithLinearTransform:

Public Member Functions

TransformType getTransformType () const noexceptoverride
 
virtual const FormatMetadatagetFormatMetadata () const noexcept=0
 
virtual FormatMetadatagetFormatMetadata () noexcept=0
 
virtual bool equals (const ExponentWithLinearTransform &other) const noexcept=0
 Checks if this exactly equals other. More...
 
virtual void getGamma (double(&values)[4]) const noexcept=0
 
virtual void setGamma (const double(&values)[4]) noexcept=0
 
virtual void getOffset (double(&values)[4]) const noexcept=0
 
virtual void setOffset (const double(&values)[4]) noexcept=0
 
virtual NegativeStyle getNegativeStyle () const =0
 
virtual void setNegativeStyle (NegativeStyle style)=0
 
 ExponentWithLinearTransform (const ExponentWithLinearTransform &)=delete
 
ExponentWithLinearTransformoperator= (const ExponentWithLinearTransform &)=delete
 
virtual ~ExponentWithLinearTransform ()=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
 
Transformoperator= (const Transform &)=delete
 
virtual ~Transform ()=default
 Do not use (needed only for pybind11). More...
 

Static Public Member Functions

static
ExponentWithLinearTransformRcPtr 
Create ()
 

Protected Member Functions

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

Detailed Description

Represents power functions with a linear section in the shadows such as sRGB and L*.

The basic formula is::

pow( (x + offset)/(1 + offset), gamma ) with the breakpoint at offset/(gamma - 1).

Negative values are never clamped.

Definition at line 860 of file OpenColorTransforms.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::ExponentWithLinearTransform::ExponentWithLinearTransform ( const ExponentWithLinearTransform )
delete
virtual OCIO_NAMESPACE::ExponentWithLinearTransform::~ExponentWithLinearTransform ( )
virtualdefault

Do not use (needed only for pybind11).

OCIO_NAMESPACE::ExponentWithLinearTransform::ExponentWithLinearTransform ( )
protecteddefault

Member Function Documentation

static ExponentWithLinearTransformRcPtr OCIO_NAMESPACE::ExponentWithLinearTransform::Create ( )
static
virtual bool OCIO_NAMESPACE::ExponentWithLinearTransform::equals ( const ExponentWithLinearTransform other) const
pure virtualnoexcept

Checks if this exactly equals other.

virtual const FormatMetadata& OCIO_NAMESPACE::ExponentWithLinearTransform::getFormatMetadata ( ) const
pure virtualnoexcept
virtual FormatMetadata& OCIO_NAMESPACE::ExponentWithLinearTransform::getFormatMetadata ( )
pure virtualnoexcept
virtual void OCIO_NAMESPACE::ExponentWithLinearTransform::getGamma ( double(&)  values[4]) const
pure virtualnoexcept
virtual NegativeStyle OCIO_NAMESPACE::ExponentWithLinearTransform::getNegativeStyle ( ) const
pure virtual

Specifies how negative values are handled. Legal values:

  • NEGATIVE_LINEAR – Linear segment continues into negatives (default).
  • NEGATIVE_MIRROR – Positive curve is rotated 180 degrees around the origin to handle negatives.
virtual void OCIO_NAMESPACE::ExponentWithLinearTransform::getOffset ( double(&)  values[4]) const
pure virtualnoexcept
TransformType OCIO_NAMESPACE::ExponentWithLinearTransform::getTransformType ( ) const
inlineoverridevirtualnoexcept

Implements OCIO_NAMESPACE::Transform.

Definition at line 865 of file OpenColorTransforms.h.

ExponentWithLinearTransform& OCIO_NAMESPACE::ExponentWithLinearTransform::operator= ( const ExponentWithLinearTransform )
delete
virtual void OCIO_NAMESPACE::ExponentWithLinearTransform::setGamma ( const double(&)  values[4])
pure virtualnoexcept

Set the exponent value for the power function for R, G, B, A.

Note
The gamma values must be in the range of [1, 10]. Set the transform direction to inverse to obtain the effect of values less than 1.
virtual void OCIO_NAMESPACE::ExponentWithLinearTransform::setNegativeStyle ( NegativeStyle  style)
pure virtual
virtual void OCIO_NAMESPACE::ExponentWithLinearTransform::setOffset ( const double(&)  values[4])
pure virtualnoexcept

Set the offset value for the power function for R, G, B, A.

Note
The offset values must be in the range [0, 0.9].

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