Welcome to Python-flavored Magnum! Please note that, while already being rather stable, this functionality is still considered experimental and some APIs might get changed without preserving full backwards compatibility.

magnum.ImageView2D class

Two-dimensional image view

Contents

Memory ownership and reference counting

Similarly to corrade.containers.ArrayView (and unlike in C++), the view keeps a reference to the original memory owner object in the owner field, meaning that calling del on the original object will not invalidate the view. Slicing a view creates a new view referencing the same original object, without any dependency on the previous view. That means a long chained slicing operation will not cause increased memory usage.

The owner is None if the view is empty.

Special methods

def __init__(self, arg0: PixelStorage, arg1: PixelFormat, arg2: Vector2i, /) -> None
Construct an empty view
def __init__(self, arg0: PixelFormat, arg1: Vector2i, /) -> None
Construct an empty view
def __init__(self, arg0: PixelStorage, arg1: PixelFormat, arg2: Vector2i, arg3: corrade.containers.ArrayView, /) -> None
Constructor
def __init__(self, arg0: PixelFormat, arg1: Vector2i, arg2: corrade.containers.ArrayView, /) -> None
Constructor
def __init__(self, arg0: Image2D, /) -> None
Construct a view on an image
def __init__(self, arg0: ImageView2D, /) -> None
Construct from any type convertible to an image view
def __init__(self, arg0: MutableImageView2D, /) -> None
Construct from a mutable view

Properties

data: corrade.containers.ArrayView get set
Image data
format: PixelFormat get
Format of pixel data
owner: object get
Memory owner
pixel_size: int get
Pixel size (in bytes)
pixels: corrade.containers.StridedArrayView3D get
View on pixel data
size: Vector2i get
Image size
storage: PixelStorage get
Storage of pixel data

Method documentation

def magnum.ImageView2D.__init__(self, arg0: ImageView2D, /) -> None

Construct from any type convertible to an image view

Exceptions
RuntimeError If trade.ImageData2D.is_compressed is True

This function is used to implement implicit conversion from trade.ImageData2D in the trade module.