Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_cachefile.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2016 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Kevin Dietrich.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #ifndef __BKE_CACHEFILE_H__
27 #define __BKE_CACHEFILE_H__
28
29 /** \file BKE_cachefile.h
30  *  \ingroup bke
31  */
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct CacheFile;
38 struct Main;
39 struct Scene;
40
41 void BKE_cachefiles_init(void);
42 void BKE_cachefiles_exit(void);
43
44 void *BKE_cachefile_add(struct Main *bmain, const char *name);
45
46 void BKE_cachefile_init(struct CacheFile *cache_file);
47
48 void BKE_cachefile_free(struct CacheFile *cache_file);
49
50 void BKE_cachefile_copy_data(
51         struct Main *bmain, struct CacheFile *cache_file_dst, const struct CacheFile *cache_file_src, const int flag);
52 struct CacheFile *BKE_cachefile_copy(struct Main *bmain, const struct CacheFile *cache_file);
53
54 void BKE_cachefile_make_local(struct Main *bmain, struct CacheFile *cache_file, const bool lib_local);
55
56 void BKE_cachefile_reload(const struct Main *bmain, struct CacheFile *cache_file);
57
58 void BKE_cachefile_ensure_handle(const struct Main *bmain, struct CacheFile *cache_file);
59
60 void BKE_cachefile_update_frame(struct Main *bmain, struct Scene *scene, const float ctime, const float fps);
61
62 bool BKE_cachefile_filepath_get(
63         const struct Main *bmain, const struct CacheFile *cache_file, float frame,
64         char r_filename[1024]);
65
66 float BKE_cachefile_time_offset(struct CacheFile *cache_file, const float time, const float fps);
67
68 void BKE_cachefile_clean(struct Main *bmain, struct CacheFile *cache_file);
69
70 #ifdef __cplusplus
71 }
72 #endif
73
74 #endif  /* __BKE_CACHEFILE_H__ */