Docs: comment BKE_scene_set_background

This commit is contained in:
Campbell Barton 2015-08-06 21:02:08 +10:00
parent 2c5efd5b3f
commit 8f45e1156f
1 changed files with 5 additions and 0 deletions

View File

@ -756,6 +756,11 @@ Base *BKE_scene_base_find(Scene *scene, Object *ob)
return BLI_findptr(&scene->base, ob, offsetof(Base, object));
}
/**
* Sets the active scene, mainly used when running in background mode (``--scene`` command line argument).
* This is also called to set the scene directly, bypassing windowing code.
* Otherwise #ED_screen_set_scene is used when changing scenes by the user.
*/
void BKE_scene_set_background(Main *bmain, Scene *scene)
{
Scene *sce;