ViewTransform¶
- class PyOpenColorIO.ViewTransform¶
A :ref:`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.
- ViewTransform(*args, **kwargs)¶
Overloaded function.
__init__(self: PyOpenColorIO.ViewTransform, referenceSpace: PyOpenColorIO.ReferenceSpaceType) -> None
__init__(self: PyOpenColorIO.ViewTransform, referenceSpace: PyOpenColorIO.ReferenceSpaceType = <ReferenceSpaceType.REFERENCE_SPACE_SCENE: 0>, name: str = ‘’, family: str = ‘’, description: str = ‘’, toReference: PyOpenColorIO.Transform = None, fromReference: PyOpenColorIO.Transform = None, categories: List[str] = []) -> None
- addCategory(category: str) None ¶
- clearCategories() None ¶
- getCategories() PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator ¶
- getDescription() str ¶
- getFamily() str ¶
- getName() str ¶
- getReferenceSpaceType() PyOpenColorIO.ReferenceSpaceType ¶
- getTransform(direction: PyOpenColorIO.ViewTransformDirection) PyOpenColorIO.Transform ¶
If a transform in the specified direction has been specified, return it. Otherwise return a null ConstTransformRcPtr
- hasCategory(category: str) bool ¶
- removeCategory(category: str) None ¶
- setDescription(description: str) None ¶
- setFamily(family: str) None ¶
- setName(name: str) None ¶
- setTransform(transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.ViewTransformDirection) None ¶
Specify the transform for the appropriate direction. Setting the transform to null will clear it.
-
class ViewTransform¶
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.
Public Functions
-
ViewTransformRcPtr createEditableCopy() const¶
-
const char *getName() const noexcept¶
-
void setName(const char *name) noexcept¶
-
const char *getFamily() const noexcept¶
See also
-
void setFamily(const char *family)¶
See also
-
const char *getDescription() const noexcept¶
-
void setDescription(const char *description)¶
-
bool hasCategory(const char *category) const¶
See also
-
void addCategory(const char *category)¶
See also
-
void removeCategory(const char *category)¶
See also
-
int getNumCategories() const¶
See also
-
const char *getCategory(int index) const¶
See also
-
void clearCategories()¶
See also
-
ReferenceSpaceType getReferenceSpaceType() const noexcept¶
-
ConstTransformRcPtr getTransform(ViewTransformDirection dir) const noexcept¶
If a transform in the specified direction has been specified, return it. Otherwise return a null ConstTransformRcPtr
-
void setTransform(const ConstTransformRcPtr &transform, ViewTransformDirection dir)¶
Specify the transform for the appropriate direction. Setting the transform to null will clear it.
-
ViewTransform(const ViewTransform&) = delete¶
-
ViewTransform &operator=(const ViewTransform&) = delete¶
-
~ViewTransform()¶
Do not use (needed only for pybind11).
Public Static Functions
-
static ViewTransformRcPtr Create(ReferenceSpaceType referenceSpace)¶
-
ViewTransformRcPtr createEditableCopy() const¶
-
std::ostream &OpenColorIO_v2_2::operator<<(std::ostream&, const ViewTransform&)¶
-
typedef std::shared_ptr<const ViewTransform> OpenColorIO_v2_2::ConstViewTransformRcPtr¶
-
typedef std::shared_ptr<ViewTransform> OpenColorIO_v2_2::ViewTransformRcPtr¶