Image Buffer Types (imbuf.types)

This module provides access to image buffer types.

Note

Image buffer is also the structure used by bpy.types.Image ID type to store and manipulate image data at runtime.

class imbuf.types.ImBuf
copy()

Return a copy of the image.

Returns:

A copy of the image.

Return type:

ImBuf

crop(min, max)

Crop the image in-place.

Parameters:

  • min (tuple[int, int]) – Minimum pixel coordinates (X, Y), inclusive.

  • max (tuple[int, int]) – Maximum pixel coordinates (X, Y), inclusive.

free()

Clear image data immediately (causing an error on re-use).

resize(size, *, method='FAST')

Resize the image in-place.

Parameters:

  • size (tuple[int, int]) – New size.

  • method (str) – Method of resizing (‘FAST’, ‘BILINEAR’).

channels

Number of color channels.

Type:

int

filepath

Filepath associated with this image.

Type:

str

planes

Number of bits per pixel.

Type:

int

ppm

Pixels per meter.

Type:

tuple[float, float]

size

Size of the image in pixels.

Type:

tuple[int, int]