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

#include <OCIO_colorspace.hh>

Inherited by blender::ocio::LibOCIOColorSpace.

Public Member Functions

virtual ~ColorSpace ()=default
virtual StringRefNull name () const =0
virtual StringRefNull description () const =0
virtual StringRefNull family () const =0
virtual bool is_scene_linear () const =0
virtual bool is_srgb () const =0
virtual bool is_data () const =0
virtual bool is_display_referred () const =0
virtual StringRefNull interop_id () const =0
virtual bool is_primary_interop_id () const =0
virtual StringRefNull alternate_interop_id () const =0
virtual std::string icc_profile_path () const =0
virtual const CPUProcessor * get_to_scene_linear_cpu_processor () const =0
virtual const CPUProcessor * get_from_scene_linear_cpu_processor () const =0

Public Attributes

int index = -1

Detailed Description

Definition at line 14 of file OCIO_colorspace.hh.

Constructor & Destructor Documentation

◆ ~ColorSpace()

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

Member Function Documentation

◆ alternate_interop_id()

virtual StringRefNull blender::ocio::ColorSpace::alternate_interop_id ( ) const
pure virtual

◆ description()

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

◆ family()

virtual StringRefNull blender::ocio::ColorSpace::family ( ) const
pure virtual

◆ get_from_scene_linear_cpu_processor()

virtual const CPUProcessor * blender::ocio::ColorSpace::get_from_scene_linear_cpu_processor ( ) const
pure virtual

◆ get_to_scene_linear_cpu_processor()

virtual const CPUProcessor * blender::ocio::ColorSpace::get_to_scene_linear_cpu_processor ( ) const
pure virtual

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

Implemented in blender::ocio::LibOCIOColorSpace.

Referenced by blender::ColormanageProcessor::colorspace_processor_to_scene_linear_new(), and blender::IMB_colormanagement_imbuf_to_float_texture().

◆ icc_profile_path()

virtual std::string blender::ocio::ColorSpace::icc_profile_path ( ) const
pure virtual

◆ interop_id()

virtual StringRefNull blender::ocio::ColorSpace::interop_id ( ) const
pure virtual

◆ is_data()

virtual bool blender::ocio::ColorSpace::is_data ( ) const
pure virtual

The color space is a non-color data. Data color spaces do not change values of underlying pixels when converting to other color spaces.

Implemented in blender::ocio::LibOCIOColorSpace.

Referenced by blender::ImBuf::colorspace_is_data(), blender::ColormanageProcessor::colorspace_processor_from_scene_linear_new(), blender::ColormanageProcessor::colorspace_processor_to_scene_linear_new(), and blender::ColormanageProcessor::display_processor_new().

◆ is_display_referred()

virtual bool blender::ocio::ColorSpace::is_display_referred ( ) const
pure virtual

The color space is display referred rather than scene referred.

Implemented in blender::ocio::LibOCIOColorSpace.

◆ is_primary_interop_id()

virtual bool blender::ocio::ColorSpace::is_primary_interop_id ( ) const
pure virtual

◆ is_scene_linear()

virtual bool blender::ocio::ColorSpace::is_scene_linear ( ) const
pure virtual

Check whether this color space matches one of the built-in spaces like scene linear or sRGB (in its standard Blender notation).

Implemented in blender::ocio::LibOCIOColorSpace.

◆ is_srgb()

virtual bool blender::ocio::ColorSpace::is_srgb ( ) const
pure virtual

◆ name()

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

Name, description, and family of this space.

The name is used to address to this color space from various places of the configuration. The description is used for UI to give better clue what the space is to artists. The family is used for organizational purposes in menus.

Implemented in blender::ocio::LibOCIOColorSpace.

Referenced by blender::ocio::adjust_for_hdr_image_file(), blender::colormanage_imbuf_make_linear(), blender::colormanage_load_config(), blender::colormanage_role_color_space_name_get(), blender::display_buffer_apply_threaded(), blender::IMB_colormanagement_get_byte_colorspace(), blender::IMB_colormanagement_get_float_colorspace(), blender::IMB_colormanagement_imbuf_for_write(), blender::IMB_colormanagement_setup_glsl_draw_from_space(), and blender::imbuf::tests::TEST_F().

Member Data Documentation

◆ index

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

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

Definition at line 22 of file OCIO_colorspace.hh.

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


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