Blender V5.3
IMB_imbuf.hh File Reference

Go to the source code of this file.

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::imbuf
namespace  blender::imbuf::partial_update

Macros

#define FILTER_MASK_NULL   0
#define FILTER_MASK_MARGIN   1
#define FILTER_MASK_USED   2

Enumerations

enum class  blender::IMBThumbLoadFlags { blender::Zero = 0 , blender::LoadLargeFiles = (1 << 0) }
enum  blender::IMB_BlendMode {
  blender::IMB_BLEND_MIX = 0 , blender::IMB_BLEND_ADD = 1 , blender::IMB_BLEND_SUB = 2 , blender::IMB_BLEND_MUL = 3 ,
  blender::IMB_BLEND_LIGHTEN = 4 , blender::IMB_BLEND_DARKEN = 5 , blender::IMB_BLEND_ERASE_ALPHA = 6 , blender::IMB_BLEND_ADD_ALPHA = 7 ,
  blender::IMB_BLEND_OVERLAY = 8 , blender::IMB_BLEND_HARDLIGHT = 9 , blender::IMB_BLEND_COLORBURN = 10 , blender::IMB_BLEND_LINEARBURN = 11 ,
  blender::IMB_BLEND_COLORDODGE = 12 , blender::IMB_BLEND_SCREEN = 13 , blender::IMB_BLEND_SOFTLIGHT = 14 , blender::IMB_BLEND_PINLIGHT = 15 ,
  blender::IMB_BLEND_VIVIDLIGHT = 16 , blender::IMB_BLEND_LINEARLIGHT = 17 , blender::IMB_BLEND_DIFFERENCE = 18 , blender::IMB_BLEND_EXCLUSION = 19 ,
  blender::IMB_BLEND_HUE = 20 , blender::IMB_BLEND_SATURATION = 21 , blender::IMB_BLEND_LUMINOSITY = 22 , blender::IMB_BLEND_COLOR = 23 ,
  blender::IMB_BLEND_INTERPOLATE = 24 , blender::IMB_BLEND_COPY_RGB = 1001 , blender::IMB_BLEND_COPY_ALPHA = 1002
}
enum  blender::eIMBInterpolationFilterMode {
  blender::IMB_FILTER_NEAREST , blender::IMB_FILTER_BILINEAR , blender::IMB_FILTER_CUBIC_BSPLINE , blender::IMB_FILTER_CUBIC_MITCHELL ,
  blender::IMB_FILTER_BOX
}
enum class  blender::IMBScaleFilter { blender::Nearest , blender::Bilinear , blender::Box }
enum  blender::eIMBTransformMode { blender::IMB_TRANSFORM_MODE_REGULAR = 0 , blender::IMB_TRANSFORM_MODE_CROP_SRC = 1 , blender::IMB_TRANSFORM_MODE_WRAP_REPEAT = 2 }
 Transform modes to use for IMB_transform function. More...
enum class  blender::GPUTextureCreateFlags : uint8_t { blender::HighBitDepth = 1 << 0 , blender::Premultiplied = 1 << 1 , blender::LimitSize = 1 << 2 , blender::EnableMipmaps = 1 << 3 }

Functions

