draw_debug.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2022 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "BLI_math_vector_types.hh"
#include "BLI_mutex.hh"
 
#include "DNA_object_types.h"
 
#include "draw_shader_shared.hh"
 
#include "DRW_gpu_wrapper.hh"
 
namespace blender::draw {
 
class View;

void drw_debug_clear();
 
/* Used for virtually infinite lifetime.
 * Useful for debugging render or baking jobs, or non-modal operators. */
constexpr uint drw_debug_persistent_lifetime = ~0u;

 
void drw_debug_line(float3 v1, float3 v2, float4 color = {1, 0, 0, 1}, uint lifetime = 1);
 
void drw_debug_polygon(Span<float3> face_verts, float4 color = {1, 0, 0, 1}, uint lifetime = 1);
 
void drw_debug_bbox(const BoundBox &bbox, float4 color = {1, 0, 0, 1}, uint lifetime = 1);
 
void drw_debug_sphere(float3 center, float radius, float4 color = {1, 0, 0, 1}, uint lifetime = 1);
void drw_debug_point(float3 pos, float rad = 0.01f, float4 col = {1, 0, 0, 1}, uint lifetime = 1);
void drw_debug_matrix(const float4x4 &m4, uint lifetime = 1);
void drw_debug_matrix_as_bbox(const float4x4 &mat, float4 color = {1, 0, 0, 1}, uint lifetime = 1);
 
class DebugDraw {
 private:
  using DebugDrawBuf = StorageBuffer<DRWDebugDrawBuffer>;

  std::atomic<int> vertex_len_;
  SwapChain<DebugDrawBuf *, 2> cpu_draw_buf_ = {};
  SwapChain<DebugDrawBuf *, 2> gpu_draw_buf_ = {};
  bool gpu_draw_buf_used = false;
 
  /* Reference counter used by GPUContext to allow freeing of DebugDrawBuf before the last
   * context is destroyed. */
  int ref_count_ = 0;
  Mutex ref_count_mutex_;
 
 public:
  void reset();

  void display_to_view(View &view);

  gpu::StorageBuf *gpu_draw_buf_get();
 
  void acquire()
  {
    std::scoped_lock lock(ref_count_mutex_);
    ref_count_++;
    if (ref_count_ == 1) {
      reset();
    }
  }
 
  void release()
  {
    std::scoped_lock lock(ref_count_mutex_);
    ref_count_--;
    if (ref_count_ == 0) {
      clear_gpu_data();
    }
  }
 
  static DebugDraw &get()
  {
    static DebugDraw module;
    return module;
  }
 
  void draw_line(float3 v1, float3 v2, uint color, uint lifetime = 1);
 
  static uint color_pack(float4 color);
 
 private:
  void display_lines(View &view);
 
  void clear_gpu_data();
};
 
}  // namespace blender::draw