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

#include <OpenColorIO.h>

Public Member Functions

ViewTransformRcPtr createEditableCopy () const
 
const char * getName () const noexcept
 
void setName (const char *name) noexcept
 
const char * getFamily () const noexcept
 
void setFamily (const char *family)
 
const char * getDescription () const noexcept
 
void setDescription (const char *description)
 
bool hasCategory (const char *category) const
 
void addCategory (const char *category)
 
void removeCategory (const char *category)
 
int getNumCategories () const
 
const char * getCategory (int index) const
 
void clearCategories ()
 
ReferenceSpaceType getReferenceSpaceType () const noexcept
 
ConstTransformRcPtr getTransform (ViewTransformDirection dir) const noexcept
 
void setTransform (const ConstTransformRcPtr &transform, ViewTransformDirection dir)
 
 ViewTransform (const ViewTransform &)=delete
 
ViewTransformoperator= (const ViewTransform &)=delete
 
 ~ViewTransform ()
 Do not use (needed only for pybind11). More...
 

Static Public Member Functions

static ViewTransformRcPtr Create (ReferenceSpaceType referenceSpace)
 

Detailed Description

A ViewTransform provides a conversion from the main (usually scene-referred) reference space to the display-referred reference space. This allows splitting the conversion from the main reference space to a display into two parts: the ViewTransform plus a display color space.

It is also possible to provide a ViewTransform that converts from the display-referred reference space back to that space. This is useful in cases when a ViewTransform is needed when converting between displays (such as HDR to SDR).

The ReferenceSpaceType indicates whether the ViewTransform converts from scene-to-display reference or display-to-display reference.

The from_reference transform direction is the one that is used when going out towards a display.

Definition at line 1974 of file OpenColorIO.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::ViewTransform::ViewTransform ( const ViewTransform )
delete
OCIO_NAMESPACE::ViewTransform::~ViewTransform ( )

Do not use (needed only for pybind11).

Member Function Documentation

void OCIO_NAMESPACE::ViewTransform::addCategory ( const char *  category)
void OCIO_NAMESPACE::ViewTransform::clearCategories ( )
static ViewTransformRcPtr OCIO_NAMESPACE::ViewTransform::Create ( ReferenceSpaceType  referenceSpace)
static
ViewTransformRcPtr OCIO_NAMESPACE::ViewTransform::createEditableCopy ( ) const
const char* OCIO_NAMESPACE::ViewTransform::getCategory ( int  index) const
const char* OCIO_NAMESPACE::ViewTransform::getDescription ( ) const
noexcept
const char* OCIO_NAMESPACE::ViewTransform::getFamily ( ) const
noexcept
const char* OCIO_NAMESPACE::ViewTransform::getName ( ) const
noexcept
int OCIO_NAMESPACE::ViewTransform::getNumCategories ( ) const
ReferenceSpaceType OCIO_NAMESPACE::ViewTransform::getReferenceSpaceType ( ) const
noexcept
ConstTransformRcPtr OCIO_NAMESPACE::ViewTransform::getTransform ( ViewTransformDirection  dir) const
noexcept

If a transform in the specified direction has been specified, return it. Otherwise return a null ConstTransformRcPtr

bool OCIO_NAMESPACE::ViewTransform::hasCategory ( const char *  category) const
ViewTransform& OCIO_NAMESPACE::ViewTransform::operator= ( const ViewTransform )
delete
void OCIO_NAMESPACE::ViewTransform::removeCategory ( const char *  category)
void OCIO_NAMESPACE::ViewTransform::setDescription ( const char *  description)
void OCIO_NAMESPACE::ViewTransform::setFamily ( const char *  family)
void OCIO_NAMESPACE::ViewTransform::setName ( const char *  name)
noexcept
void OCIO_NAMESPACE::ViewTransform::setTransform ( const ConstTransformRcPtr transform,
ViewTransformDirection  dir 
)

Specify the transform for the appropriate direction. Setting the transform to null will clear it.


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