void blender::IMB_init ()
void blender::IMB_exit ()
void blender::IMB_ensure_gpu_context ()
void blender::IMB_activate_gpu_context ()
void blender::IMB_deactivate_gpu_context ()
ImBuf * blender::IMB_load_image_from_memory (const unsigned char *mem, size_t size, ImBufFlags flags, const char *descr, const char *filepath=nullptr, ColorManagedColorspaceSettings *colorspace_settings=nullptr)
ImBuf * blender::IMB_load_image_from_file_descriptor (int file, ImBufFlags flags, const char *filepath=nullptr, ColorManagedColorspaceSettings *colorspace_settings=nullptr)
ImBuf * blender::IMB_load_image_from_filepath (const char *filepath, ImBufFlags flags, ColorManagedColorspaceSettings *colorspace_settings=nullptr)
bool blender::IMB_save_image (ImBuf *ibuf, const char *filepath, ImBufFlags flags)
Vector< uint8_t > blender::IMB_save_image_to_buffer (ImBuf *ibuf, ImBufFlags flags)
bool blender::IMB_test_image (const char *filepath)
bool blender::IMB_test_image_type_matches (const char *filepath, eImbFileType filetype)
eImbFileType blender::IMB_test_image_type_from_memory (const unsigned char *buf, size_t buf_size)
eImbFileType blender::IMB_test_image_type (const char *filepath)
bool blender::IMB_ftype_is_supported (eImbFileType ftype)
const char * blender::IMB_ftype_to_id (eImbFileType ftype)
eImbFileType blender::IMB_ftype_from_id (const char *id)
const char ** blender::IMB_ftype_file_extensions (eImbFileType ftype)
eImFileTypeCapability blender::IMB_ftype_capability_read (eImbFileType ftype)
eImFileTypeCapability blender::IMB_ftype_capability_write (eImbFileType ftype)
 blender::ENUM_OPERATORS (IMBThumbLoadFlags)
ImBuf * blender::IMB_thumb_load_image (const char *filepath, size_t max_thumb_size, ColorManagedColorspaceSettings *colorspace_settings, IMBThumbLoadFlags load_flags=IMBThumbLoadFlags::Zero)
ImBuf * blender::IMB_allocImBuf (unsigned int x, unsigned int y, ImBufFlags flags)
void blender::IMB_freeImBuf (ImBuf *ibuf)
bool blender::IMB_initImBuf (ImBuf *ibuf, unsigned int x, unsigned int y, ImBufFlags flags)
ImBuf * blender::IMB_allocFromBufferOwn (uint8_t *byte_buffer, float *float_buffer, unsigned int w, unsigned int h, unsigned int channels)
ImBuf * blender::IMB_allocFromBuffer (const uint8_t *byte_buffer, const float *float_buffer, unsigned int w, unsigned int h, unsigned int channels)
void blender::IMB_assign_gpu_texture (ImBuf *ibuf, gpu::Texture *texture)
void blender::IMB_ensure_host_buffer (ImBuf *ibuf)
void blender::IMB_refImBuf (ImBuf *ibuf)
ImBuf * blender::IMB_makeSingleUser (ImBuf *ibuf)
ImBuf * blender::IMB_dupImBuf (const ImBuf *ibuf1)
size_t blender::IMB_get_size_in_memory (const ImBuf *ibuf)
size_t blender::IMB_get_pixel_count (const ImBuf *ibuf)
 Get the length of the data of the given image buffer in pixels.
