#ifndef OrchidH
#define OrchidH

#include <windows.h>

/* --- DEFINES --- */


#define HLVXTASK DWORD

/* the same constants are defined in OrchiConst.h */
#ifndef OrchidConstH

#define lvx_Task_Live                       0
#define lvx_Task_Rt                         6
#define lvx_Task_RtBasic                    1  /* ---obsolete--- */
#define lvx_Task_RtFlash                    2  /* ---obsolete--- */
#define lvx_Task_RtAsyncReset               3
#define lvx_Task_RtFrameInt                 4  /* ---obsolete--- */
#define lvx_Task_RtFrameIntAsyncReset       5  /* ---obsolete--- */

#define lvx_Task_Preprocessor              10
#define lvx_Task_DirectX                   11

#define lvx_Checkpoint_EndOfFrame           0
#define lvx_Checkpoint_EndOfSubsequence     1  /* ---obsolete--- */
#define lvx_Checkpoint_EndOfSequence        2

#define lvx_Flow_ContinueOnRequest          0
#define lvx_Flow_PauseOnRequest             1

#define lvx_LiveMode_Auto                   0
#define lvx_LiveMode_HardwareForce          1
#define lvx_LiveMode_Software               2
#define lvx_LiveMode_HardwareAuto           3
// for backward compatibility
#define lvx_LiveMode_Hardware               1  /* ---obsolete--- */

#define lvx_ExtEv_Ignore                    0
#define lvx_ExtEv_Immediate                 1
#define lvx_ExtEv_SwControlled              2

#define lvx_FshMd_None                      0  /* ---obsolete--- */
#define lvx_FshMd_FirstField                1  /* ---obsolete--- */
#define lvx_FshMd_BothField                 2  /* ---obsolete--- */

#define lvx_FshMd_AR_CamTrigDelayed         0
#define lvx_FshMd_AR_CamTrig                1
#define lvx_FshMd_AR_FlashDelayed           2

#define lvx_FldStart_Any                    0  /* ---obsolete--- */
#define lvx_FldStart_Even                   1  /* ---obsolete--- */
#define lvx_FldStart_Odd                    2  /* ---obsolete--- */

#define lvx_FldAcq_2_Field                  0  /* ---obsolete--- */
#define lvx_FldAcq_1_Field                  1  /* ---obsolete--- */

#define lvx_FlowCheckDelay_0                0  /* ---obsolete--- */
#define lvx_FlowCheckDelay_180              1  /* ---obsolete--- */
#define lvx_FlowCheckDelay_320              2  /* ---obsolete--- */
#define lvx_FlowCheckDelay_420              3  /* ---obsolete--- */
#define lvx_FlowCheckDelay_610              4  /* ---obsolete--- */
#define lvx_FlowCheckDelay_3800             5  /* ---obsolete--- */
#define lvx_FlowCheckDelay_7500             6  /* ---obsolete--- */

#define lvx_AviFrame_RealTimeStamp     0x0001
#define lvx_TiffConvertMonoTo16bit     0x0001

#define lvx_GrabNotify_WinMsg               1
#define lvx_GrabNotify_WinObject            2
#define lvx_GrabNotify_Function             3
#define lvx_GrabNotify_Function_Param       4

#define lvx_TimeoutNotify_WinMsg           10  /* ---obsolete--- */
#define lvx_TimeoutNotify_WinObject        11  /* ---obsolete--- */
#define lvx_TimeoutNotify_Function         12  /* ---obsolete--- */
#define lvx_TimeoutNotify_Function_Param   13  /* ---obsolete--- */

#define lvx_Status_EepromOemNotInitialized 0x00010001 /* 65537 */
#define lvx_Status_EepromGrabberNotActive  0x00010002 /* 65538 */
#define lvx_Status_EepromHwError           0x00010003 /* 65539 */
#define lvx_Status_EepromUnknownError      0x00010004 /* 65540 */
#define lvx_Status_EepromDoesNotMatch      0x00010005 /* 65541 */

#define lvx_TextAttr_Bold      0x0001 /* for lvx_SetOverlayTextParams */
#define lvx_TextAttr_Italic    0x0002
#define lvx_TextAttr_Underline 0x0004
#define lvx_TextAttr_StrikeOut 0x0008
#define lvx_TextAttr_Shadow    0x0100 /* default shadow is right-bottom */
#define lvx_TextAttr_Outline   0xFF00

#define lvx_TextAttr_ShadowRB  0x0100 /* right-bottom */
#define lvx_TextAttr_ShadowRT  0x0200 /* right-top    */
#define lvx_TextAttr_ShadowLB  0x0400 /* left-bottom  */
#define lvx_TextAttr_ShadowLT  0x0800 /* left-top     */
#define lvx_TextAttr_ShadowB   0x1000 /* bottom       */
#define lvx_TextAttr_ShadowT   0x2000 /* top          */
#define lvx_TextAttr_ShadowR   0x4000 /* right        */
#define lvx_TextAttr_ShadowL   0x8000 /* left         */

#define lvx_Color_None         0xFFFFFFFF /* for disabling transparent color */

