Files
test2/source/blender/blenkernel/BKE_image_save.h
Brecht Van Lommel 29a3f43da5 Python API: make Image.save and Image.save_render more consistent with operator
Previously these only supported a subset of what the save operator could do,
for example no multilayer or stereo saving, no proper color management. Now
share code with the image save operator so it's more consistent.
2022-05-16 15:20:23 +02:00

85 lines
2.4 KiB
C

/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2001-2002 NaN Holding BV. All rights reserved. */
#pragma once
#include "DNA_scene_types.h"
/** \file
* \ingroup bke
*/
#ifdef __cplusplus
extern "C" {
#endif
struct Image;
struct ImageUser;
struct Main;
struct RenderResult;
struct ReportList;
struct Scene;
/* Image datablock saving. */
typedef struct ImageSaveOptions {
/* Context within which image is saved. */
struct Main *bmain;
struct Scene *scene;
/* Format and absolute file path. */
struct ImageFormatData im_format;
char filepath[1024]; /* 1024 = FILE_MAX */
/* Options. */
bool relative;
bool save_copy;
bool save_as_render;
bool do_newpath;
/* Keep track of previous values for auto updates in UI. */
bool prev_save_as_render;
int prev_imtype;
} ImageSaveOptions;
bool BKE_image_save_options_init(ImageSaveOptions *opts,
struct Main *bmain,
struct Scene *scene,
struct Image *ima,
struct ImageUser *iuser,
const bool guess_path);
void BKE_image_save_options_update(struct ImageSaveOptions *opts, struct Image *ima);
void BKE_image_save_options_free(struct ImageSaveOptions *opts);
bool BKE_image_save(struct ReportList *reports,
struct Main *bmain,
struct Image *ima,
struct ImageUser *iuser,
struct ImageSaveOptions *opts);
/* Render saving. */
/**
* Save single or multi-layer OpenEXR files from the render result.
* Optionally saves only a specific view or layer.
*/
bool BKE_image_render_write_exr(struct ReportList *reports,
const struct RenderResult *rr,
const char *filepath,
const struct ImageFormatData *imf,
const bool save_as_render,
const char *view,
int layer);
/**
* \param filepath_basis: May be used as-is, or used as a basis for multi-view images.
*/
bool BKE_image_render_write(struct ReportList *reports,
struct RenderResult *rr,
const struct Scene *scene,
const bool stamp,
const char *filepath_basis);
#ifdef __cplusplus
}
#endif