void blender::IMB_blend_color_byte (unsigned char dst[4], const unsigned char src1[4], const unsigned char src2[4], IMB_BlendMode mode)
void blender::IMB_blend_color_float (float dst[4], const float src1[4], const float src2[4], IMB_BlendMode mode)
void blender::IMB_blend_color_float (MutableSpan< float4 > dst, Span< float4 > src1, Span< float4 > src2, IMB_BlendMode mode)
void blender::IMB_rectclip (ImBuf *dbuf, const ImBuf *sbuf, int *destx, int *desty, int *srcx, int *srcy, int *width, int *height)
void blender::IMB_rectblend_threaded (ImBuf *dbuf, const ImBuf *obuf, const ImBuf *sbuf, unsigned short *dmask, const unsigned short *curvemask, const unsigned short *texmask, float mask_max, int destx, int desty, int origx, int origy, int srcx, int srcy, int width, int height, IMB_BlendMode mode, bool accumulate)
void blender::IMB_rectblend (ImBuf *dbuf, uint8_t *dbuf_byte_data, float *dbuf_float_data, const ImBuf *obuf, const ImBuf *sbuf, unsigned short *dmask, const unsigned short *curvemask, const unsigned short *texmask, float mask_max, int destx, int desty, int origx, int origy, int srcx, int srcy, int width, int height, IMB_BlendMode mode, bool accumulate)
void blender::IMB_mask_filter_extend (char *mask, int width, int height)
void blender::IMB_mask_clear (ImBuf *ibuf, const char *mask, int val)
void blender::IMB_filter_extend (ImBuf *ibuf, char *mask, int filter)
void blender::IMB_filtery (ImBuf *ibuf)
void blender::IMB_scale_box (const float *src_buffer, int2 src_size, int channels, float *dst_buffer, int2 dst_size, bool threaded, int src_stride=0)
void blender::IMB_scale_box (const uchar *src_buffer, int2 src_size, int channels, uchar *dst_buffer, int2 dst_size, bool threaded, int src_stride=0)
bool blender::IMB_scale (ImBuf *ibuf, int2 new_size, IMBScaleFilter filter, bool threaded=true)
bool blender::IMB_scale (ImBuf *ibuf, unsigned int newx, unsigned int newy, IMBScaleFilter filter, bool threaded=true)
ImBuf * blender::IMB_scale_into_new (const ImBuf *ibuf, int2 new_size, IMBScaleFilter filter, bool threaded=true)
ImBuf * blender::IMB_scale_into_new (const ImBuf *ibuf, unsigned int newx, unsigned int newy, IMBScaleFilter filter, bool threaded=true)
void blender::IMB_flipx (ImBuf *ibuf)
void blender::IMB_flipy (ImBuf *ibuf)
bool blender::IMB_rotate_orthogonal (ImBuf *ibuf, int degrees)
void blender::IMB_premultiply_alpha (ImBuf *ibuf)
void blender::IMB_unpremultiply_alpha (ImBuf *ibuf)
void blender::IMB_rectfill (ImBuf *drect, const float col[4])
void blender::IMB_rectfill_area (ImBuf *ibuf, const float scene_linear_color[4], int x1, int y1, int x2, int y2)
void blender::IMB_rectfill_alpha (ImBuf *ibuf, float value)
void * blender::imb_alloc_pixels (unsigned int x, unsigned int y, unsigned int channels, size_t typesize, bool initialize_pixels, const char *alloc_name)
bool blender::IMB_alloc_byte_pixels (ImBuf *ibuf, bool initialize_pixels=true)
void blender::IMB_free_byte_pixels (ImBuf *ibuf)
bool blender::IMB_alloc_float_pixels (ImBuf *ibuf, unsigned int channels, bool initialize_pixels=true)
void blender::IMB_free_float_pixels (ImBuf *ibuf)
void blender::IMB_free_all_data (ImBuf *ibuf)
void blender::IMB_free_gpu_textures (ImBuf *ibuf)
void blender::IMB_transform (const ImBuf *src, ImBuf *dst, eIMBTransformMode mode, eIMBInterpolationFilterMode filter, const float3x3 &transform_matrix, const rctf *src_crop)
 Transform source image buffer onto destination image buffer using a transform matrix.
