Blender V5.0
blender::ocio::FallbackConfig Class Reference

#include <fallback_config.hh>

Inherits blender::ocio::Config.

Public Member Functions

 MEM_CXX_CLASS_ALLOC_FUNCS ("FallbackConfig")
Color space information
float3 get_default_luma_coefs () const override
float3x3 get_xyz_to_scene_linear_matrix () const override
const char * get_color_space_from_filepath (const char *filepath) const override
Color space API
const ColorSpaceget_color_space (StringRefNull name) const override
int get_num_color_spaces () const override
const ColorSpaceget_color_space_by_index (int index) const override
const ColorSpaceget_sorted_color_space_by_index (int index) const override
const ColorSpaceget_color_space_by_interop_id (StringRefNull interop_id) const override
const ColorSpaceget_color_space_for_hdr_image (StringRefNull name) const override
Working space API
void set_scene_linear_role (StringRefNull name) override
Display API
const Displayget_default_display () const override
const Displayget_display_by_name (StringRefNull name) const override
int get_num_displays () const override
const Displayget_display_by_index (int index) const override
Display colorspace API
const ColorSpaceget_display_view_color_space (StringRefNull display, StringRefNull view) const override
Look API
const Lookget_look_by_name (StringRefNull name) const override
int get_num_looks () const override
const Lookget_look_by_index (int index) const override
Processor API
std::shared_ptr< const CPUProcessorget_display_cpu_processor (const DisplayParameters &display_parameters) const override
std::shared_ptr< const CPUProcessorget_cpu_processor (StringRefNull from_colorspace, StringRefNull to_colorspace) const override
const GPUShaderBinderget_gpu_shader_binder () const override
Public Member Functions inherited from blender::ocio::Config
virtual ~Config ()=default

Additional Inherited Members

static std::unique_ptr< Configcreate_from_environment ()
static std::unique_ptr< Configcreate_from_file (StringRefNull filename)
static std::unique_ptr< Configcreate_fallback ()

Detailed Description

Definition at line 25 of file fallback_config.hh.

Member Function Documentation

◆ get_color_space()

const ColorSpace * blender::ocio::FallbackConfig::get_color_space ( StringRefNull name) const
overridevirtual

Get color space with the given name, role name, or alias. Color space names take precedence over roles. If the color space does not exist nullptr is returned.

Implements blender::ocio::Config.

Definition at line 44 of file fallback_config.cc.

References name.

Referenced by get_color_space_for_hdr_image().

◆ get_color_space_by_index()

const ColorSpace * blender::ocio::FallbackConfig::get_color_space_by_index ( int index) const
overridevirtual

Get color space with the given index within the configuration. If the index is invalid nullptr is returned.

Implements blender::ocio::Config.

Definition at line 88 of file fallback_config.cc.

Referenced by get_sorted_color_space_by_index().

◆ get_color_space_by_interop_id()

const ColorSpace * blender::ocio::FallbackConfig::get_color_space_by_interop_id ( StringRefNull interop_id) const
overridevirtual

Get color space for the given interop ID. If not found a nullptr is returned.

Implements blender::ocio::Config.

Definition at line 101 of file fallback_config.cc.

◆ get_color_space_for_hdr_image()

const ColorSpace * blender::ocio::FallbackConfig::get_color_space_for_hdr_image ( StringRefNull name) const
overridevirtual

Get colorspace to be used for saving and loading HDR image files, which may need adjustments compared to the colorspace as chosen by the user.

Implements blender::ocio::Config.

Definition at line 116 of file fallback_config.cc.

References get_color_space(), and name.

◆ get_color_space_from_filepath()

const char * blender::ocio::FallbackConfig::get_color_space_from_filepath ( const char * filepath) const
overridevirtual

Get the color space of the first rule that matched filepath. If there is no such color space nullptr is returned.

Implements blender::ocio::Config.

Definition at line 33 of file fallback_config.cc.

◆ get_cpu_processor()

std::shared_ptr< const CPUProcessor > blender::ocio::FallbackConfig::get_cpu_processor ( StringRefNull from_colorspace,
StringRefNull to_colorspace ) const
overridevirtual

Get processor which converts color between given color spaces.

Implements blender::ocio::Config.

Definition at line 215 of file fallback_config.cc.

◆ get_default_display()

const Display * blender::ocio::FallbackConfig::get_default_display ( ) const
overridevirtual

Get the default display in this configuration.

Implements blender::ocio::Config.

