LoadImageFromBuffer


Loads a single image from a file stored in memory.

Applications:Use this filter when you received an image file through I/O communication, e.g. through a TcpIp connection.

Syntax

C++
Python
 
def LoadImageFromBuffer(
	inBuffer: ByteBuffer,
	outImage: Image,
	/,
	*,
	inOffset: int = 0,
	inLength: int | None = None,
	inLoadAlphaChannel: bool = False
)
-> None

Parameters

Name Type Default Description
Input value inBuffer ByteBuffer Source buffer containing image file data
Input value inOffset int 0 Image data start position in source buffer
Input value inLength int | None None Image data length in source buffer
Input value inLoadAlphaChannel bool False Whether to load the alpha channel (if exists) as an additional image channel
Output value outImage Image Output image