#define lvx_Color_Black        0x00000000
#define lvx_Color_Maroon       0x00000080
#define lvx_Color_Green        0x00008000
#define lvx_Color_Olive        0x00008080
#define lvx_Color_Navy         0x00800000
#define lvx_Color_Purple       0x00800080
#define lvx_Color_Teal         0x00808000
#define lvx_Color_Gray         0x00808080
#define lvx_Color_Silver       0x00C0C0C0
#define lvx_Color_Red          0x000000FF
#define lvx_Color_Lime         0x0000FF00
#define lvx_Color_Yellow       0x0000FFFF
#define lvx_Color_Blue         0x00FF0000
#define lvx_Color_Fuchsia      0x00FF00FF
#define lvx_Color_Aqua         0x00FFFF00
#define lvx_Color_LtGray       0x00C0C0C0
#define lvx_Color_DkGray       0x00808080
#define lvx_Color_White        0x00FFFFFF

#define lvx_CameraGain_Analog  0x00000001ul
#define lvx_CameraGain_Digital 0x00000002ul

#define lvx_Cmd_GetAcquiredInfoWidth     0x00010001ul
#define lvx_Cmd_GetAcquiredInfoHeight    0x00010002ul
#define lvx_Cmd_GetAcquiredInfoFlags     0x00010003ul
#define lvx_Cmd_GetAcquiredInfoFrameId   0x00010004ul
#define lvx_Cmd_GetAcquiredInfoTimeStamp 0x00010005ul

#define lvx_Cmd_SetLutMono8Bit           0x00020001ul
#define lvx_Cmd_SetLutMono10Bit          0x00020002ul
#define lvx_Cmd_SetLutMono12Bit          0x00020003ul
#define lvx_Cmd_SetLutRgb8Bit            0x00020004ul

#define lvx_Cmd_GetLutMono8Bit           0x00020011ul
#define lvx_Cmd_GetLutMono10Bit          0x00020012ul
#define lvx_Cmd_GetLutMono12Bit          0x00020013ul
#define lvx_Cmd_GetLutRgb8Bit            0x00020014ul

#define lvx_Cmd_IsCameraConnected        0x00030001ul

#define lvx_Cmd_UtilSetFrameTimeLog      0x01000001ul
#define lvx_Cmd_UtilGetFrameTime         0x01000002ul

#define lvx_Cmd_GetPixelValue            0x00040001ul

#endif

/* --- FUNCTIONS --- */

#if defined(__cplusplus)
#define DLLENTRY extern "C"
#else
#define DLLENTRY
#endif


/* DLL loading */

/** @defgroup OrchidFunctions Orchid functions 
 */
/** @defgroup OrchidFunctionsInitializing Initial Settings Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsDllLoad DLL Load Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsStatusCheck Status Checking Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsModuleCreation Module Creation and Deletion Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsRunTime Grab and Run-time Settings Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsDisplay Display Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsImageAccess Image Access Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsSavingImagesToFile Saving to File Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsSavingAndLoadingSettings Saving and Loading Settings Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsDialogBoxes Dialog Boxes Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsQueryingInfo Querying Info Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsGrabNotify Grab Notifying Functions.
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsCommands Commands Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsIOControl I/O Control Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsPreprocess Preprocessor Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsDirectX DirectX Functions
* @ingroup OrchidFunctions
*/
/** @defgroup OrchidFunctionsCommControl Comm Control Functions
* @ingroup OrchidFunctions
*/

/* -------------------------------------------------------------------------- */

/** Enables/disables showing the "Loading Orchid DLLs..." window at startup.
* Orchid postpones loading other DLLs to the time when it is really needed.
* The load time can take several seconds - depending on type and number of installed hardware.
* By default, a small screen centered window announcing
* "Loading Orchid DLLs..." is displayed during the load time, so the user is
* aware about it.\n
* \n
* This property enables to hide the window.\n
* \n
* This method must be called before creating any class instance or before calling any other Orchid function.
* @ingroup OrchidFunctionsDllLoad
* @param bEnable true to enable showing the window, false to hide it.
*
* @par See also .NET version:
*      LeutronVision::Orchid::LvxDll::LoadWindowEnable
*/

DLLENTRY void WINAPI lvx_SetLoadWindowEnable(BOOL bEnable);

/** Returns TRUE if the "Loading Orchid DLLs..." window at startup is enabled.
 * See lvx_SetLoadWindowEnable() for details.
* @ingroup OrchidFunctionsDllLoad
* @par See also .NET version:
*      LeutronVision::Orchid::LvxDll::LoadWindowEnable
*/

DLLENTRY BOOL WINAPI lvx_GetLoadWindowEnable();

/* -------------------------------------------------------------------------- */

/** Enables to change the "Loading Orchid DLLs..." text in the window displayed at startup.
* See lvx_SetLoadWindowEnable() for details.
* This method must be called before creating any class instance or before
* calling any other Orchid function.
* @ingroup OrchidFunctionsDllLoad
* @param pszText Text to be displayed instead of "Loading Orchid DLLs...".
* @param iWindowWidth Window width in pixels.
* @param iWindowHeight Window height in pixels.
*
* @par See also .NET version:
*      LeutronVision::Orchid::LvxDll::SetLoadWindowText()
*/