Definition at line 135 of file fallback_config.cc.

◆ get_default_luma_coefs()

float3 blender::ocio::FallbackConfig::get_default_luma_coefs ( ) const
overridevirtual

Get the default coefficients for computing luma.

Implements blender::ocio::Config.

Definition at line 18 of file fallback_config.cc.

◆ get_display_by_index()

const Display * blender::ocio::FallbackConfig::get_display_by_index ( int index) const
overridevirtual

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

Implements blender::ocio::Config.

Definition at line 153 of file fallback_config.cc.

◆ get_display_by_name()

const Display * blender::ocio::FallbackConfig::get_display_by_name ( StringRefNull name) const
overridevirtual

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

Implements blender::ocio::Config.

Definition at line 140 of file fallback_config.cc.

References name.

◆ get_display_cpu_processor()

std::shared_ptr< const CPUProcessor > blender::ocio::FallbackConfig::get_display_cpu_processor ( const DisplayParameters & display_parameters) const
overridevirtual

Get processor which converts color space from the given from_colorspace to the display space.

Implements blender::ocio::Config.

Definition at line 209 of file fallback_config.cc.

References blender::ocio::create_fallback_display_cpu_processor().

◆ get_display_view_color_space()

const ColorSpace * blender::ocio::FallbackConfig::get_display_view_color_space ( StringRefNull display,
StringRefNull view ) const
overridevirtual

Returns the colorspace of the (display, view) pair. Note that this may be either a color space or a display color space.

Implements blender::ocio::Config.

Definition at line 167 of file fallback_config.cc.

References view.

◆ get_gpu_shader_binder()

const GPUShaderBinder & blender::ocio::FallbackConfig::get_gpu_shader_binder ( ) const
overridevirtual

Get API which can be used to bind GPU shaders for color space conversion.

Implements blender::ocio::Config.

Definition at line 227 of file fallback_config.cc.

◆ get_look_by_index()

const Look * blender::ocio::FallbackConfig::get_look_by_index ( int index) const
overridevirtual

Get look with the given index within the configuration. If the index is invalid nullptr is returned.

Implements blender::ocio::Config.

Definition at line 195 of file fallback_config.cc.

◆ get_look_by_name()

const Look * blender::ocio::FallbackConfig::get_look_by_name ( StringRefNull name) const
overridevirtual

Get look with the given name. If the look does not exist nullptr is returned.

Implements blender::ocio::Config.

Definition at line 182 of file fallback_config.cc.

References name.

◆ get_num_color_spaces()

int blender::ocio::FallbackConfig::get_num_color_spaces ( ) const
overridevirtual

Get the number of color spaces in this configuration.

Implements blender::ocio::Config.

Definition at line 83 of file fallback_config.cc.

◆ get_num_displays()

int blender::ocio::FallbackConfig::get_num_displays ( ) const
overridevirtual

Get the number of displays in this configuration.

Implements blender::ocio::Config.

Definition at line 148 of file fallback_config.cc.

◆ get_num_looks()

int blender::ocio::FallbackConfig::get_num_looks ( ) const
overridevirtual

Get the number of looks in this configuration.

Implements blender::ocio::Config.

Definition at line 190 of file fallback_config.cc.

◆ get_sorted_color_space_by_index()

const ColorSpace * blender::ocio::FallbackConfig::get_sorted_color_space_by_index ( int index) const
overridevirtual

Get color space with the given index within the sorted array. This function allows to iterate color spaces in their alphabetical order.

If the index is invalid nullptr is returned.

Implements blender::ocio::Config.

Definition at line 96 of file fallback_config.cc.

References get_color_space_by_index().

◆ get_xyz_to_scene_linear_matrix()

float3x3 blender::ocio::FallbackConfig::get_xyz_to_scene_linear_matrix ( ) const
overridevirtual

Get conversion matrix from XYZ space to the scene linear. TODO(sergey): Specialize which exactly XYZ space it is.

Implements blender::ocio::Config.

Definition at line 27 of file fallback_config.cc.

References blender::ocio::XYZ_TO_REC709.

◆ MEM_CXX_CLASS_ALLOC_FUNCS()

blender::ocio::FallbackConfig::MEM_CXX_CLASS_ALLOC_FUNCS ( "FallbackConfig" )

◆ set_scene_linear_role()

void blender::ocio::FallbackConfig::set_scene_linear_role ( StringRefNull name)
overridevirtual

Implements blender::ocio::Config.

Definition at line 127 of file fallback_config.cc.


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