From 6f2e9e9f90a1334cda71e19ebbcb2fd8cbe74e5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Dietrich?= Date: Wed, 31 Mar 2021 17:14:27 +0200 Subject: Alembic procedural: comment, speficy the behavior of a function --- intern/cycles/render/alembic.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'intern') diff --git a/intern/cycles/render/alembic.h b/intern/cycles/render/alembic.h index 4d197a3014a..3bbd10fad61 100644 --- a/intern/cycles/render/alembic.h +++ b/intern/cycles/render/alembic.h @@ -484,7 +484,14 @@ class AlembicProcedural : public Procedural { /* Tag for an update only if something was modified. */ void tag_update(Scene *scene); - /* Returns a pointer to an existing or a newly created AlembicObject for the given path. */ + /* This should be called by scene exporters to request the rendering of an object located + * in the Alembic archive at the given path. + * + * Since we lazily load object, the function does not validate the existence of the object + * in the archive. If no objects with such path if found in the archive during the next call + * to `generate`, it will be ignored. + * + * Returns a pointer to an existing or a newly created AlembicObject for the given path. */ AlembicObject *get_or_create_object(const ustring &path); private: -- cgit v1.2.3