Blender V5.3
blender::ocio::Display Class Referenceabstract

#include <OCIO_display.hh>

Inherited by blender::ocio::LibOCIODisplay.

Public Member Functions

virtual ~Display ()=default
virtual StringRefNull name () const =0
virtual StringRefNull ui_name () const =0
virtual StringRefNull description () const =0
virtual const View * get_default_view () const =0
virtual const View * get_untonemapped_view () const =0
virtual const View * get_view_by_name (StringRefNull name) const =0
virtual int get_num_views () const =0
virtual const View * get_view_by_index (int index) const =0
virtual const CPUProcessor * get_to_scene_linear_cpu_processor (bool use_display_emulation) const =0
virtual const CPUProcessor * get_from_scene_linear_cpu_processor (bool use_display_emulation) const =0
virtual bool is_hdr () const =0

Public Attributes

int index = -1

Detailed Description

Definition at line 14 of file OCIO_display.hh.

Constructor & Destructor Documentation

◆ ~Display()

virtual blender::ocio::Display::~Display ( )
virtualdefault

Member Function Documentation

◆ description()

virtual StringRefNull blender::ocio::Display::description ( ) const
pure virtual

Description of the display from the OpenColorIO config.

Implemented in blender::ocio::LibOCIODisplay.

Referenced by blender::IMB_colormanagement_display_items_add().

◆ get_default_view()

◆ get_from_scene_linear_cpu_processor()

virtual const CPUProcessor * blender::ocio::Display::get_from_scene_linear_cpu_processor ( bool use_display_emulation) const
pure virtual

◆ get_num_views()

◆ get_to_scene_linear_cpu_processor()

virtual const CPUProcessor * blender::ocio::Display::get_to_scene_linear_cpu_processor ( bool use_display_emulation) const
pure virtual

Quick access to processors that convert color space from the display to scene linear and vice versa. The call is allowed to be caching from the color space implementation perspective.

With #use_display_emulation, rather than converting to the display space, this converts to extended sRGB emulating the display space.

Implemented in blender::ocio::LibOCIODisplay.

Referenced by blender::IMB_colormanagement_display_to_scene_linear_v3().

◆ get_untonemapped_view()

virtual const View * blender::ocio::Display::get_untonemapped_view ( ) const
pure virtual

◆ get_view_by_index()

virtual const View * blender::ocio::Display::get_view_by_index ( int index) const
pure virtual

Get view with the given index within the display. If the index is invalid nullptr is returned.

Implemented in blender::ocio::LibOCIODisplay.

References index.

Referenced by blender::colormanage_find_matching_view_name(), blender::colormanage_load_config(), blender::IMB_colormanagement_validate_settings(), and blender::IMB_colormanagement_view_items_add().

◆ get_view_by_name()

◆ is_hdr()

virtual bool blender::ocio::Display::is_hdr ( ) const
pure virtual

Determine if the display supports HDR.

Implemented in blender::ocio::LibOCIODisplay.

Referenced by blender::IMB_colormanagement_display_items_add().

◆ name()

virtual StringRefNull blender::ocio::Display::name ( ) const
pure virtual

◆ ui_name()

virtual StringRefNull blender::ocio::Display::ui_name ( ) const
pure virtual

Name to display in the user interface.

Implemented in blender::ocio::LibOCIODisplay.

Referenced by blender::IMB_colormanagement_display_items_add().

Member Data Documentation

◆ index

int blender::ocio::Display::index = -1

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