Improve consistency of debug names

Hierarchies are now always denoted with a colon.  Square brackets are
used to add indexing-like details to child objects.

diff --git a/source/animation/animation.cpp b/source/animation/animation.cpp
index a79e1f8d9860d9e31cdde6baf083cb3423b6c392..ea86f9a4799879b5f6455c54cd7ea3322ba6da12 100644 (file)
--- a/source/animation/animation.cpp
+++ b/source/animation/animation.cpp
@@ -540,7 +540,7 @@ void Animation::Loader::load_kf_inline(bool c)
        if(coll)
        {
                KeyFrame::Loader ldr(*kf, get_collection());
-               ldr.set_inline_base_name(format("%s/%d.kframe", FS::basename(get_source()), obj.keyframes.size()));
+               ldr.set_inline_base_name(format("%s: %d.kframe", FS::basename(get_source()), obj.keyframes.size()));
                load_sub_with(ldr);
        }
        else

diff --git a/source/backends/opengl/framebuffer_backend.cpp b/source/backends/opengl/framebuffer_backend.cpp
index 8ba947dfe1eb0528e91521fa3d853ec04a74e082..a81566b5adcc1355c28f7fddb5a98c91daf6655d 100644 (file)
--- a/source/backends/opengl/framebuffer_backend.cpp
+++ b/source/backends/opengl/framebuffer_backend.cpp
@@ -208,7 +208,7 @@ void OpenGLFramebuffer::set_debug_name(const string &name)
                glObjectLabel(GL_FRAMEBUFFER, id, name.size(), name.c_str());
                if(resolve_id)
                {
-                       string resolve_name = name+" [resolve]";
+                       string resolve_name = name+": resolve";
                        glObjectLabel(GL_FRAMEBUFFER, resolve_id, resolve_name.size(), resolve_name.c_str());
                }
        }

