diff options
Diffstat (limited to 'source/blender/blenkernel/BKE_movieclip.h')
| -rw-r--r-- | source/blender/blenkernel/BKE_movieclip.h | 30 |
1 files changed, 26 insertions, 4 deletions
diff --git a/source/blender/blenkernel/BKE_movieclip.h b/source/blender/blenkernel/BKE_movieclip.h index 73c7494b8fa..9148d5b760f 100644 --- a/source/blender/blenkernel/BKE_movieclip.h +++ b/source/blender/blenkernel/BKE_movieclip.h @@ -35,6 +35,10 @@ struct MovieClipScopes; struct MovieClipUser; struct MovieDistortion; +/** + * Checks if image was already loaded, then returns same image otherwise creates new. + * does not load ibuf itself pass on optional frame for #name images. + */ struct MovieClip *BKE_movieclip_file_add(struct Main *bmain, const char *name); struct MovieClip *BKE_movieclip_file_add_exists_ex(struct Main *bmain, const char *filepath, @@ -44,6 +48,11 @@ void BKE_movieclip_reload(struct Main *bmain, struct MovieClip *clip); void BKE_movieclip_clear_cache(struct MovieClip *clip); void BKE_movieclip_clear_proxy_cache(struct MovieClip *clip); +/** + * Will try to make image buffer usable when originating from the multi-layer source. + * Internally finds a first combined pass and uses that as a buffer. + * Not ideal, but is better than a complete empty buffer. + */ void BKE_movieclip_convert_multilayer_ibuf(struct ImBuf *ibuf); struct ImBuf *BKE_movieclip_get_ibuf(struct MovieClip *clip, struct MovieClipUser *user); @@ -75,11 +84,18 @@ void BKE_movieclip_update_scopes(struct MovieClip *clip, struct MovieClipUser *user, struct MovieClipScopes *scopes); +/** + * Get segments of cached frames. useful for debugging cache policies. + */ void BKE_movieclip_get_cache_segments(struct MovieClip *clip, struct MovieClipUser *user, int *r_totseg, int **r_points); +/** + * \note currently used by proxy job for movies, threading happens within single frame + * (meaning scaling shall be threaded). + */ void BKE_movieclip_build_proxy_frame(struct MovieClip *clip, int clip_flag, struct MovieDistortion *distortion, @@ -88,6 +104,10 @@ void BKE_movieclip_build_proxy_frame(struct MovieClip *clip, int build_count, bool undistorted); +/** + * \note currently used by proxy job for sequences, threading happens within sequence + * (different threads handles different frames, no threading within frame is needed) + */ void BKE_movieclip_build_proxy_frame_for_ibuf(struct MovieClip *clip, struct ImBuf *ibuf, struct MovieDistortion *distortion, @@ -104,8 +124,10 @@ void BKE_movieclip_filename_for_frame(struct MovieClip *clip, struct MovieClipUser *user, char *name); -/* Read image buffer from the given movie clip without acquiring the `LOCK_MOVIECLIP` lock. - * Used by a prefetch job which takes care of creating a local copy of the clip. */ +/** + * Read image buffer from the given movie clip without acquiring the #LOCK_MOVIECLIP lock. + * Used by a prefetch job which takes care of creating a local copy of the clip. + */ struct ImBuf *BKE_movieclip_anim_ibuf_for_frame_no_lock(struct MovieClip *clip, struct MovieClipUser *user); @@ -126,10 +148,10 @@ void BKE_movieclip_eval_update(struct Depsgraph *depsgraph, struct MovieClip *clip); void BKE_movieclip_eval_selection_update(struct Depsgraph *depsgraph, struct MovieClip *clip); -/* caching flags */ +/** Caching flags. */ #define MOVIECLIP_CACHE_SKIP (1 << 0) -/* postprocessing flags */ +/** Post-processing flags. */ #define MOVIECLIP_DISABLE_RED (1 << 0) #define MOVIECLIP_DISABLE_GREEN (1 << 1) #define MOVIECLIP_DISABLE_BLUE (1 << 2) |