RzChromaSDK.h 文件参考

导出的 API。 更多...

#include "RzErrors.h"
#include "RzChromaSDKDevices.h"
#include "RzChromaSDKTypes.h"

浏览源代码.

函数
RZRESULT	InitSDK (ChromaSDK::APPINFOTYPE *pAppInfo)
RZRESULT	UnInit (void)
RZRESULT	CreateEffect (RZDEVICEID DeviceId, ChromaSDK::EFFECT_TYPE Effect, PRZPARAM pParam, RZEFFECTID *pEffectId)
RZRESULT	CreateKeyboardEffect (ChromaSDK::Keyboard::EFFECT_TYPE Effect, PRZPARAM pParam, RZEFFECTID *pEffectId)
RZRESULT	CreateMouseEffect (ChromaSDK::Mouse::EFFECT_TYPE Effect, PRZPARAM pParam, RZEFFECTID *pEffectId)
RZRESULT	CreateHeadsetEffect (ChromaSDK::Headset::EFFECT_TYPE Effect, PRZPARAM pParam, RZEFFECTID *pEffectId)
RZRESULT	CreateMousepadEffect (ChromaSDK::Mousepad::EFFECT_TYPE Effect, PRZPARAM pParam, RZEFFECTID *pEffectId)
RZRESULT	CreateKeypadEffect (ChromaSDK::Keypad::EFFECT_TYPE Effect, PRZPARAM pParam, RZEFFECTID *pEffectId)
RZRESULT	CreateChromaLinkEffect (ChromaSDK::ChromaLink::EFFECT_TYPE Effect, PRZPARAM pParam, RZEFFECTID *pEffectId)
RZRESULT	DeleteEffect (RZEFFECTID EffectId)
RZRESULT	SetEffect (RZEFFECTID EffectId)

详细描述

导出的 API。

函数说明

CreateChromaLinkEffect()

RZRESULT CreateChromaLinkEffect	(	ChromaSDK::ChromaLink::EFFECT_TYPE	Effect,
		PRZPARAM	pParam,
		RZEFFECTID *	pEffectId
	)

为 Chroma Linked 设备创建效果。阅读 Chroma Link 开发人员指南 了解更多信息。

参数

[in]	Effect	Chroma Link 效果类型。
[in]	pParam	指向在 RzChromaSDKTypes.h 中所定义的效果指定的参数类型的指针
[in,out]	pEffectId	如果成功，则为有效的效果 ID。如果不需要，则将其设置为 NULL。

返回

RZRESULT_NOT_VALID_STATE: Chroma SDK 处于无效状态。是否忘记调用 Init()？

RZRESULT_INVALID_PARAMETER: 参数无效。

RZRESULT_NOT_SUPPORTED: 设备不支持此效果。

如需了解其他错误代码，请参阅 Windows SDK (WinError.h) 中的“Windows 系统错误代码”。

示例

ChromaSDKImpl.cpp.

CreateEffect()

RZRESULT CreateEffect	(	RZDEVICEID	DeviceId,
		ChromaSDK::EFFECT_TYPE	Effect,
		PRZPARAM	pParam,
		RZEFFECTID *	pEffectId
	)

为特定设备创建通用效果。

参数

[in]	DeviceId	RzChromaSDKDevices.h 中定义的设备 ID
[in]	Effect	标准效果类型。
[in]	pParam	指向效果指定的参数类型的指针。
[in,out]	pEffectId	如果成功，则为有效的效果 ID。如果不需要，则将其设置为NULL。

返回

RZRESULT_NOT_VALID_STATE: Chroma SDK 处于无效状态。是否忘记调用 Init()？

RZRESULT_INVALID_PARAMETER: 参数无效。

RZRESULT_DEVICE_NOT_AVAILABLE: 设备不受支持。

RZRESULT_NOT_SUPPORTED: 设备不支持此效果。

如需了解其他错误代码，请参阅 Windows SDK (WinError.h) 中的“Windows 系统错误代码”。

示例

ChromaSDKImpl.cpp.

CreateHeadsetEffect()

RZRESULT CreateHeadsetEffect	(	ChromaSDK::Headset::EFFECT_TYPE	Effect,
		PRZPARAM	pParam,
		RZEFFECTID *	pEffectId
	)

创建耳麦效果。

参数

[in]	Effect	耳麦效果类型。
[in]	pParam	指向在 RzChromaSDKTypes.h 中所定义的效果指定的参数类型的指针
[in,out]	pEffectId	如果成功，则为有效的效果 ID。如果不需要，则将其设置为 NULL。

返回

RZRESULT_NOT_VALID_STATE: Chroma SDK 处于无效状态。是否忘记调用 Init()？

RZRESULT_INVALID_PARAMETER: 参数无效。

RZRESULT_NOT_SUPPORTED: 设备不支持此效果。

如需了解其他错误代码，请参阅 Windows SDK (WinError.h) 中的“Windows 系统错误代码”。

示例

ChromaSDKImpl.cpp.

CreateKeyboardEffect()

RZRESULT CreateKeyboardEffect	(	ChromaSDK::Keyboard::EFFECT_TYPE	Effect,
		PRZPARAM	pParam,
		RZEFFECTID *	pEffectId
	)

创建键盘效果。

参数

[in]	Effect	键盘效果类型。
[in]	pParam	指向效果指定的参数类型的指针。
[in,out]	pEffectId	如果成功，则为有效的效果 ID。如果不需要，则将其设置为 NULL。

