Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Surface Basics » AvsFilter_AccessSurface

AvsFilter_AccessSurface


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: AVL.h
Namespace: avs
Module: Vision3DStandard

Returns individual fields of a surface.

Syntax

void avs::AvsFilter_AccessSurface
(
	const avl::Surface& inSurface,
	int& outWidth,
	int& outHeight,
	avl::PlainType::Type& outPointType,
	int& outPointByteSize,
	int& outPitch,
	double& outXOffset,
	double& outXScale,
	double& outYOffset,
	double& outYScale,
	double& outZOffset,
	double& outZScale
)

Parameters

Name Type Default Description
Input value inSurface const Surface& Input surface
Output value outWidth int& Surface width
Output value outHeight int& Surface height
Output value outPointType PlainType::Type& Point Z coordinate type
Output value outPointByteSize int& Point Z coordinate size in bytes
Output value outPitch int& Length of surface point line with padding
Output value outXOffset double& Offset in X axis
Output value outXScale double& Scale in X axis
Output value outYOffset double& Offset in Y axis
Output value outYScale double& Scale in Y axis
Output value outZOffset double& Offset in Z axis
Output value outZScale double& Scale in Z axis