OCIO_config.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2025 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <memory>
 
#include "BLI_math_matrix_types.hh"
#include "BLI_math_vector_types.hh"
#include "BLI_string_ref.hh"
 
namespace blender::ocio {
 
class ColorSpace;
class Display;
class Look;
class CPUProcessor;
class GPUShaderBinder;
 
struct DisplayParameters {
  /* Convert from a colorspace to a display, using the view transform and look. */
  StringRefNull from_colorspace;
  StringRefNull view;
  StringRefNull display;
  StringRefNull look;
  /* Artistic controls. */
  float scale = 1.0f;
  float exponent = 1.0f;
  float temperature = 6500.0f;
  float tint = 10.0f;
  bool use_white_balance = false;
  /* Writing to a HDR windows buffer. */
  bool use_hdr_buffer = false;
  /* Chosen display is HDR. */
  bool use_hdr_display = false;
  /* Display transform is being used for image output. */
  bool is_image_output = false;
  /* Rather than outputting colors for the specified display, output extended
   * sRGB colors emulating the specified display. */
  bool use_display_emulation = false;
  /* Invert the entire transform. */
  bool inverse = false;
};
 
class Config {
 public:
  /* -------------------------------------------------------------------- */
 
  virtual ~Config() = default;

  static std::unique_ptr<Config> create_from_environment();

  static std::unique_ptr<Config> create_from_file(StringRefNull filename);

  static std::unique_ptr<Config> create_fallback();

 
  /* -------------------------------------------------------------------- */

  virtual float3 get_default_luma_coefs() const = 0;

  virtual float3x3 get_xyz_to_scene_linear_matrix() const = 0;

  virtual const char *get_color_space_from_filepath(const char *filepath) const = 0;

 
  /* -------------------------------------------------------------------- */

  virtual const ColorSpace *get_color_space(StringRefNull name) const = 0;

  virtual int get_num_color_spaces() const = 0;

  virtual const ColorSpace *get_color_space_by_index(int index) const = 0;

  virtual const ColorSpace *get_sorted_color_space_by_index(int index) const = 0;

  virtual const ColorSpace *get_color_space_by_interop_id(StringRefNull interop_id) const = 0;

  virtual const ColorSpace *get_color_space_for_hdr_image(StringRefNull name) const = 0;

 
  /* -------------------------------------------------------------------- */
 
  virtual void set_scene_linear_role(StringRefNull name) = 0;

 
  /* -------------------------------------------------------------------- */

  virtual const Display *get_default_display() const = 0;

  virtual const Display *get_display_by_name(StringRefNull name) const = 0;

  virtual int get_num_displays() const = 0;

  virtual const Display *get_display_by_index(int index) const = 0;

 
  /* -------------------------------------------------------------------- */

  virtual const ColorSpace *get_display_view_color_space(StringRefNull display,
                                                         StringRefNull view) const = 0;

 
  /* -------------------------------------------------------------------- */

  virtual const Look *get_look_by_name(StringRefNull name) const = 0;

  virtual int get_num_looks() const = 0;

  virtual const Look *get_look_by_index(int index) const = 0;

 
  /* -------------------------------------------------------------------- */

  virtual std::shared_ptr<const CPUProcessor> get_display_cpu_processor(
      const DisplayParameters &display_parameters) const = 0;

  virtual std::shared_ptr<const CPUProcessor> get_cpu_processor(
      StringRefNull from_colorspace, StringRefNull to_colorspace) const = 0;

 
  /* -------------------------------------------------------------------- */

  virtual const GPUShaderBinder &get_gpu_shader_binder() const = 0;

};
 
}  // namespace blender::ocio