Back to FabImage Library website

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

ClearImage

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

Sets image pixels in ROI to the specified value.

Syntax

void fil::ClearImage
(
	fil::Image& ioImage,
	ftl::Optional<const fil::Region&> inRegion,
	const fil::Pixel& inValue
)

Parameters

	Name	Type	Default	Description
	ioImage	Image&
	inRegion	Optional<const Region&>	NIL	Input region
	inValue	const Pixel&		The new background color

See Also

DrawRegion – Draws a region on an image.

DrawRegions_SingleColor – Draws regions on an image with a single color.

FillImage – Fills the input image with one color.