shveu.h File Reference

The libshveu C API. More...

#include <shveu/veu_colorspace.h>

Go to the source code of this file.

Typedefs
typedef struct SHVEU	SHVEU
Functions
SHVEU *	shveu_open (void)
	Open a VEU device.
SHVEU *	shveu_open_named (const char *name)
	Open a VEU device with the specified name.
void	shveu_close (SHVEU *veu)
	Close a VEU device.
int	shveu_list_veu (char ***names, int *count)
	Query a list of VEU available on this platform.

---

Detailed Description

The libshveu C API.

---

Function Documentation

void shveu_close

(

SHVEU *

veu

)

Close a VEU device.

Parameters:

veu

VEU handle

int shveu_list_veu	(	char ***	names,
		int *	count
	)

Query a list of VEU available on this platform.

Returns the references to the names of available VEU. If you need to modify the returned array of strings, please copy the array and strings before you do so. The result is shared by all callers of this API in the same process context.

Parameters:

	names	List of VEU available. The array is terminated with NULL.
	count	Number of VEU.

Return values:

0

on success; -1 on failure.

SHVEU* shveu_open

(

void

)

Open a VEU device.

Return values:

0

Failure, otherwise VEU handle

SHVEU* shveu_open_named

(

const char *

name

)

Open a VEU device with the specified name.

If more than one VEU is available on the platform, each VEU has a name such as 'VEU0', 'VEU1', and so on. This API will allow to open a specific VEU by shveu_open_named("VEU0") for instance.

Return values:

0

Failure, otherwise VEU handle.