Classes
struct	face_sdk__face
	The face object. Face object contains information about face bounding box on the image and the original image. More...

Typedefs
typedef struct face_sdk__face	face_sdk__face_t
	The face object. Face object contains information about face bounding box on the image and the original image. More...

Functions
bool	face_sdk__face__get_addr (const face_sdk__face_t face, uint64_t addr)
	Retrieves face_sdk__face_t object address * *. More...

bool	face_sdk__face__get_confidence (const face_sdk__face_t face, float value)
	Retrieves face confidence. Range is from 0.0f to 1.0f where 1.0f is definitely a face. More...

bool	face_sdk__face__get_x (const face_sdk__face_t face, int32_t value)
	Retrieves x coordinate of face bounding box in pixels. More...

bool	face_sdk__face__get_y (const face_sdk__face_t face, int32_t value)
	Retrieves y coordinate of face bounding box in pixels. More...

bool	face_sdk__face__get_width (const face_sdk__face_t face, int32_t value)
	Retrieves width of face bounding box in pixels. More...

bool	face_sdk__face__get_height (const face_sdk__face_t face, int32_t value)
	Retrieves height of face bounding box in pixels. More...

bool	face_sdk__face__get_img (const face_sdk__face_t face, face_sdk__image_t *image)
	Retrieves original image. More...

bool	face_sdk__face__get_cropped_image (const face_sdk__face_t face, face_sdk__image_t *image)
	The cropped image (Not all detector versions support this method. If supported function will return false) More...

bool	face_sdk__face__has_landmarks (const face_sdk__face_t face, bool value)
	Retrieves face landmarks availability. More...

bool	face_sdk__face__get_landmarks (const face_sdk__face_t face, face_sdk__landmark_set_t *landmarks)
	Retrieves set of 10 predicted landmarks. More...

bool	face_sdk__face__is_out_of_bounds_set (const face_sdk__face_t face, bool value)
	Retrieves out of bounds feature availability. More...

bool	face_sdk__face__out_of_bounds (const face_sdk__face_t face, bool value)
	Retrieves out of bounds state. More...

bool	face_sdk__face__get_version (const face_sdk__face_t face, uint32_t value)
	Retrieves face object version. More...

bool	face_sdk__make_face (const face_sdk__image_t img, face_sdk__face_t *face)
	Makes the face object. Bounding box size is set equal to the original image size. More...

bool	face_sdk__make_face_1 (const face_sdk__image_t img, uint32_t version, face_sdk__face_t *face)
	Makes the face object with specified version. Bounding box size is set equal to the original image size. More...

bool	face_sdk__make_face_2 (const face_sdk__image_t img, bool out_of_bounds, uint32_t version, face_sdk__face_t *face)
	Makes the face object with specified out of bound flag and version. Bounding box size is set equal to the original image size. More...

bool	face_sdk__make_face_3 (const face_sdk__image_t img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, face_sdk__face_t *face)
	Makes the face object with specified coordinates of bounding box and confidence. More...

bool	face_sdk__make_face_4 (const face_sdk__image_t img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, uint32_t version, face_sdk__face_t *face)
	Makes the face object with specified coordinates of bounding box, confidence and version. More...

bool	face_sdk__make_face_5 (const face_sdk__image_t img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, bool out_of_bounds, uint32_t version, face_sdk__face_t *face)
	Makes the face object with specified coordinates of bounding box, confidence, out_of_bounds flag and version. More...

bool	face_sdk__make_face_6 (const face_sdk__image_t img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t landmark_set, face_sdk__face_t **face)
	Makes the face object with specified coordinates of bounding box, confidence and landmarks. More...

bool	face_sdk__make_face_7 (const face_sdk__image_t img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t landmark_set, uint32_t version, face_sdk__face_t **face)
	Makes the face object with specified coordinates of bounding box, confidence, landmarks and version. More...

