57 lines
1.4 KiB
C++
57 lines
1.4 KiB
C++
/**
|
|
* @file include/ActivOneApi/Constants/KernelBypassModes.h
|
|
*
|
|
* @brief Header for the KernelBypassMode definitions.
|
|
*/
|
|
|
|
#if (!defined ACTIV_ONE_API_CONSTANTS_KERNEL_BYPASS_MODES_H)
|
|
#define ACTIV_ONE_API_CONSTANTS_KERNEL_BYPASS_MODES_H
|
|
|
|
#include "ActivOneApi/External.h"
|
|
|
|
#include "ActivOneApi/TypeDefinitions.h"
|
|
|
|
//! Activ namespace.
|
|
namespace Activ
|
|
{
|
|
|
|
//! OneApi namespace.
|
|
namespace OneApi
|
|
{
|
|
|
|
// KernelBypassMode values.
|
|
|
|
/**
|
|
* @brief Attempt to use kernel bypass if available.
|
|
*
|
|
* Any errors encountered whilst attempting to enable kernel bypass will be ignored.
|
|
*/
|
|
const KernelBypassMode KERNEL_BYPASS_MODE_AUTO = 0;
|
|
|
|
/**
|
|
* @brief Always use kernel bypass.
|
|
*
|
|
* Exceptions are raised if kernel bypass is not available, or if any errors are encountered whilst enabling kernel bypass.
|
|
*/
|
|
const KernelBypassMode KERNEL_BYPASS_MODE_ON = 1;
|
|
|
|
//! Never use kernel bypass.
|
|
const KernelBypassMode KERNEL_BYPASS_MODE_OFF = 2;
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* @brief Convert a KernelBypassMode to a string.
|
|
*
|
|
* @param kernelBypassMode
|
|
*
|
|
* @return String representation of @a kernelBypassMode.
|
|
*/
|
|
ACTIV_ONE_API String KernelBypassModeToString(const KernelBypassMode kernelBypassMode);
|
|
|
|
} // namespace OneApi
|
|
|
|
} // namespace Activ
|
|
|
|
#endif // (!defined ACTIV_ONE_API_CONSTANTS_KERNEL_BYPASS_MODES_H)
|