BLO_writefile.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 */
 
#pragma once
 
struct BlendThumbnail;
struct Main;
struct MemFile;
struct ReportList;
 
/* -------------------------------------------------------------------- */
typedef enum eBLO_WritePathRemap {
  BLO_WRITE_PATH_REMAP_NONE = 0,
  BLO_WRITE_PATH_REMAP_RELATIVE = 1,
  BLO_WRITE_PATH_REMAP_RELATIVE_ALL = 2,
  BLO_WRITE_PATH_REMAP_ABSOLUTE = 3,
} eBLO_WritePathRemap;
 
struct BlendFileWriteParams {
  eBLO_WritePathRemap remap_mode;
  uint use_save_versions : 1;
  uint use_save_as_copy : 1;
  uint use_userdef : 1;
  const struct BlendThumbnail *thumb;
};
 
extern bool BLO_write_file(struct Main *mainvar,
                           const char *filepath,
                           const int write_flags,
                           const struct BlendFileWriteParams *params,
                           struct ReportList *reports);
 
extern bool BLO_write_file_mem(struct Main *mainvar,
                               struct MemFile *compare,
                               struct MemFile *current,
                               int write_flags);