displays_admin_c.h File Reference

#include "sr/core_c.h"

Include dependency graph for displays_admin_c.h:

Go to the source code of this file.

Macros
#define	SRAPI

Typedefs
typedef void *	SR_screen
typedef void *	SR_switchableLensHintAdmin

Functions
SRAPI SR_switchableLensHintAdmin	createSwitchableLensHintAdmin (SRContext context)
	Creates a functional SwitchableLensHintAdmin instance. More...
SRAPI void	lensEnableHintAdmin (SR_switchableLensHintAdmin lensAdmin)
SRAPI void	lensDisableHintAdmin (SR_switchableLensHintAdmin lensAdmin)
SRAPI void	enableDefaultSwitching (SR_switchableLensHintAdmin lensAdmin)
SRAPI void	disableByForce (SR_switchableLensHintAdmin lensAdmin)
SRAPI void	deleteSwitchableLensHintAdmin (SR_switchableLensHintAdmin lensAdmin)
	Cleans up underlying object instances used to facilitate indicating lens switch admin features. More...
SRAPI char *	getVersion (SR_switchableLensHintAdmin lensAdmin)
	Get the Version info of the switchable lens. More...
SRAPI char *	getSerialNumber (SR_switchableLensHintAdmin lensAdmin)
	Get the Serial Number of the switchable lens. More...
SRAPI char *	getAdditionalSerialNumber (SR_switchableLensHintAdmin lensAdmin, unsigned char index)
	Get the Additional Serial Numbers of the switchable lens. More...

Macro Definition Documentation

SRAPI

#define SRAPI

Typedef Documentation

SR_screen

typedef void* SR_screen

Copyright (C) 2022 Dimenco

This software has been provided under the Dimenco EULA. (End User License Agreement) You can find the agreement at https://www.dimenco.eu/eula

This source code is considered Protected Code under the definitions of the EULA.

SR_switchableLensHintAdmin

typedef void* SR_switchableLensHintAdmin

Function Documentation

createSwitchableLensHintAdmin()

SRAPI SR_switchableLensHintAdmin createSwitchableLensHintAdmin

(

SRContext

context

)

Creates a functional SwitchableLensHintAdmin instance.

Parameters

context

is the environment in which created senses are kept track of

Returns

pointer to instance of underlying SR::SwitchableLensHintAdmin

deleteSwitchableLensHintAdmin()

SRAPI void deleteSwitchableLensHintAdmin

(

SR_switchableLensHintAdmin

lensAdmin

)

Cleans up underlying object instances used to facilitate indicating lens switch admin features.

Parameters

lensAdmin

( void* ) provided by the createSwitchableLensHintAdmin function.

disableByForce()

SRAPI void disableByForce

(

SR_switchableLensHintAdmin

lensAdmin

)

Disable the lens to minimize the effect on the light transmitted through it

enableDefaultSwitching()

SRAPI void enableDefaultSwitching

(

SR_switchableLensHintAdmin

lensAdmin

)

Allows switching the lens such that it affects the light transmitted through it

getAdditionalSerialNumber()

SRAPI char * getAdditionalSerialNumber	(	SR_switchableLensHintAdmin	lensAdmin,
		unsigned char	index
	)

Get the Additional Serial Numbers of the switchable lens.

Parameters

lensAdmin	( void* ) provided by the createSwitchableLensHintAdmin function.
index	refers to the number of serial number which can be between 1-4, otherwise it returns ""

getSerialNumber()

SRAPI char * getSerialNumber

(

SR_switchableLensHintAdmin

lensAdmin

)

Get the Serial Number of the switchable lens.

Parameters

lensAdmin

( void* ) provided by the createSwitchableLensHintAdmin function.

getVersion()

SRAPI char * getVersion

(

SR_switchableLensHintAdmin

lensAdmin

)

Get the Version info of the switchable lens.

Parameters

lensAdmin

( void* ) provided by the createSwitchableLensHintAdmin function.

lensDisableHintAdmin()

SRAPI void lensDisableHintAdmin

(

SR_switchableLensHintAdmin

lensAdmin

)

Expresses preference to disable the lens to minimize the effect on the light transmitted through it

lensEnableHintAdmin()

SRAPI void lensEnableHintAdmin

(

SR_switchableLensHintAdmin

lensAdmin

)

Expresses preference to enable the lens such that it affects the light transmitted through it