IMB_openexr.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2024 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "BLI_string_ref.hh"
 
/* API for reading and writing multi-layer EXR files. */
 
/* XXX layer+pass name max 64? */
#define EXR_LAY_MAXNAME 64
#define EXR_PASS_MAXNAME 64
#define EXR_VIEW_MAXNAME 64
#define EXR_TOT_MAXNAME 64
#define EXR_PASS_MAXCHAN 24
 
struct StampData;
struct ExrHandle;
 
ExrHandle *IMB_exr_get_handle(bool write_multipart = false);

void IMB_exr_add_channels(ExrHandle *handle,
                          blender::StringRefNull layerpassname,
                          blender::StringRefNull channelnames,
                          blender::StringRefNull viewname,
                          blender::StringRefNull colorspace,
                          size_t xstride,
                          size_t ystride,
                          float *rect,
                          bool use_half_float);

bool IMB_exr_begin_read(
    ExrHandle *handle, const char *filepath, int *width, int *height, bool parse_channels);
bool IMB_exr_begin_write(ExrHandle *handle,
                         const char *filepath,
                         int width,
                         int height,
                         const double ppm[2],
                         int compress,
                         int quality,
                         const StampData *stamp);

bool IMB_exr_set_channel(
    ExrHandle *handle, blender::StringRefNull full_name, int xstride, int ystride, float *rect);
 
void IMB_exr_read_channels(ExrHandle *handle);
void IMB_exr_write_channels(ExrHandle *handle);
 
void IMB_exr_multilayer_convert(ExrHandle *handle,
                                void *base,
                                void *(*addview)(void *base, const char *str),
                                void *(*addlayer)(void *base, const char *str),
                                void (*addpass)(void *base,
                                                void *lay,
                                                const char *str,
                                                float *rect,
                                                int totchan,
                                                const char *chan_id,
                                                const char *view));
 
void IMB_exr_close(ExrHandle *handle);
 
void IMB_exr_add_view(ExrHandle *handle, const char *name);
 
bool IMB_exr_has_multilayer(ExrHandle *handle);
 
bool IMB_exr_get_ppm(ExrHandle *handle, double ppm[2]);