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

GetImageRow

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

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

Syntax

void fil::GetImageRow
(
	const fil::Image& inImage,
	ftl::Optional<int> inChannelIndex,
	const int inRowIndex,
	ftl::Array<float>& outValues,
	ftl::Array<fil::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

List of possible exceptions:

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