bool	face_sdk__make_face_8 (const face_sdk__image_t img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t landmark_set, bool out_of_bounds, uint32_t version, face_sdk__face_t **face)
	Makes the face object with specified coordinates of bounding box, confidence, landmarks, out_of_bounds flag and version. More...

bool	face_sdk__make_face_9 (const face_sdk__image_t img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t landmark_set, const face_sdk__image_t cropped_image, face_sdk__face_t *face)
	Makes the face object with specified coordinates of bounding box, confidence, landmarks and cropped image. More...

bool	face_sdk__make_face_10 (const face_sdk__image_t img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t landmark_set, const face_sdk__image_t cropped_image, uint32_t version, face_sdk__face_t *face)
	Makes the face object with specified coordinates of bounding box, confidence, landmarks, cropped_image version. More...

bool	face_sdk__make_face_11 (const face_sdk__image_t img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t landmark_set, const face_sdk__image_t cropped_image, bool out_of_bounds, uint32_t version, face_sdk__face_t *face)
	Makes the face object with specified coordinates of bounding box, landmarks, cropped_image, out_of_bounds flag and version. More...

void	face_sdk__face_free (face_sdk__face_t *face)
	Destroys face_sdk__face object. More...

Variables
const float	FACE_SDK__UNKNOWN_CONFIDENCE = .0f

const uint32_t	FACE_SDK__UNKNOWN_VERSION = 0

Detailed Description

Typedef Documentation

◆ face_sdk__face_t

typedef struct face_sdk__face face_sdk__face_t

The face object. Face object contains information about face bounding box on the image and the original image.

Use face_sdk__make_face() function to instantiate face object face_sdk__serializer__serialize and face_sdk__serializer__deserialize functions allows to serialize and deserialize face_sdk__face object.

Function Documentation

◆ face_sdkfaceget_addr()

bool face_sdk__face__get_addr	(	const face_sdk__face_t *	face,
		uint64_t *	addr
	)

Retrieves face_sdk__face_t object address * *.

Parameters

[in]	face	face_sdk__face_t object *
[out]	addr	Object address * *

Returns: true on success, false on failure. See last_error

◆ face_sdkfaceget_confidence()

bool face_sdk__face__get_confidence	(	const face_sdk__face_t *	face,
		float *	value
	)

Retrieves face confidence. Range is from 0.0f to 1.0f where 1.0f is definitely a face.

Parameters

[in]	face	Face object
[out]	value	Confidence

Returns: true on success, false on failure. See last_error

◆ face_sdkfaceget_cropped_image()

bool face_sdk__face__get_cropped_image	(	const face_sdk__face_t *	face,
		face_sdk__image_t **	image
	)

The cropped image (Not all detector versions support this method. If supported function will return false)

Parameters

[in]	face	Face object
[out]	image	Cropped Image object

Returns: true on success, false on failure or if not supported. See last_error

◆ face_sdkfaceget_height()

bool face_sdk__face__get_height	(	const face_sdk__face_t *	face,
		int32_t *	value
	)

Retrieves height of face bounding box in pixels.

Parameters

[in]	face	Face object
[out]	value	Bounding box width

Returns: true on success, false on failure. See last_error

◆ face_sdkfaceget_img()

bool face_sdk__face__get_img	(	const face_sdk__face_t *	face,
		face_sdk__image_t **	image
	)

Retrieves original image.

Parameters

[in]	face	Face object
[out]	image	Image object

Returns: true on success, false on failure. See last_error

◆ face_sdkfaceget_landmarks()

bool face_sdk__face__get_landmarks	(	const face_sdk__face_t *	face,
		face_sdk__landmark_set_t **	landmarks
	)

Retrieves set of 10 predicted landmarks.

Parameters

[in]	face	Face object
[out]	value	Set of landmarks

Returns: true on success, false on failure. See last_error

◆ face_sdkfaceget_version()

bool face_sdk__face__get_version	(	const face_sdk__face_t *	face,
		uint32_t *	value
	)

