Back to Aurora Vision Library Lite website

You are here: Start » Image » Image Basics » GetImageData

GetImageData


Header: AVL.h
Namespace: avl

Extracts the image content (raw pixel data) as a binary buffer.

Syntax

void avl::GetImageData
(
	const avl::Image& inImage,
	atl::Optional<int> inPitch,
	avl::ByteBuffer& outBuffer
)

Parameters

Name Type Range Default Description
Input value
 inImage const Image& Input image
Input value
 inPitch Optional<int> 0 - NIL Length, in bytes, between starts of consecutive image rows for the resulting data
Output value
 outBuffer ByteBuffer&

Errors

List of possible exceptions:

Error type Description
DomainError Pitch value is too small for the source image width and pixel format.
RuntimeError Invalid image format in GetImageData.
RuntimeError Resulting byte buffer size is too large.