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

#include <OpenColorTransforms.h>

+ Inheritance diagram for OCIO_NAMESPACE::BuiltinTransform:

Public Member Functions

TransformType getTransformType () const noexceptoverride
virtual const char * getStyle () const noexcept=0
virtual void setStyle (const char *style)=0
virtual const char * getDescription () const noexcept=0
virtual ~BuiltinTransform ()=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 BuiltinTransformRcPtr Create ()

Protected Member Functions

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

Detailed Description

A built-in transform is similar to a FileTransform, but without the file. OCIO knows how to build a set of commonly used transforms on-demand, thus avoiding the need for external files and simplifying config authoring.

Definition at line 198 of file OpenColorTransforms.h.

Constructor & Destructor Documentation

virtual OCIO_NAMESPACE::BuiltinTransform::~BuiltinTransform ( )

Do not use (needed only for pybind11).

OCIO_NAMESPACE::BuiltinTransform::BuiltinTransform ( )

Member Function Documentation

static BuiltinTransformRcPtr OCIO_NAMESPACE::BuiltinTransform::Create ( )
virtual const char* OCIO_NAMESPACE::BuiltinTransform::getDescription ( ) const
pure virtualnoexcept
virtual const char* OCIO_NAMESPACE::BuiltinTransform::getStyle ( ) const
pure virtualnoexcept
TransformType OCIO_NAMESPACE::BuiltinTransform::getTransformType ( ) const

Implements OCIO_NAMESPACE::Transform.

Definition at line 203 of file OpenColorTransforms.h.

virtual void OCIO_NAMESPACE::BuiltinTransform::setStyle ( const char *  style)
pure virtual

Select an existing built-in transform style from the list accessible through :cpp:class:BuiltinTransformRegistry. The style is the ID string that identifies which transform to apply.

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