diff --git a/source/backends/opengl/program_backend.cpp b/source/backends/opengl/program_backend.cpp
index 3ebb7da1292d8de854a09131a3eb3ece18eb127b..a4e2958b74e0632aad7b0b58a1f49e7a6648b7e1 100644 (file)
--- a/source/backends/opengl/program_backend.cpp
+++ b/source/backends/opengl/program_backend.cpp
@@ -550,7 +550,7 @@ void OpenGLProgram::set_debug_name(const string &name)
 void OpenGLProgram::set_stage_debug_name(unsigned stage_id, Stage type)
 {
 #ifdef DEBUG
-       static const char *const suffixes[] = { " [VS]", " [TCS]", " [TES]", " [GS]", " [FS]", " [CS]" };
+       static const char *const suffixes[] = { ": VS", ": TCS", ": TES", ": GS", ": FS", ": CS" };
        string name = debug_name+suffixes[type];
        glObjectLabel(GL_SHADER, stage_id, name.size(), name.c_str());
 #else

diff --git a/source/backends/vulkan/program_backend.cpp b/source/backends/vulkan/program_backend.cpp
index 10c04d83e7eabe6c6cb3cd7b79f5dfbc84ee7b34..52f49c49abe721906553c48448e3a5d2abf7feaf 100644 (file)
--- a/source/backends/vulkan/program_backend.cpp
+++ b/source/backends/vulkan/program_backend.cpp
@@ -203,7 +203,7 @@ void VulkanProgram::set_vulkan_object_name() const
 #ifdef DEBUG
        const VulkanFunctions &vk = device.get_functions();
 
-       string layout_name = debug_name+" [layout]";
+       string layout_name = debug_name+": layout";
 
        VkDebugUtilsObjectNameInfoEXT name_info = { };
        name_info.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT;
@@ -215,7 +215,7 @@ void VulkanProgram::set_vulkan_object_name() const
        name_info.objectType = VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT;
        for(unsigned i=0; i<desc_set_layout_handles.size(); ++i)
        {
-               layout_name = format("%s [layout:%d]", debug_name, i);
+               layout_name = format("%s: layout[set=%d]", debug_name, i);
        name_info.objectHandle = reinterpret_cast<uint64_t>(desc_set_layout_handles[i]);
                name_info.pObjectName = layout_name.c_str();
                vk.SetDebugUtilsObjectName(name_info);

diff --git a/source/backends/vulkan/texture_backend.cpp b/source/backends/vulkan/texture_backend.cpp
index db420991ee1ebf17861c8b26c6aa4666f49b93fd..b0ddb2ee2ef6268ea2682ea810752f41d7981f53 100644 (file)
--- a/source/backends/vulkan/texture_backend.cpp
+++ b/source/backends/vulkan/texture_backend.cpp
@@ -206,7 +206,7 @@ void VulkanTexture::set_vulkan_object_names() const
        name_info.pObjectName = debug_name.c_str();
        vk.SetDebugUtilsObjectName(name_info);
 
-       string view_name = debug_name+"/view";
+       string view_name = debug_name+": view";
        name_info.objectType = VK_OBJECT_TYPE_IMAGE_VIEW;
        name_info.objectHandle = reinterpret_cast<uint64_t>(view_handle);
        name_info.pObjectName = view_name.c_str();
@@ -216,7 +216,7 @@ void VulkanTexture::set_vulkan_object_names() const
        {
                for(unsigned i=0; i<mip_view_handles.size(); ++i)
                {
-                       view_name = format("%s/mip%d.view", debug_name, i);
+                       view_name = format("%s: view[mip=%d]", debug_name, i);
                        name_info.objectHandle = reinterpret_cast<uint64_t>(mip_view_handles[i]);
                        name_info.pObjectName = view_name.c_str();
                        vk.SetDebugUtilsObjectName(name_info);

diff --git a/source/builders/sequencebuilder.cpp b/source/builders/sequencebuilder.cpp
index 01208cf4cc32a6c5a4c5245a57d74b32c0740cda..4a2c6f63fba13313207f4fada49d4aa5170d3d2d 100644 (file)
--- a/source/builders/sequencebuilder.cpp
+++ b/source/builders/sequencebuilder.cpp
@@ -61,7 +61,7 @@ void SequenceBuilder::build(Sequence &sequence) const
                                Effect *effect = r.effect_template->create(final_renderables);
 #ifdef DEBUG
                                if(!debug_name.empty())
-                                       effect->set_debug_name(format("%s/%s", debug_name, r.slot_name));
+                                       effect->set_debug_name(format("%s: %s", debug_name, r.slot_name));
 #endif
                                ptr = effect;
                        }
@@ -70,7 +70,7 @@ void SequenceBuilder::build(Sequence &sequence) const
                                Sequence *seq = new Sequence;
 #ifdef DEBUG
                                if(!debug_name.empty())
-                                       seq->set_debug_name(format("%s/%s", debug_name, r.slot_name));
+                                       seq->set_debug_name(format("%s: %s", debug_name, r.slot_name));
 #endif
                                ptr = seq;
                                sequences.push_back(&r);
@@ -124,7 +124,7 @@ void SequenceBuilder::build(Sequence &sequence) const
                                proc = p.postprocessor_template->create(sequence.get_width(), sequence.get_height());
 #ifdef DEBUG
                                if(!debug_name.empty())
-                                       proc->set_debug_name(format("%s/%d.pproc", debug_name, index++));
+                                       proc->set_debug_name(format("%s: pproc[%d]", debug_name, index++));
 #endif
                        }
                        else

diff --git a/source/builders/sequencetemplate.cpp b/source/builders/sequencetemplate.cpp
index 2886e0a85ef1d2ee7963be95a3aa6d88eb13d27f..67948b8a35a91b25bff8ba86521ac90dc7f96c3d 100644 (file)
--- a/source/builders/sequencetemplate.cpp
+++ b/source/builders/sequencetemplate.cpp
@@ -161,7 +161,7 @@ void SequenceTemplate::Loader::step(const string &tag, const string &rend)
        stp.tag = tag;
        stp.renderable_name = rend;
        Step::Loader ldr(stp, get_collection());
-       ldr.set_inline_base_name(format("%s/%d.step", get_source(), obj.steps.size()));
+       ldr.set_inline_base_name(format("%s: step[%d]", get_source(), obj.steps.size()));
        load_sub_with(ldr);
 
        obj.steps.push_back(stp);

diff --git a/source/core/mesh.cpp b/source/core/mesh.cpp
index 360d588f97659d9a3e2d395fa876029a4d84a337..6218601eb331ed15c1f3183dd1e36c8e586401c8 100644 (file)
--- a/source/core/mesh.cpp
+++ b/source/core/mesh.cpp
@@ -71,7 +71,7 @@ void Mesh::check_buffers(unsigned mask)
 
 #ifdef DEBUG
                        if(!debug_name.empty())
-                               vbuf->set_debug_name(debug_name+" [VBO]");
+                               vbuf->set_debug_name(debug_name+": VBO");
 #endif
                }
        }
