lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-07-30 19:31:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add helpers for managing annotations in structured data

Browse Source
This commit is contained in:
baldurk
2026-01-28 14:42:09 +00:00
parent 8f0a408a2b
commit 650458beae
5 changed files with 329 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
renderdoc/api/replay/data_types.h
+20
View File
@@ -669,6 +669,13 @@ typically it is one parent to many derived.
)");
rdcarray<ResourceId> parentResources;
DOCUMENT(R"(An optional set of annotations associated with this resource, may be ``None`` if
annotations are not used.
:type: SDObject
)");
SDObject *annotations = NULL;
DOCUMENT(R"(Utility function for setting up a custom name to overwrite the auto-generated one.
:param str givenName: The custom name to use.
@@ -964,6 +971,13 @@ markers added to the capture after load.
)");
uint64_t fileOffset = 0;
DOCUMENT(R"(An optional set of annotations associated with this event, may be ``None`` if
annotations are not used.
:type: SDObject
)");
SDObject *annotations = NULL;
static const uint32_t NoChunk = ~0U;
};
@@ -1855,6 +1869,12 @@ this counts the frame number when the capture was made.
)");
rdcarray<DebugMessage> debugMessages;
DOCUMENT(R"(Whether or not the capture contains any annotations.
:type: bool
)");
bool containsAnnotations = false;
static const uint32_t NoFrameNumber = ~0U;
};
renderdoc/api/replay/structured_data.h
+126 -7
View File
@@ -619,9 +619,9 @@ struct SDObject
PopulateAllChildren();
}
ret->data.children.resize(data.children.size());
ret->data.children.reserve(data.children.size());
for(size_t i = 0; i < data.children.size(); i++)
ret->data.children[i] = data.children[i]->Duplicate();
ret->AddAndOwnChild(data.children[i]->Duplicate());
return ret;
}
@@ -691,8 +691,7 @@ recursively through children.
// fully owned children. This shouldn't happen, but just in case we'll evaluate the lazy array
// here.
PopulateAllChildren();
data.children.push_back(child->Duplicate());
data.children.back()->m_Parent = this;
AddAndOwnChild(child->Duplicate());
}
DOCUMENT(R"(Find a child object by a given name. If no matching child is found, ``None`` is
returned.
@@ -734,6 +733,127 @@ The order of the search is not guaranteed, so care should be taken when the name
return NULL;
}
DOCUMENT(R"(Create a child object by a key path. Children will be created as necessary to ensure
that the key path exists, but if they already exist then the existing object will be returned.
Key paths are dotted recursive references, e.g. ``foo.bar`` is the member ``bar`` in parent ``foo``.
Arrays are represented by simple numeric entries e.g. ``foo.0.bar``, ``foo.1.bar``.
Empty entries are ignored so ``foo..bar`` and ``foo.bar`` refer to the same object.
Key paths must not be empty and must not begin with a dot.
If any path element is not unique in any child the behaviour is undefined, so objects should only be
manipulated by key path exclusively or not at all.
:param str keyPath: The key path to search for and return.
:return: A reference to the object at the relative key path
:rtype: SDObject
)");
inline SDObject *CreateChildByKeyPath(const rdcstr &keyPath)
{
if(keyPath.empty() || keyPath[0] == '.')
return this;
int dotIdx = keyPath.indexOf('.');
rdcstr element = keyPath.substr(0, dotIdx);
SDObject *child = NULL;
for(size_t i = 0; i < data.children.size(); i++)
if(GetChild(i)->name == element)
child = GetChild(i);
if(!child)
child = AddAndOwnChild(new SDObject(element, ""_lit));
while(dotIdx >= 0 && keyPath[dotIdx] == '.')
dotIdx++;
if(dotIdx >= 0 && dotIdx < keyPath.count())
return child->CreateChildByKeyPath(keyPath.substr(dotIdx));
return child;
}
DOCUMENT(R"(Find if a child object if it exists by a key path. Children will not be created
if any element of the path doesn't exist and instead ``None`` will be returned.
Key paths are dotted recursive references, e.g. ``foo.bar`` is the member ``bar`` in parent ``foo``.
Arrays are represented by simple numeric entries e.g. ``foo.0.bar``, ``foo.1.bar``.
Empty entries are ignored so ``foo..bar`` and ``foo.bar`` refer to the same object.
Key paths must not be empty and must not begin with a dot.
If any path element is not unique in any child the behaviour is undefined, so objects should only be
manipulated by key path exclusively or not at all.
:param str keyPath: The key path to search for and return.
:return: Whether or not a child exists at the given key path
:rtype: SDObject
)");
inline const SDObject *FindChildByKeyPath(const rdcstr &keyPath) const
{
if(keyPath.empty() || keyPath[0] == '.')
return this;
int dotIdx = keyPath.indexOf('.');
rdcstr element = keyPath.substr(0, dotIdx);
const SDObject *child = NULL;
for(size_t i = 0; i < data.children.size(); i++)
if(GetChild(i)->name == element)
child = GetChild(i);
if(!child)
return NULL;
while(dotIdx >= 0 && keyPath[dotIdx] == '.')
dotIdx++;
if(dotIdx >= 0 && dotIdx < keyPath.count())
return child->FindChildByKeyPath(keyPath.substr(dotIdx));
return child;
}
DOCUMENT(R"(Delete a child object by a key path. All children of the resulting path will be deleted
as well. If no such path exists, nothing will be changed.
If any path element is not unique in any child the behaviour is undefined, so objects should only be
manipulated by key path exclusively or not at all.
:param str keyPath: The key path to search for and delete.
)");
inline void EraseChildByKeyPath(const rdcstr &keyPath)
{
// shouldn't happen since we delete the found child (if it exists) from the parent, but return to be fault-tolerant
if(keyPath.empty() || keyPath[0] == '.')
return;
int dotIdx = keyPath.indexOf('.');
rdcstr element = keyPath.substr(0, dotIdx);
int childIdx = -1;
for(int i = 0; i < data.children.count(); i++)
if(GetChild(i)->name == element)
childIdx = i;
// if the child doesn't exist we can stop now
if(childIdx < 0)
return;
while(dotIdx >= 0 && keyPath[dotIdx] == '.')
dotIdx++;
if(dotIdx >= 0 && dotIdx < keyPath.count())
return GetChild(childIdx)->EraseChildByKeyPath(keyPath.substr(dotIdx));
RemoveChild(childIdx);
}
DOCUMENT(R"(Find a child object by a given index. If the index is out of bounds, ``None`` is
returned.
@@ -1500,12 +1620,11 @@ struct SDChunk : public SDObject
ret->data.basic = data.basic;
ret->data.str = data.str;
ret->data.children.resize(data.children.size());
PopulateAllChildren();
ret->data.children.reserve(data.children.size());
for(size_t i = 0; i < data.children.size(); i++)
ret->data.children[i] = data.children[i]->Duplicate();
ret->AddAndOwnChild(data.children[i]->Duplicate());
return ret;
}