Blender V5.3
blender::ocio::LibOCIODisplay Class Reference

#include <libocio_display.hh>

Inherits blender::ocio::Display.

Public Member Functions

 LibOCIODisplay (int index, const LibOCIOConfig &config)
 LibOCIODisplay (const LibOCIODisplay &other)=delete
 LibOCIODisplay (LibOCIODisplay &&other) noexcept=default
 ~LibOCIODisplay () override=default
LibOCIODisplay & operator= (const LibOCIODisplay &other)=delete
LibOCIODisplay & operator= (LibOCIODisplay &&other)=default
StringRefNull name () const override
StringRefNull ui_name () const override
StringRefNull description () const override
const View * get_default_view () const override
const View * get_untonemapped_view () const override
const View * get_view_by_name (StringRefNull name) const override
int get_num_views () const override
const View * get_view_by_index (int index) const override
const CPUProcessor * get_to_scene_linear_cpu_processor (bool use_display_emulation) const override
const CPUProcessor * get_from_scene_linear_cpu_processor (bool use_display_emulation) const override
bool is_hdr () const override
void clear_caches ()
 MEM_CXX_CLASS_ALLOC_FUNCS ("LibOCIOConfig")
Public Member Functions inherited from blender::ocio::Display
virtual ~Display ()=default

Protected Member Functions

std::unique_ptr< LibOCIOCPUProcessor > create_scene_linear_cpu_processor (const bool use_display_emulation, const bool inverse) const

Additional Inherited Members

Public Attributes inherited from blender::ocio::Display
int index = -1

Detailed Description

Definition at line 24 of file libocio_display.hh.

Constructor & Destructor Documentation

◆ LibOCIODisplay() [1/3]

◆ LibOCIODisplay() [2/3]

blender::ocio::LibOCIODisplay::LibOCIODisplay ( const LibOCIODisplay & other)
delete

References LibOCIODisplay().

◆ LibOCIODisplay() [3/3]

blender::ocio::LibOCIODisplay::LibOCIODisplay ( LibOCIODisplay && other)
defaultnoexcept

References LibOCIODisplay().

◆ ~LibOCIODisplay()

blender::ocio::LibOCIODisplay::~LibOCIODisplay ( )
overridedefault

Member Function Documentation

◆ clear_caches()

void blender::ocio::LibOCIODisplay::clear_caches ( )

◆ create_scene_linear_cpu_processor()

◆ description()

StringRefNull blender::ocio::LibOCIODisplay::description ( ) const
inlineoverridevirtual

Description of the display from the OpenColorIO config.

Implements blender::ocio::Display.

Definition at line 61 of file libocio_display.hh.

◆ get_default_view()

const View * blender::ocio::LibOCIODisplay::get_default_view ( ) const
inlineoverridevirtual

Get default view of this display.

Implements blender::ocio::Display.

Definition at line 66 of file libocio_display.hh.

References get_view_by_index().

Referenced by create_scene_linear_cpu_processor().

◆ get_from_scene_linear_cpu_processor()

const CPUProcessor * blender::ocio::LibOCIODisplay::get_from_scene_linear_cpu_processor ( bool use_display_emulation) const
overridevirtual

◆ get_num_views()

int blender::ocio::LibOCIODisplay::get_num_views ( ) const
overridevirtual

Get the number of view in this display.

Implements blender::ocio::Display.

Definition at line 244 of file libocio_display.cc.

◆ get_to_scene_linear_cpu_processor()

const CPUProcessor * blender::ocio::LibOCIODisplay::get_to_scene_linear_cpu_processor ( bool use_display_emulation) const
overridevirtual

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.

Implements blender::ocio::Display.

Definition at line 286 of file libocio_display.cc.

References create_scene_linear_cpu_processor(), and blender::ocio::CPUProcessorCache::get().

◆ get_untonemapped_view()

const View * blender::ocio::LibOCIODisplay::get_untonemapped_view ( ) const
overridevirtual

Get the view without tonemapping.

Implements blender::ocio::Display.

Definition at line 228 of file libocio_display.cc.

Referenced by create_scene_linear_cpu_processor(), and blender::ocio::create_untonemapped_ocio_display_transform().

◆ get_view_by_index()

const View * blender::ocio::LibOCIODisplay::get_view_by_index ( int index) const
overridevirtual

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

Implements blender::ocio::Display.

Definition at line 249 of file libocio_display.cc.

References blender::ocio::Display::index.

Referenced by get_default_view().

◆ get_view_by_name()

const View * blender::ocio::LibOCIODisplay::get_view_by_name ( StringRefNull name) const
overridevirtual

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

Implements blender::ocio::Display.

Definition at line 233 of file libocio_display.cc.

References name().

Referenced by blender::ocio::adjust_for_hdr_image_file(), blender::ocio::display_as_extended_srgb(), and blender::ocio::display_as_scope_space().

◆ is_hdr()

bool blender::ocio::LibOCIODisplay::is_hdr ( ) const
inlineoverridevirtual

Determine if the display supports HDR.

Implements blender::ocio::Display.

Definition at line 83 of file libocio_display.hh.

Referenced by blender::ocio::display_as_extended_srgb().

◆ MEM_CXX_CLASS_ALLOC_FUNCS()

blender::ocio::LibOCIODisplay::MEM_CXX_CLASS_ALLOC_FUNCS ( "LibOCIOConfig" )

◆ name()

StringRefNull blender::ocio::LibOCIODisplay::name ( ) const
inlineoverridevirtual

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

Implements blender::ocio::Display.

Definition at line 51 of file libocio_display.hh.

Referenced by get_view_by_name().

◆ operator=() [1/2]

LibOCIODisplay & blender::ocio::LibOCIODisplay::operator= ( const LibOCIODisplay & other)
delete

References LibOCIODisplay().

◆ operator=() [2/2]

LibOCIODisplay & blender::ocio::LibOCIODisplay::operator= ( LibOCIODisplay && other)
default

References LibOCIODisplay().

◆ ui_name()

StringRefNull blender::ocio::LibOCIODisplay::ui_name ( ) const
inlineoverridevirtual

Name to display in the user interface.

Implements blender::ocio::Display.

Definition at line 56 of file libocio_display.hh.

References blender::StringRefNull::c_str().


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