diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-06-23 09:38:52 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-06-23 09:38:52 +0300 |
commit | 4040cb438f8929da6a1c29ba7c9c8288c1f05a5a (patch) | |
tree | f9ecf5b2e3f991be027b7a8439c76155302a4abf /source/blender/blenloader/BLO_readfile.h | |
parent | ed68fee665fae983e3031260e01deff5053065a8 (diff) |
Cleanup: use doxy sections for BLI read/write headers
Add reference between the read/write functions too.
Diffstat (limited to 'source/blender/blenloader/BLO_readfile.h')
-rw-r--r-- | source/blender/blenloader/BLO_readfile.h | 26 |
1 files changed, 19 insertions, 7 deletions
diff --git a/source/blender/blenloader/BLO_readfile.h b/source/blender/blenloader/BLO_readfile.h index 8495caa91b5..e4908eb7257 100644 --- a/source/blender/blenloader/BLO_readfile.h +++ b/source/blender/blenloader/BLO_readfile.h @@ -48,6 +48,18 @@ struct wmWindowManager; typedef struct BlendHandle BlendHandle; +typedef struct WorkspaceConfigFileData { + struct Main *main; /* has to be freed when done reading file data */ + + struct ListBase workspaces; +} WorkspaceConfigFileData; + +/* -------------------------------------------------------------------- */ +/** \name BLO Read File API + * + * \see #BLO_write_file for file writing. + * \{ */ + typedef enum eBlenFileType { BLENFILETYPE_BLEND = 1, /* BLENFILETYPE_PUB = 2, */ /* UNUSED */ @@ -69,12 +81,6 @@ typedef struct BlendFileData { eBlenFileType type; } BlendFileData; -typedef struct WorkspaceConfigFileData { - struct Main *main; /* has to be freed when done reading file data */ - - struct ListBase workspaces; -} WorkspaceConfigFileData; - struct BlendFileReadParams { uint skip_flags : 3; /* eBLOReadSkip */ uint is_startup : 1; @@ -108,6 +114,12 @@ BlendFileData *BLO_read_from_memfile(struct Main *oldmain, void BLO_blendfiledata_free(BlendFileData *bfd); +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name BLO Blend File Handle API + * \{ */ + BlendHandle *BLO_blendhandle_from_file(const char *filepath, struct ReportList *reports); BlendHandle *BLO_blendhandle_from_memory(const void *mem, int memsize); @@ -119,7 +131,7 @@ struct LinkNode *BLO_blendhandle_get_linkable_groups(BlendHandle *bh); void BLO_blendhandle_close(BlendHandle *bh); -/***/ +/** \} */ #define BLO_GROUP_MAX 32 #define BLO_EMBEDDED_STARTUP_BLEND "<startup.blend>" |