Retrieves face object version.

Parameters

[in]	face	Face object
[out]	value	Face object version

Returns: true on success, false on failure. See last_error

◆ face_sdkfaceget_width()

bool face_sdk__face__get_width	(	const face_sdk__face_t *	face,
		int32_t *	value
	)

Retrieves width of face bounding box in pixels.

Parameters

[in]	face	Face object
[out]	value	Bounding box width

Returns: true on success, false on failure. See last_error

◆ face_sdkfaceget_x()

bool face_sdk__face__get_x	(	const face_sdk__face_t *	face,
		int32_t *	value
	)

Retrieves x coordinate of face bounding box in pixels.

Parameters

[in]	face	Face object
[out]	value	Bounding box x coordinate

Returns: true on success, false on failure. See last_error

◆ face_sdkfaceget_y()

bool face_sdk__face__get_y	(	const face_sdk__face_t *	face,
		int32_t *	value
	)

Retrieves y coordinate of face bounding box in pixels.

Parameters

[in]	face	Face object
[out]	value	Bounding box y coordinate

Returns: true on success, false on failure. See last_error

◆ face_sdkfacehas_landmarks()

bool face_sdk__face__has_landmarks	(	const face_sdk__face_t *	face,
		bool *	value
	)

Retrieves face landmarks availability.

Parameters

[in]	face	Face object
[out]	value	True if face face predicted landmarks, false if it has not

Returns: true on success, false on failure. See last_error

◆ face_sdkfaceis_out_of_bounds_set()

bool face_sdk__face__is_out_of_bounds_set	(	const face_sdk__face_t *	face,
		bool *	value
	)

Retrieves out of bounds feature availability.

Parameters

[in]	face	Face object
[out]	value	True if out of bounds feature is supported, false if feature is not supported

Returns: true on success, false on failure. See last_error

◆ face_sdkfaceout_of_bounds()

bool face_sdk__face__out_of_bounds	(	const face_sdk__face_t *	face,
		bool *	value
	)

Retrieves out of bounds state.

Parameters

[in]	face	Face object
[out]	value	True if face is out of image bound, false if face is within image bound

Returns: true on success, false on failure. See last_error

◆ face_sdk__face_free()

void face_sdk__face_free ( face_sdk__face_t * face )

Destroys face_sdk__face object.

Parameters

[in] face Face object

◆ face_sdk__make_face()

bool face_sdk__make_face	(	const face_sdk__image_t *	img,
		face_sdk__face_t **	face
	)

Makes the face object. Bounding box size is set equal to the original image size.

Parameters

[out] face Face object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_face_1()

bool face_sdk__make_face_1	(	const face_sdk__image_t *	img,
		uint32_t	version,
		face_sdk__face_t **	face
	)

Makes the face object with specified version. Bounding box size is set equal to the original image size.

Parameters

[in]	img	Image with face
[in]	version	Face object version
[out]	face	Face object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_face_10()

bool face_sdk__make_face_10	(	const face_sdk__image_t *	img,
		int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height,
		float	confidence,
		const face_sdk__landmark_set_t *	landmark_set,
		const face_sdk__image_t *	cropped_image,
		uint32_t	version,
		face_sdk__face_t **	face
	)

Makes the face object with specified coordinates of bounding box, confidence, landmarks, cropped_image version.

Parameters

[in]	img	Image with face
[in]	x	X coordinate of face bounding box in pixels
[in]	y	Y coordinate of face bounding box in pixels
[in]	width	Width of face bounding box in pixels
[in]	height	Height of face bounding box in pixels
[in]	confidence	always set to 1.0f
[in]	landmark_set	Face landmarks
[in]	cropped_image	Cropped face
[in]	version	Face object version
[out]	face	Face object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_face_11()

bool face_sdk__make_face_11	(	const face_sdk__image_t *	img,
		int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height,
		float	confidence,
		const face_sdk__landmark_set_t *	landmark_set,
		const face_sdk__image_t *	cropped_image,
		bool	out_of_bounds,
		uint32_t	version,
		face_sdk__face_t **	face
	)

