ImagePreview(bpy_struct)

base class — bpy_struct

class bpy.types.ImagePreview(bpy_struct)

Preview image and icon

icon_id

Unique integer identifying this preview as an icon (zero means invalid) (in [-inf, inf], default 0, readonly)

Type:

int

icon_pixels

Icon pixels, as bytes (always 32-bit RGBA) (in [-inf, inf], default 0)

Type:

int

icon_pixels_float

Icon pixels components, as floats (RGBA concatenated values) (in [-inf, inf], default 0.0)

Type:

float

icon_size

Width and height in pixels (array of 2 items, in [-inf, inf], default (0, 0))

Type:

bpy_prop_array[int]

image_pixels

Image pixels, as bytes (always 32-bit RGBA) (in [-inf, inf], default 0)

Type:

int

image_pixels_float

Image pixels components, as floats (RGBA concatenated values) (in [-inf, inf], default 0.0)

Type:

float

image_size

Width and height in pixels (array of 2 items, in [-inf, inf], default (0, 0))

Type:

bpy_prop_array[int]

is_icon_custom

True if this preview icon has been modified by py script, and is no more auto-generated by Blender (default False)

Type:

bool

is_image_custom

True if this preview image has been modified by py script, and is no more auto-generated by Blender (default False)

Type:

bool

reload()

Reload the preview from its source path

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References