返回

RZRESULT_NOT_VALID_STATE: Chroma SDK 处于无效状态。是否忘记调用 Init()？

RZRESULT_INVALID_PARAMETER: 参数无效。

RZRESULT_NOT_SUPPORTED: 设备不支持此效果。

如需了解其他错误代码，请参阅 Windows SDK (WinError.h) 中的“Windows 系统错误代码”。

示例

ChromaSDKImpl.cpp.

CreateKeypadEffect()

RZRESULT CreateKeypadEffect	(	ChromaSDK::Keypad::EFFECT_TYPE	Effect,
		PRZPARAM	pParam,
		RZEFFECTID *	pEffectId
	)

创建键盘效果。

参数

[in]	Effect	键盘效果类型。
[in]	pParam	指向在 RzChromaSDKTypes.h 中所定义的效果指定的参数类型的指针
[in,out]	pEffectId	如果成功，则为有效的效果 ID。如果不需要，则将其设置为 NULL。

返回

RZRESULT_NOT_VALID_STATE: Chroma SDK 处于无效状态。是否忘记调用 Init()？

RZRESULT_INVALID_PARAMETER: 参数无效。

RZRESULT_NOT_SUPPORTED: 设备不支持此效果。

如需了解其他错误代码，请参阅 Windows SDK (WinError.h) 中的“Windows 系统错误代码”。

示例

ChromaSDKImpl.cpp.

CreateMouseEffect()

RZRESULT CreateMouseEffect	(	ChromaSDK::Mouse::EFFECT_TYPE	Effect,
		PRZPARAM	pParam,
		RZEFFECTID *	pEffectId
	)

创建鼠标效果。

参数

[in]	Effect	鼠标效果类型。
[in]	pParam	指向效果指定的参数类型的指针。
[in,out]	pEffectId	如果成功，则为有效的效果 ID。如果不需要，则将其设置为 NULL。

返回

RZRESULT_NOT_VALID_STATE: Chroma SDK 处于无效状态。是否忘记调用 Init()？

RZRESULT_INVALID_PARAMETER: 参数无效。

RZRESULT_NOT_SUPPORTED: 设备不支持此效果。

如需了解其他错误代码，请参阅 Windows SDK (WinError.h) 中的“Windows 系统错误代码”。

示例

ChromaSDKImpl.cpp.

CreateMousepadEffect()

RZRESULT CreateMousepadEffect	(	ChromaSDK::Mousepad::EFFECT_TYPE	Effect,
		PRZPARAM	pParam,
		RZEFFECTID *	pEffectId
	)

创建鼠标垫效果。

参数

[in]	Effect	鼠标垫效果类型。
[in]	pParam	指向在 RzChromaSDKTypes.h 中所定义的效果指定的参数类型的指针
[in,out]	pEffectId	如果成功，则为有效的效果 ID。如果不需要，则将其设置为 NULL。

返回

RZRESULT_NOT_VALID_STATE: Chroma SDK 处于无效状态。是否忘记调用 Init()？

RZRESULT_INVALID_PARAMETER: 参数无效。

RZRESULT_NOT_SUPPORTED: 设备不支持此效果。

如需了解其他错误代码，请参阅 Windows SDK (WinError.h) 中的“Windows 系统错误代码”。

DeleteEffect()

RZRESULT DeleteEffect

(

RZEFFECTID

EffectId

)

删除效果。

参数

[in]

EffectId

需删除之效果的 ID。

返回

RZRESULT_NOT_VALID_STATE: Chroma SDK 处于无效状态。是否忘记调用 Init()？

RZRESULT_NOT_FOUND: 未找到效果 ID。

如需了解其他错误代码，请参阅 Windows SDK (WinError.h) 中的“Windows 系统错误代码”。

示例

ChromaSDKImpl.cpp.

InitSDK()

RZRESULT InitSDK

(

ChromaSDK::APPINFOTYPE *

pAppInfo

)

使用 APPINFOTYPE 中指定的应用程序信息初始化 Chroma SDK。

参数

[in]

pAppInfo

RzChromaSDKTypes.h 中定义的应用信息。

返回

RZRESULT_ALREADY_INITIALIZED: Chroma SDK 已初始化。

如需了解其他错误代码，请参阅 Windows SDK (WinError.h) 中的“Windows 系统错误代码”。

示例

ChromaSDKImpl.cpp.

SetEffect()

RZRESULT SetEffect

(

RZEFFECTID

EffectId

)

设置效果。

参数

[in]

EffectId

需设置之效果的 ID。

返回

RZRESULT_NOT_VALID_STATE: Chroma SDK 处于无效状态。是否忘记调用 Init()？

RZRESULT_ACCESS_DENIED: 无权访问设备。

RZRESULT_NOT_FOUND: 未找到效果 ID。

如需了解其他错误代码，请参阅 Windows SDK (WinError.h) 中的“Windows 系统错误代码”。

示例

ChromaSDKImpl.cpp.

UnInit()

RZRESULT UnInit

(

void

)

取消初始化 Chroma SDK。

返回

RZRESULT_NOT_VALID_STATE: Chroma SDK 处于无效状态。对于每一个 Init() 调用，应有一个相应的UnInit()。

如需了解其他错误代码，请参阅 Windows SDK (WinError.h) 中的“Windows 系统错误代码”。

示例

ChromaSDKImpl.cpp.