OCIO_gpu_shader_binder.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 <string>
 
#include "BLI_array.hh"
#include "BLI_span.hh"
#include "BLI_string_ref.hh"
 
struct CurveMapping;
namespace blender::gpu {
class Shader;
}  // namespace blender::gpu
 
namespace blender::ocio {
 
class Config;
 
namespace internal {
class GPUDisplayShader;
class GPUShaderCache;
}  // namespace internal
 
struct GPUDisplayParameters {
  /* Convert from a colorspace to a display, using the view transform and look. */
  StringRefNull from_colorspace;
  StringRefNull view;
  StringRefNull display;
  StringRefNull look;
  /* Artistic controls. */
  CurveMapping *curve_mapping = nullptr;
  float scale = 1.0f;
  float exponent = 1.0f;
  float dither = 0.0f;
  float temperature = 6500.0f;
  float tint = 10.0f;
  bool use_white_balance = false;
  /* Divide RGB by alpha before performing the transform. */
  bool use_predivide = false;
  /* Composite an overlay buffer on top of the image. */
  bool do_overlay_merge = false;
  /* Writing to a HDR buffer. */
  bool use_hdr_buffer = false;
  /* Chosen display is a HDR display. */
  bool use_hdr_display = false;
  /* Rather than outputting colors for the specified display, output extended
   * sRGB colors emulating the specified display. */
  bool use_display_emulation = false;
};
 
class GPUShaderBinder {
  /* Cache of shaders used for conversion to the display space. */
  std::unique_ptr<internal::GPUShaderCache> display_cache_;
 
  /* Cache of shaders used for conversion to scene linear space. */
  std::unique_ptr<internal::GPUShaderCache> scene_linear_cache_;
 
 public:
  explicit GPUShaderBinder(const Config &config);
  virtual ~GPUShaderBinder();

  bool display_bind(const GPUDisplayParameters &display_parameters) const;

  bool to_scene_linear_bind(StringRefNull from_colorspace, bool use_predivide) const;

  void unbind() const;

  void clear_caches() const;
 
 protected:
  const Config &config_;

  virtual void construct_display_shader(internal::GPUDisplayShader &display_shader) const = 0;

  virtual void construct_scene_linear_shader(internal::GPUDisplayShader &display_shader) const = 0;

  static bool create_gpu_shader(internal::GPUDisplayShader &display_shader,
                                StringRefNull fragment_source,
                                Span<std::array<StringRefNull, 2>> additional_defines);
};
 
}  // namespace blender::ocio