You are here: Start » Function Reference » Surface » Surface Features » SurfaceNormalsImage

Computes a normals image for a surface

Syntax

void fil::SurfaceNormalsImage
(
	const fil::Surface& inSurface,
	ftl::Optional<const fil::Region&> inRoi,
	const float inScale,
	fil::Image& outNormalsImage,
	ftl::Optional<fil::Region&> outComputedRegion = ftl::NIL
)

Parameters

	Name	Type	Range	Default	Description
	inSurface	const Surface&
	inRoi	Optional<const Region&>		NIL	Range of pixels to be processed
	inScale	const float	0.0 -	1.0f
	outNormalsImage	Image&
	outComputedRegion	Optional<Region&>		NIL

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outComputedRegion.

Read more about Optional Outputs.

Errors