You are here: Start » Function Reference » Image Basics » GetImageRow

GetImageRow

Extracts an array of pixel values from a single row of an image.

Header:	AVL.h

Syntax

void avl::GetImageRow
(
	const avl::Image& inImage,
	atl::Optional<int> inChannelIndex,
	const int inRowIndex,
	atl::Array<float>& outValues,
	atl::Array<avl::Pixel>& outPixels
)

void GetImageRow
(
	Image inImage,
	int? inChannelIndex,
	int inRowIndex,
	out float[] outValues,
	out Pixel[] outPixels
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inChannelIndex	Optional<int>	0 - 3	NIL	Selects a channel of the input image
inRowIndex	const int	0 - 65535		Selects a row of the input image
outValues	Array<float>&			Output pixel values of the row
outPixels	Array<Pixel>&			Output pixels of the row

Errors

Error type	Description
DomainError	Channel index out of range in GetImageRow.
DomainError	Row index out of range in GetImageRow.