Makes the face object with specified coordinates of bounding box, landmarks, cropped_image, out_of_bounds flag and version.

Parameters

[in]	img	Image with face
[in]	x	X coordinate of face bounding box in pixels
[in]	y	Y coordinate of face bounding box in pixels
[in]	width	Width of face bounding box in pixels
[in]	height	Height of face bounding box in pixels
[in]	landmark_set	Face landmarks
[in]	cropped_image	Cropped face
[in]	out_of_bounds	Face out of bounds flag
[in]	version	Face object version
[out]	face	Face object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_face_2()

bool face_sdk__make_face_2	(	const face_sdk__image_t *	img,
		bool	out_of_bounds,
		uint32_t	version,
		face_sdk__face_t **	face
	)

Makes the face object with specified out of bound flag and version. Bounding box size is set equal to the original image size.

Parameters

[in]	img	Image with face
[in]	out_of_bounds	Face out of bounds flag
[in]	version	Face object version
[out]	face	Face object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_face_3()

bool face_sdk__make_face_3	(	const face_sdk__image_t *	img,
		int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height,
		float	confidence,
		face_sdk__face_t **	face
	)

Makes the face object with specified coordinates of bounding box and confidence.

Parameters

[in]	img	Image with face
[in]	x	X coordinate of face bounding box in pixels
[in]	y	Y coordinate of face bounding box in pixels
[in]	width	Width of face bounding box in pixels
[in]	height	Height of face bounding box in pixels
[in]	confidence	always set to 1.0f
[out]	face	Face object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_face_4()

bool face_sdk__make_face_4	(	const face_sdk__image_t *	img,
		int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height,
		float	confidence,
		uint32_t	version,
		face_sdk__face_t **	face
	)

Makes the face object with specified coordinates of bounding box, confidence and version.

Parameters

[in]	img	Image with face
[in]	x	X coordinate of face bounding box in pixels
[in]	y	Y coordinate of face bounding box in pixels
[in]	width	Width of face bounding box in pixels
[in]	height	Height of face bounding box in pixels
[in]	confidence	always set to 1.0f
[in]	version	Face object version
[out]	face	Face object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_face_5()

bool face_sdk__make_face_5	(	const face_sdk__image_t *	img,
		int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height,
		float	confidence,
		bool	out_of_bounds,
		uint32_t	version,
		face_sdk__face_t **	face
	)

Makes the face object with specified coordinates of bounding box, confidence, out_of_bounds flag and version.

Parameters

[in]	img	Image with face
[in]	x	X coordinate of face bounding box in pixels
[in]	y	Y coordinate of face bounding box in pixels
[in]	width	Width of face bounding box in pixels
[in]	height	Height of face bounding box in pixels
[in]	confidence	always set to 1.0f
[in]	out_of_bounds	Face out of bounds flag
[in]	version	Face object version
[out]	face	Face object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_face_6()

bool face_sdk__make_face_6	(	const face_sdk__image_t *	img,
		int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height,
		float	confidence,
		const face_sdk__landmark_set_t *	landmark_set,
		face_sdk__face_t **	face
	)

Makes the face object with specified coordinates of bounding box, confidence and landmarks.

Parameters

[in]	img	Image with face
[in]	x	X coordinate of face bounding box in pixels
[in]	y	Y coordinate of face bounding box in pixels
[in]	width	Width of face bounding box in pixels
[in]	height	Height of face bounding box in pixels
[in]	confidence	always set to 1.0f
[in]	landmark_set	Face landmarks
[out]	face	Face object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_face_7()

bool face_sdk__make_face_7	(	const face_sdk__image_t *	img,
		int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height,
		float	confidence,
		const face_sdk__landmark_set_t *	landmark_set,
		uint32_t	version,
		face_sdk__face_t **	face
	)