@@ -89,7 +89,7 @@ void Mesh::check_buffers(unsigned mask)
 
 #ifdef DEBUG
                        if(!debug_name.empty())
-                               vbuf->set_debug_name(debug_name+" [IBO]");
+                               vbuf->set_debug_name(debug_name+": IBO");
 #endif
                }
 
@@ -249,10 +249,10 @@ void Mesh::set_debug_name(const string &name)
 #ifdef DEBUG
        debug_name = name;
        if(vbuf)
-               vbuf->set_debug_name(name+" [VBO]");
+               vbuf->set_debug_name(name+": VBO");
        if(ibuf)
-               ibuf->set_debug_name(name+" [IBO]");
-       vtx_setup.set_debug_name(name+" [VAO]");
+               ibuf->set_debug_name(name+": IBO");
+       vtx_setup.set_debug_name(name+": VAO");
 #else
        (void)name;
 #endif

diff --git a/source/effects/ambientocclusion.cpp b/source/effects/ambientocclusion.cpp
index c7fff846fbbe655b7d25f0d5b7daf886ed42d866..287dacf13f8dbb65e99e7ee14766887d08458f81 100644 (file)
--- a/source/effects/ambientocclusion.cpp
+++ b/source/effects/ambientocclusion.cpp
@@ -124,8 +124,8 @@ void AmbientOcclusion::render(Renderer &renderer, const Texture2D &color, const
 void AmbientOcclusion::set_debug_name(const string &name)
 {
 #ifdef DEBUG
-       occlude_target.set_debug_name(name+" [RT]");
-       shdata.set_debug_name(name+" [UBO]");
+       occlude_target.set_debug_name(name+": RT");
+       shdata.set_debug_name(name+": UBO");
 #else
        (void)name;
 #endif

diff --git a/source/effects/bloom.cpp b/source/effects/bloom.cpp
index b9b63bcbc1d3505758dd347ae869fe29be98b554..fba608e7f7c20f2f870cafb3853867b04d2d94a2 100644 (file)
--- a/source/effects/bloom.cpp
+++ b/source/effects/bloom.cpp
@@ -87,10 +87,10 @@ void Bloom::set_debug_name(const string &name)
 {
 #ifdef DEBUG
        for(unsigned i=0; i<2; ++i)
-               target[i]->set_debug_name(format("%s [RT:%d]", name, i));
-       common_shdata.set_debug_name(name+" [UBO:common]");
-       blur_shdata[0].set_debug_name(name+" [UBO:blur_x]");
-       blur_shdata[1].set_debug_name(name+" [UBO:blur_y]");
+               target[i]->set_debug_name(format("%s: RT[%d]", name, i));
+       common_shdata.set_debug_name(name+": UBO[common]");
+       blur_shdata[0].set_debug_name(name+": UBO[blur_x]");
+       blur_shdata[1].set_debug_name(name+": UBO[blur_y]");
 #else
        (void)name;
 #endif

diff --git a/source/effects/colorcurve.cpp b/source/effects/colorcurve.cpp
index ac1ed9aa64bac9d50b3910c14c0356658afd782b..ffc5497a2f4ad52a2f0f2edd77ca879b4cc60652 100644 (file)
--- a/source/effects/colorcurve.cpp
+++ b/source/effects/colorcurve.cpp
@@ -80,8 +80,8 @@ void ColorCurve::render(Renderer &renderer, const Texture2D &color_buf, const Te
 void ColorCurve::set_debug_name(const string &name)
 {
 #ifdef DEBUG
-       shdata.set_debug_name(name+" [UBO]");
-       curve.set_debug_name(name+"/curve.tex");
+       shdata.set_debug_name(name+": UBO");
+       curve.set_debug_name(name+": curve.tex");
 #else
        (void)name;
 #endif

diff --git a/source/effects/environmentmap.cpp b/source/effects/environmentmap.cpp
index a6cb6a36aabdcda0a8db43447737762647be4296..c0bfc8a22c271a8901aae43d0bc70c2843bae3c5 100644 (file)
--- a/source/effects/environmentmap.cpp
+++ b/source/effects/environmentmap.cpp
@@ -195,21 +195,21 @@ void EnvironmentMap::render(Renderer &renderer, Tag tag) const
 void EnvironmentMap::set_debug_name(const string &name)
 {
 #ifdef DEBUG
-       env_tex.set_debug_name(name+"/environment.tex");
-       depth_buf.set_debug_name(name+"/environment_depth.rbuf");
+       env_tex.set_debug_name(name+": environment.tex");
+       depth_buf.set_debug_name(name+": environment_depth.tex");
        static const char *const face_names[] = { "X+", "X-", "Y+", "Y-", "Z+", "Z-" };
        for(unsigned i=0; i<6; ++i)
        {
-               faces[i].fbo.set_debug_name(format("%s [FBO:%s]", name, face_names[i]));
-               faces[i].camera.set_debug_name(format("%s/%s.camera", name, face_names[i]));
+               faces[i].fbo.set_debug_name(format("%s: FBO[%s]", name, face_names[i]));
+               faces[i].camera.set_debug_name(format("%s: %s.camera", name, face_names[i]));
        }
 
-       irradiance.set_debug_name(name+"/irradiance.tex");
-       irradiance_fbo.set_debug_name(name+" [FBO:irradiance]");
+       irradiance.set_debug_name(name+": irradiance.tex");
+       irradiance_fbo.set_debug_name(name+": FBO[irradiance]");
        for(unsigned i=0; i<specular_fbos.size(); ++i)
-               specular_fbos[i].set_debug_name(format("%s [FBO:specular_mip%d]", name, i+1));
-       prefilter_shdata.set_debug_name(name+" [UBO:prefilter]");
-       shdata.set_debug_name(name+" [UBO]");
+               specular_fbos[i].set_debug_name(format("%s: FBO[specular, mip=%d]", name, i+1));
+       prefilter_shdata.set_debug_name(name+": UBO[prefilter]");
+       shdata.set_debug_name(name+": UBO[render]");
 #else
        (void)name;
 #endif

diff --git a/source/effects/shadowmap.cpp b/source/effects/shadowmap.cpp
index bbf602bc60f2ed483215074c0727eba0e8ea2634..d3bd358ebb75ace528f9d6bd4e871ff10c71de0b 100644 (file)
--- a/source/effects/shadowmap.cpp
+++ b/source/effects/shadowmap.cpp
@@ -148,7 +148,7 @@ void ShadowMap::add_light(const Light &light, unsigned s, ShadowType type, Rende
        if(!debug_name.empty())
        {
                for(unsigned i=sl.view_index; i<views.size(); ++i)
-                       views[i].camera.set_debug_name(format("%s/view%d.camera", debug_name, i));
+                       views[i].camera.set_debug_name(format("%s: view[%d].camera", debug_name, i));
        }
 #endif
 }
@@ -263,11 +263,11 @@ void ShadowMap::render(Renderer &renderer, Tag tag) const
 void ShadowMap::set_debug_name(const string &name)
 {
 #ifdef DEBUG
-       fbo.set_debug_name(name+" [FBO]");
+       fbo.set_debug_name(name+": FBO");
        for(unsigned i=0; i<views.size(); ++i)
-               views[i].camera.set_debug_name(format("%s/view%d.camera", name, i));
-       depth_buf.set_debug_name(name+"/depth.tex");
-       shdata.set_debug_name(name+" [UBO]");
+               views[i].camera.set_debug_name(format("%s: view[%d].camera", name, i));
+       depth_buf.set_debug_name(name+": depth.tex");
+       shdata.set_debug_name(name+": UBO");
 #else
        (void)name;
 #endif

diff --git a/source/effects/sky.cpp b/source/effects/sky.cpp
index be4896fbbd9e725632d5d1dfd8f3fdf0fd9df140..42c22686905044385ea5cfe090c4e8e5377b3873 100644 (file)
--- a/source/effects/sky.cpp
+++ b/source/effects/sky.cpp
@@ -154,9 +154,9 @@ void Sky::render(Renderer &renderer, Tag tag) const
 void Sky::set_debug_name(const string &name)
 {
 #ifdef DEBUG
-       transmittance_lookup.set_debug_name(name+" [RT:transmittance]");
-       distant.set_debug_name(name+" [RT:distant]");
-       shdata.set_debug_name(name+" [UBO]");
+       transmittance_lookup.set_debug_name(name+": RT[transmittance]");
+       distant.set_debug_name(name+": RT[distant]");
+       shdata.set_debug_name(name+": UBO");
 #else
        (void)name;
 #endif

diff --git a/source/materials/lighting.cpp b/source/materials/lighting.cpp
index d8e5400626ae43eb26221ebd92bd748bb8043972..016ee92efcc2c0d9711f5ea5bd9218f72d5f0b9f 100644 (file)
--- a/source/materials/lighting.cpp
+++ b/source/materials/lighting.cpp
@@ -91,7 +91,7 @@ const ProgramData &Lighting::get_shader_data() const
 void Lighting::set_debug_name(const string &name)
 {
 #ifdef DEBUG
-       shdata.set_debug_name(name+" [UBO]");
+       shdata.set_debug_name(name+": UBO");
 #else
        (void)name;
 #endif

diff --git a/source/materials/material.cpp b/source/materials/material.cpp
index 39ddec1d56b3ebc351aed7565e570a8fb440e076..62d3b3ba7e76cd08ff22ff9a691267cd94ac6d12 100644 (file)
--- a/source/materials/material.cpp
+++ b/source/materials/material.cpp
@@ -73,7 +73,7 @@ void Material::set_alpha_feather(float f)
 void Material::set_debug_name(const string &name)
 {
 #ifdef DEBUG
-       shdata.set_debug_name(name+" [UBO]");
+       shdata.set_debug_name(name+": UBO");
 #else
        (void)name;
 #endif

diff --git a/source/materials/rendermethod.cpp b/source/materials/rendermethod.cpp
index 78b937d017f40ae069ff0900082ca4675900dae1..86136fb5561ddb4c0d25f0baf330103498f00fce 100644 (file)
--- a/source/materials/rendermethod.cpp
+++ b/source/materials/rendermethod.cpp
@@ -134,7 +134,7 @@ void RenderMethod::set_debug_name(const string &name)
 {
 #ifdef DEBUG
        if(shdata.refcount()==1)
-               shdata->set_debug_name(name+" [UBO]");
+               shdata->set_debug_name(name+": UBO");
 #else
        (void)name;
 #endif

diff --git a/source/materials/technique.cpp b/source/materials/technique.cpp
index 163cbec60f0003245631fca2f503a9cdfc0cea5c..92ccde46b79a3052358f50b62fada8a0bcdc13b8 100644 (file)
--- a/source/materials/technique.cpp
+++ b/source/materials/technique.cpp
@@ -99,7 +99,10 @@ void Technique::set_debug_name(const string &name)
 {
 #ifdef DEBUG
        for(auto &kvp: methods)
-               kvp.second.set_debug_name(format("%s [method:%s]", name, kvp.first.str()));
+       {
+               string n = kvp.first.str();
+               kvp.second.set_debug_name(format("%s: method[%s]", name, (n.empty() ? "\"\"" : n.c_str())));
+       }
 #else
        (void)name;
 #endif
@@ -136,7 +139,8 @@ void Technique::Loader::method(const string &n)
 {
        RenderMethod p;
        RenderMethod::Loader ldr(p, get_collection());
-       ldr.set_inline_base_name(format("%s/%s.method", (inline_base_name.empty() ? FS::basename(get_source()) : inline_base_name), n));
+       ldr.set_inline_base_name(format("%s: method[%s]",
+               (inline_base_name.empty() ? FS::basename(get_source()) : inline_base_name), (n.empty() ? "\"\"" : n.c_str())));
        load_sub_with(ldr);
 
        if(!p.get_shader_program())

diff --git a/source/render/camera.cpp b/source/render/camera.cpp
index bc8de57e51068b3eaa450ee996ccb79d108fc72b..67fa4f517920561b01716715f676b507028638a8 100644 (file)
--- a/source/render/camera.cpp
+++ b/source/render/camera.cpp
@@ -221,7 +221,7 @@ void Camera::update_frustum_planes()
 void Camera::set_debug_name(const string &name)
 {
 #ifdef DEBUG
-       shdata.set_debug_name(name+" [UBO]");
+       shdata.set_debug_name(name+": UBO");
 #else
        (void)name;
 #endif

diff --git a/source/render/rendertarget.cpp b/source/render/rendertarget.cpp
index 7eba2b2beb379c1a779d9fd0cc058b2cf1cc1f65..28fd5669907133993813e748e2459cf4013958ff 100644 (file)
--- a/source/render/rendertarget.cpp
+++ b/source/render/rendertarget.cpp
@@ -69,7 +69,7 @@ const Texture2D &RenderTarget::get_target_texture(FrameAttachment fa) const
 void RenderTarget::set_debug_name(const string &name)
 {
 #ifdef DEBUG
-       fbo.set_debug_name(name+" [FBO]");
+       fbo.set_debug_name(name+": FBO");
        bool multisample = (fbo.get_format().get_samples()>1);
        unsigned i = 0;
        for(FrameAttachment a: fbo.get_format())
@@ -78,11 +78,11 @@ void RenderTarget::set_debug_name(const string &name)
 
                string tex_name;
                if(attach_pt==get_attach_point(DEPTH_ATTACHMENT))
-                       tex_name = name+"/depth";
+                       tex_name = name+": depth";
                else if(attach_pt==get_attach_point(STENCIL_ATTACHMENT))
-                       tex_name = name+"/stencil";
+                       tex_name = name+": stencil";
                else
-                       tex_name = Msp::format("%s/color%d", name, attach_pt);
+                       tex_name = Msp::format("%s: color[%d]", name, attach_pt);
 
                textures[i++]->set_debug_name(tex_name+".tex");
                if(multisample)

diff --git a/source/render/sequence.cpp b/source/render/sequence.cpp
index 4f10026ad497386b39ebb3a89fbd43e5e974518d..a98ed50869a57e07d25eeb5fbc67625f4b164d86 100644 (file)
--- a/source/render/sequence.cpp
+++ b/source/render/sequence.cpp
@@ -171,9 +171,9 @@ void Sequence::set_debug_name(const string &name)
 #ifdef DEBUG
        for(unsigned i=0; i<2; ++i)
                if(target[i])
-                       target[i]->set_debug_name(format("%s [RT:%d]", name, i));
+                       target[i]->set_debug_name(format("%s: RT[%d]", name, i));
        if(target_ms)
-               target_ms->set_debug_name(name+" [RT:ms]");
+               target_ms->set_debug_name(name+": RT[ms]");
 #else
        (void)name;
 #endif