Blender V5.3
OCIO_config.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2025 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
7#include <memory>
8
9#include "BLI_function_ref.hh"
12#include "BLI_string_ref.hh"
13
14namespace blender::ocio {
15
16class ColorSpace;
17class Display;
18class Look;
19class CPUProcessor;
20class GPUShaderBinder;
21
23 /* Convert from a colorspace to a display, using the view transform and look. */
28 /* Artistic controls. */
29 float scale = 1.0f;
30 float exponent = 1.0f;
31 float temperature = 6500.0f;
32 float tint = 10.0f;
33 bool use_white_balance = false;
34 /* Writing to a HDR windows buffer. */
35 bool use_hdr_buffer = false;
36 /* Chosen display is HDR. */
37 bool use_hdr_display = false;
38 /* Display transform is being used for image output. */
39 bool is_image_output = false;
40 /* Rather than outputting colors for the specified display, output extended
41 * sRGB colors emulating the specified display. */
43 /* Rather than outputting native display colors, output in a color space
44 * suitable for plotting SDR or HDR scopes. */
45 bool use_scope_space = false;
46 /* Invert the entire transform. */
47 bool inverse = false;
48};
49
50class Config {
51 public:
52 /* -------------------------------------------------------------------- */
55
56 virtual ~Config() = default;
57
62 static std::unique_ptr<Config> create_from_environment();
63
71 static std::unique_ptr<Config> create_fallback();
72
80 virtual bool switch_to_from_environment(FunctionRef<bool(const Config &)> validate) = 0;
81
88 virtual bool switch_to(Config &new_config, FunctionRef<bool(const Config &)> validate) = 0;
89
91
92 /* -------------------------------------------------------------------- */
95
99 virtual float3 get_default_luma_coefs() const = 0;
100
106
111 virtual const char *get_color_space_from_filepath(const char *filepath) const = 0;
112
114
115 /* -------------------------------------------------------------------- */
118
124 virtual const ColorSpace *get_color_space(StringRefNull name) const = 0;
125
129 virtual int get_num_active_color_spaces() const = 0;
130
135 virtual int get_num_all_color_spaces() const = 0;
136
141 virtual const ColorSpace *get_color_space_by_index(int index) const = 0;
142
149 virtual const ColorSpace *get_sorted_color_space_by_index(int index) const = 0;
150
155 virtual const ColorSpace *get_color_space_by_interop_id(StringRefNull interop_id) const = 0;
156
162
164 virtual bool is_role(StringRefNull name) const = 0;
165
167
168 /* -------------------------------------------------------------------- */
171
172 virtual void set_scene_linear_role(StringRefNull name) = 0;
173
175
176 /* -------------------------------------------------------------------- */
179
183 virtual const Display *get_default_display() const = 0;
184
189 virtual const Display *get_display_by_name(StringRefNull name) const = 0;
190
194 virtual int get_num_displays() const = 0;
195
200 virtual const Display *get_display_by_index(int index) const = 0;
201
203
204 /* -------------------------------------------------------------------- */
207
213 StringRefNull view) const = 0;
214
216
217 /* -------------------------------------------------------------------- */
220
225 virtual const Look *get_look_by_name(StringRefNull name) const = 0;
226
230 virtual int get_num_looks() const = 0;
231
236 virtual const Look *get_look_by_index(int index) const = 0;
237
239
240 /* -------------------------------------------------------------------- */
243
248 virtual std::shared_ptr<const CPUProcessor> get_display_cpu_processor(
249 const DisplayParameters &display_parameters) const = 0;
250
254 virtual std::shared_ptr<const CPUProcessor> get_cpu_processor(
255 StringRefNull from_colorspace, StringRefNull to_colorspace) const = 0;
256
258
259 /* -------------------------------------------------------------------- */
262
266 virtual const GPUShaderBinder &get_gpu_shader_binder() const = 0;
267
269};
270
271} // namespace blender::ocio
virtual const Look * get_look_by_name(StringRefNull name) const =0
virtual float3 get_default_luma_coefs() const =0
virtual const Look * get_look_by_index(int index) const =0
virtual void set_scene_linear_role(StringRefNull name)=0
virtual const ColorSpace * get_sorted_color_space_by_index(int index) const =0
virtual int get_num_looks() const =0
virtual const ColorSpace * get_color_space_for_hdr_image(StringRefNull name) const =0
static std::unique_ptr< Config > create_fallback()
Definition config.cc:16
virtual const Display * get_display_by_index(int index) const =0
virtual ~Config()=default
virtual bool is_role(StringRefNull name) const =0
virtual const GPUShaderBinder & get_gpu_shader_binder() const =0
virtual const ColorSpace * get_color_space_by_index(int index) const =0
virtual const ColorSpace * get_display_view_color_space(StringRefNull display, StringRefNull view) const =0
virtual const Display * get_display_by_name(StringRefNull name) const =0
virtual const ColorSpace * get_color_space_by_interop_id(StringRefNull interop_id) const =0
virtual bool switch_to_from_environment(FunctionRef< bool(const Config &)> validate)=0
virtual int get_num_active_color_spaces() const =0
virtual const char * get_color_space_from_filepath(const char *filepath) const =0
virtual int get_num_all_color_spaces() const =0
virtual std::shared_ptr< const CPUProcessor > get_cpu_processor(StringRefNull from_colorspace, StringRefNull to_colorspace) const =0
virtual const Display * get_default_display() const =0
virtual const ColorSpace * get_color_space(StringRefNull name) const =0
static std::unique_ptr< Config > create_from_environment()
Definition config.cc:11
virtual bool switch_to(Config &new_config, FunctionRef< bool(const Config &)> validate)=0
virtual int get_num_displays() const =0
virtual float3x3 get_xyz_to_scene_linear_matrix() const =0
virtual std::shared_ptr< const CPUProcessor > get_display_cpu_processor(const DisplayParameters &display_parameters) const =0
MatBase< float, 3, 3 > float3x3
VecBase< float, 3 > float3