gpu::Texture * blender::IMB_create_gpu_texture (const char *name, ImBuf *ibuf, GPUTextureCreateFlags flags)
gpu::Texture * blender::IMB_acquire_gpu_texture (const char *name, ImBuf *ibuf, GPUTextureCreateFlags texture_create_flags, bool try_only=false)
gpu::TextureFormat blender::IMB_gpu_get_texture_format (const ImBuf *ibuf, bool high_bitdepth, bool use_grayscale)
bool blender::IMB_gpu_get_compressed_format (const ImBuf *ibuf, gpu::TextureFormat *r_texture_format)
void blender::IMB_gpu_clamp_half_float (ImBuf *image_buffer)
gpu::Texture * blender::IMB_touch_gpu_texture (const char *name, ImBuf *ibuf, int w, int h, int layers, bool use_high_bitdepth, bool use_grayscale)
void blender::IMB_update_gpu_texture_sub (gpu::Texture *tex, ImBuf *ibuf, int x, int y, int z, int w, int h, bool use_grayscale, bool use_premult)
void blender::IMB_gpu_texture_apply_partial_update (gpu::Texture *tex, ImBuf *ibuf, bool store_premultiplied, const imbuf::partial_update::Changes &changes, int layer=-1, int2 tile_offset=int2(0), int2 tile_size=int2(0))
Crop
void blender::IMB_copy_rect (float *dst, const int2 &dst_size, const float *src, const int2 &src_size, int channels, const int2 &src_rect_pos, const int2 &dst_rect_pos, const int2 &rect_size)
void blender::IMB_copy_rect (uchar *dst, const int2 &dst_size, const uchar *src, const int2 &src_size, const int2 &src_rect_pos, const int2 &dst_rect_pos, const int2 &rect_size)
void blender::IMB_crop (ImBuf *ibuf, const int2 &rect_pos, const int2 &rect_size)
void blender::IMB_copy_rect (ImBuf *dst, const ImBuf *src, const int2 &src_rect_pos, const int2 &dst_rect_pos, const int2 &rect_size)
void blender::IMB_rect_size_set (ImBuf *ibuf, const uint size[2])
Generic Buffer Conversion
bool blender::IMB_alpha_affects_rgb (const ImBuf *ibuf)
void blender::IMB_buffer_byte_from_float (unsigned char *dest, const float *src, int src_channels, float dither, bool predivide, int width, int height, int stride, int start_y=0)
void blender::IMB_buffer_byte_from_float_mask (unsigned char *dest, const float *src, int src_channels, float dither, int width, int height, const char *mask)
void blender::IMB_buffer_float_from_byte (float *dest, const unsigned char *src, int width, int height, int dest_stride, int src_stride)
void blender::IMB_buffer_float_rgba_from_float (float *dest, const float *src, int src_channels, int width, int height)
void blender::IMB_buffer_float_rgba_from_float_mask (float *dest, const float *src, int src_channels, int width, int height, const char *mask)
void blender::IMB_buffer_float_rgba_srgb_to_linear (float *buffer, int width, int height)
ImBuf Conversion
void blender::IMB_byte_from_float (ImBuf *ibuf)
void blender::IMB_float_from_byte_ex (ImBuf *dst, const ImBuf *src, const rcti *region_to_update)
void blender::IMB_float_from_byte (ImBuf *ibuf)
Color to Gray-Scale
void blender::IMB_color_to_bw (ImBuf *ibuf)
Alter Saturation
void blender::IMB_saturation (ImBuf *ibuf, float sat)
Alpha-under
void blender::IMB_alpha_under_color_float (float *rect_float, int x, int y, float backcol[3])
void blender::IMB_alpha_under_color_byte (unsigned char *rect, int x, int y, const float backcol[3])
Dimension Utils
void blender::IMB_stereo3d_write_dimensions (char mode, bool is_squeezed, size_t width, size_t height, size_t *r_width, size_t *r_height)
void blender::IMB_stereo3d_read_dimensions (char mode, bool is_squeezed, size_t width, size_t height, size_t *r_width, size_t *r_height)
Preparing To Call The Write Functions
ImBuf * blender::IMB_stereo3d_ImBuf (const ImageFormatData *im_format, ImBuf *ibuf_left, ImBuf *ibuf_right)
Preparing To Call The Read Functions
void blender::IMB_ImBufFromStereo3d (const Stereo3dFormat *s3d, ImBuf *ibuf_stereo3d, ImBuf **r_ibuf_left, ImBuf **r_ibuf_right)

Macro Definition Documentation

◆ FILTER_MASK_MARGIN

#define FILTER_MASK_MARGIN   1

◆ FILTER_MASK_NULL

#define FILTER_MASK_NULL   0

Definition at line 345 of file IMB_imbuf.hh.

Referenced by blender::bake_pixels_add_denoise_margin().

◆ FILTER_MASK_USED