blender::ocio::Display Class Reference

#include <OCIO_display.hh>

Inherited by blender::ocio::FallbackDefaultDisplay.

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::FallbackDefaultDisplay.

Referenced by IMB_colormanagement_display_items_add().

get_default_view()

virtual const View * blender::ocio::Display::get_default_view ( ) const

pure virtual

Get default view of this display.

Implemented in blender::ocio::FallbackDefaultDisplay.

Referenced by colormanage_check_view_settings(), colormanage_find_matching_view_name(), IMB_colormanagement_display_get_default_view_transform_name(), IMB_colormanagement_view_get_default_name(), and IMB_colormanagement_view_get_raw_or_default_name().

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

Implemented in blender::ocio::FallbackDefaultDisplay.

Referenced by IMB_colormanagement_scene_linear_to_display_v3().

get_num_views()

virtual int blender::ocio::Display::get_num_views ( ) const

pure virtual

Get the number of view in this display.

Implemented in blender::ocio::FallbackDefaultDisplay.

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

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::FallbackDefaultDisplay.

Referenced by IMB_colormanagement_display_to_scene_linear_v3().

get_untonemapped_view()

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

pure virtual

Get the view without tonemapping.

Implemented in blender::ocio::FallbackDefaultDisplay.

Referenced by IMB_colormangement_display_get_color_space(), and is_colorspace_same_as_display().

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::FallbackDefaultDisplay.

References index.

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

get_view_by_name()

virtual const View * blender::ocio::Display::get_view_by_name ( StringRefNull name ) const

pure virtual

Get view with the given name for this display. If the view does not exist nullptr is returned.

Implemented in blender::ocio::FallbackDefaultDisplay.

References name().

Referenced by colormanage_check_view_settings(), colormanage_find_matching_view_name(), IMB_colormanagement_display_is_hdr(), IMB_colormanagement_display_is_wide_gamut(), IMB_colormanagement_display_support_emulation(), IMB_colormanagement_view_get_raw_or_default_name(), and IMB_colormangement_display_get_color_space().

is_hdr()

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

pure virtual

Determine if the display supports HDR.

Implemented in blender::ocio::FallbackDefaultDisplay.

Referenced by IMB_colormanagement_display_items_add().

name()

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

pure virtual

Name of this display. The name is used to address to this display from various places of the configuration.

Implemented in blender::ocio::FallbackDefaultDisplay.

Referenced by colormanage_check_display_settings(), colormanage_load_config(), get_view_by_name(), IMB_colormanagement_display_get_default_name(), IMB_colormanagement_display_get_indexed_name(), and IMB_colormanagement_display_items_add().

ui_name()

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

pure virtual

Implemented in blender::ocio::FallbackDefaultDisplay.

Referenced by IMB_colormanagement_display_items_add().

Member Data Documentation

index

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

Global index of the display within the OpenColorIO configuration. The index is 0-based.

Definition at line 22 of file OCIO_display.hh.

Referenced by blender::ocio::FallbackDefaultDisplay::FallbackDefaultDisplay(), get_view_by_index(), blender::ocio::FallbackDefaultDisplay::get_view_by_index(), IMB_colormanagement_display_get_named_index(), and IMB_colormanagement_display_items_add().

---

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

• OCIO_display.hh