Makes the face object with specified coordinates of bounding box, confidence, landmarks and version.

Parameters

[in]	img	Image with face
[in]	x	X coordinate of face bounding box in pixels
[in]	y	Y coordinate of face bounding box in pixels
[in]	width	Width of face bounding box in pixels
[in]	height	Height of face bounding box in pixels
[in]	confidence	always set to 1.0f
[in]	landmark_set	Face landmarks
[in]	version	Face object version
[out]	face	Face object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_face_8()

bool face_sdk__make_face_8	(	const face_sdk__image_t *	img,
		int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height,
		float	confidence,
		const face_sdk__landmark_set_t *	landmark_set,
		bool	out_of_bounds,
		uint32_t	version,
		face_sdk__face_t **	face
	)

Makes the face object with specified coordinates of bounding box, confidence, landmarks, out_of_bounds flag and version.

Parameters

[in]	img	Image with face
[in]	x	X coordinate of face bounding box in pixels
[in]	y	Y coordinate of face bounding box in pixels
[in]	width	Width of face bounding box in pixels
[in]	height	Height of face bounding box in pixels
[in]	confidence	always set to 1.0f
[in]	landmark_set	Face landmarks
[in]	out_of_bounds	Face out of bounds flag
[in]	version	Face object version
[out]	face	Face object

Returns: true on success, false on failure. See last_error

◆ face_sdk__make_face_9()

bool face_sdk__make_face_9	(	const face_sdk__image_t *	img,
		int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height,
		float	confidence,
		const face_sdk__landmark_set_t *	landmark_set,
		const face_sdk__image_t *	cropped_image,
		face_sdk__face_t **	face
	)

Makes the face object with specified coordinates of bounding box, confidence, landmarks and cropped image.

Parameters

[in]	img	Image with face
[in]	x	X coordinate of face bounding box in pixels
[in]	y	Y coordinate of face bounding box in pixels
[in]	width	Width of face bounding box in pixels
[in]	height	Height of face bounding box in pixels
[in]	confidence	always set to 1.0f
[in]	landmark_set	Face landmarks
[in]	cropped_image	Cropped face
[out]	face	Face object

Returns: true on success, false on failure. See last_error

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ face_sdk__face_t

Function Documentation

◆ face_sdk__face__get_addr()

◆ face_sdk__face__get_confidence()

◆ face_sdk__face__get_cropped_image()

◆ face_sdk__face__get_height()

◆ face_sdk__face__get_img()

◆ face_sdk__face__get_landmarks()

◆ face_sdk__face__get_version()

◆ face_sdk__face__get_width()

◆ face_sdk__face__get_x()

◆ face_sdk__face__get_y()

◆ face_sdk__face__has_landmarks()

◆ face_sdk__face__is_out_of_bounds_set()

◆ face_sdk__face__out_of_bounds()

◆ face_sdk__face_free()

◆ face_sdk__make_face()

◆ face_sdk__make_face_1()

◆ face_sdk__make_face_10()

◆ face_sdk__make_face_11()

◆ face_sdk__make_face_2()

◆ face_sdk__make_face_3()

◆ face_sdk__make_face_4()

◆ face_sdk__make_face_5()

◆ face_sdk__make_face_6()

◆ face_sdk__make_face_7()

◆ face_sdk__make_face_8()

◆ face_sdk__make_face_9()

◆ face_sdkfaceget_addr()

◆ face_sdkfaceget_confidence()

◆ face_sdkfaceget_cropped_image()

◆ face_sdkfaceget_height()

◆ face_sdkfaceget_img()

◆ face_sdkfaceget_landmarks()

◆ face_sdkfaceget_version()

◆ face_sdkfaceget_width()

◆ face_sdkfaceget_x()

◆ face_sdkfaceget_y()

◆ face_sdkfacehas_landmarks()

◆ face_sdkfaceis_out_of_bounds_set()

◆ face_sdkfaceout_of_bounds()