Razer Chroma SDK
Razer Chroma SDK Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Classes | Typedefs | Enumerations | Variables
ChromaSDK::Keyboard Namespace Reference

Keyboards. More...

Classes

struct  BREATHING_EFFECT_TYPE
 Breathing effect type. More...
 
struct  CUSTOM_EFFECT_TYPE
 Custom effect using a matrix type. More...
 
struct  CUSTOM_KEY_EFFECT_TYPE
 Custom effect with keys. More...
 
struct  REACTIVE_EFFECT_TYPE
 Reactive effect type. More...
 
struct  STARLIGHT_EFFECT_TYPE
 Starlight effect. More...
 
struct  STATIC_EFFECT_TYPE
 Static effect type. More...
 
struct  WAVE_EFFECT_TYPE
 Wave effect type. More...
 

Typedefs

typedef enum
ChromaSDK::Keyboard::RZKEY 
RZKEY
 Definitions of keys.
 
typedef enum
ChromaSDK::Keyboard::RZLED 
RZLED
 Definition of LEDs.
 
typedef enum
ChromaSDK::Keyboard::EFFECT_TYPE 
EFFECT_TYPE
 Chroma keyboard effect types.
 
typedef struct
ChromaSDK::Keyboard::BREATHING_EFFECT_TYPE 
BREATHING_EFFECT_TYPE
 Breathing effect type.
 
typedef struct
ChromaSDK::Keyboard::CUSTOM_EFFECT_TYPE 
CUSTOM_EFFECT_TYPE
 Custom effect using a matrix type.
 
typedef struct
ChromaSDK::Keyboard::CUSTOM_KEY_EFFECT_TYPE 
CUSTOM_KEY_EFFECT_TYPE
 Custom effect with keys.
 
typedef struct
ChromaSDK::Keyboard::REACTIVE_EFFECT_TYPE 
REACTIVE_EFFECT_TYPE
 Reactive effect type.
 
typedef struct
ChromaSDK::Keyboard::STARLIGHT_EFFECT_TYPE 
STARLIGHT_EFFECT_TYPE
 Starlight effect.
 
typedef struct
ChromaSDK::Keyboard::STATIC_EFFECT_TYPE 
STATIC_EFFECT_TYPE
 Static effect type.
 
typedef struct
ChromaSDK::Keyboard::WAVE_EFFECT_TYPE 
WAVE_EFFECT_TYPE
 Wave effect type.
 

Enumerations

enum  RZKEY {
  RZKEY_ESC = 0x0001,
  RZKEY_F1 = 0x0003,
  RZKEY_F2 = 0x0004,
  RZKEY_F3 = 0x0005,
  RZKEY_F4 = 0x0006,
  RZKEY_F5 = 0x0007,
  RZKEY_F6 = 0x0008,
  RZKEY_F7 = 0x0009,
  RZKEY_F8 = 0x000A,
  RZKEY_F9 = 0x000B,
  RZKEY_F10 = 0x000C,
  RZKEY_F11 = 0x000D,
  RZKEY_F12 = 0x000E,
  RZKEY_1 = 0x0102,
  RZKEY_2 = 0x0103,
  RZKEY_3 = 0x0104,
  RZKEY_4 = 0x0105,
  RZKEY_5 = 0x0106,
  RZKEY_6 = 0x0107,
  RZKEY_7 = 0x0108,
  RZKEY_8 = 0x0109,
  RZKEY_9 = 0x010A,
  RZKEY_0 = 0x010B,
  RZKEY_A = 0x0302,
  RZKEY_B = 0x0407,
  RZKEY_C = 0x0405,
  RZKEY_D = 0x0304,
  RZKEY_E = 0x0204,
  RZKEY_F = 0x0305,
  RZKEY_G = 0x0306,
  RZKEY_H = 0x0307,
  RZKEY_I = 0x0209,
  RZKEY_J = 0x0308,
  RZKEY_K = 0x0309,
  RZKEY_L = 0x030A,
  RZKEY_M = 0x0409,
  RZKEY_N = 0x0408,
  RZKEY_O = 0x020A,
  RZKEY_P = 0x020B,
  RZKEY_Q = 0x0202,
  RZKEY_R = 0x0205,
  RZKEY_S = 0x0303,
  RZKEY_T = 0x0206,
  RZKEY_U = 0x0208,
  RZKEY_V = 0x0406,
  RZKEY_W = 0x0203,
  RZKEY_X = 0x0404,
  RZKEY_Y = 0x0207,
  RZKEY_Z = 0x0403,
  RZKEY_NUMLOCK = 0x0112,
  RZKEY_NUMPAD0 = 0x0513,
  RZKEY_NUMPAD1 = 0x0412,
  RZKEY_NUMPAD2 = 0x0413,
  RZKEY_NUMPAD3 = 0x0414,
  RZKEY_NUMPAD4 = 0x0312,
  RZKEY_NUMPAD5 = 0x0313,
  RZKEY_NUMPAD6 = 0x0314,
  RZKEY_NUMPAD7 = 0x0212,
  RZKEY_NUMPAD8 = 0x0213,
  RZKEY_NUMPAD9 = 0x0214,
  RZKEY_NUMPAD_DIVIDE = 0x0113,
  RZKEY_NUMPAD_MULTIPLY = 0x0114,
  RZKEY_NUMPAD_SUBTRACT = 0x0115,
  RZKEY_NUMPAD_ADD = 0x0215,
  RZKEY_NUMPAD_ENTER = 0x0415,
  RZKEY_NUMPAD_DECIMAL = 0x0514,
  RZKEY_PRINTSCREEN = 0x000F,
  RZKEY_SCROLL = 0x0010,
  RZKEY_PAUSE = 0x0011,
  RZKEY_INSERT = 0x010F,
  RZKEY_HOME = 0x0110,
  RZKEY_PAGEUP = 0x0111,
  RZKEY_DELETE = 0x020f,
  RZKEY_END = 0x0210,
  RZKEY_PAGEDOWN = 0x0211,
  RZKEY_UP = 0x0410,
  RZKEY_LEFT = 0x050F,
  RZKEY_DOWN = 0x0510,
  RZKEY_RIGHT = 0x0511,
  RZKEY_TAB = 0x0201,
  RZKEY_CAPSLOCK = 0x0301,
  RZKEY_BACKSPACE = 0x010E,
  RZKEY_ENTER = 0x030E,
  RZKEY_LCTRL = 0x0501,
  RZKEY_LWIN = 0x0502,
  RZKEY_LALT = 0x0503,
  RZKEY_SPACE = 0x0507,
  RZKEY_RALT = 0x050B,
  RZKEY_FN = 0x050C,
  RZKEY_RMENU = 0x050D,
  RZKEY_RCTRL = 0x050E,
  RZKEY_LSHIFT = 0x0401,
  RZKEY_RSHIFT = 0x040E,
  RZKEY_MACRO1 = 0x0100,
  RZKEY_MACRO2 = 0x0200,
  RZKEY_MACRO3 = 0x0300,
  RZKEY_MACRO4 = 0x0400,
  RZKEY_MACRO5 = 0x0500,
  RZKEY_OEM_1 = 0x0101,
  RZKEY_OEM_2 = 0x010C,
  RZKEY_OEM_3 = 0x010D,
  RZKEY_OEM_4 = 0x020C,
  RZKEY_OEM_5 = 0x020D,
  RZKEY_OEM_6 = 0x020E,
  RZKEY_OEM_7 = 0x030B,
  RZKEY_OEM_8 = 0x030C,
  RZKEY_OEM_9 = 0x040A,
  RZKEY_OEM_10 = 0x040B,
  RZKEY_OEM_11 = 0x040C,
  RZKEY_EUR_1 = 0x030D,
  RZKEY_EUR_2 = 0x0402,
  RZKEY_JPN_1 = 0x0015,
  RZKEY_JPN_2 = 0x040D,
  RZKEY_JPN_3 = 0x0504,
  RZKEY_JPN_4 = 0x0509,
  RZKEY_JPN_5 = 0x050A,
  RZKEY_KOR_1 = 0x0015,
  RZKEY_KOR_2 = 0x030D,
  RZKEY_KOR_3 = 0x0402,
  RZKEY_KOR_4 = 0x040D,
  RZKEY_KOR_5 = 0x0504,
  RZKEY_KOR_6 = 0x0509,
  RZKEY_KOR_7 = 0x050A,
  RZKEY_INVALID = 0xFFFF
}
 Definitions of keys. More...
 
enum  RZLED { RZLED_LOGO = 0x0014 }
 Definition of LEDs. More...
 
enum  EFFECT_TYPE {
  CHROMA_NONE = 0,
  CHROMA_BREATHING,
  CHROMA_CUSTOM,
  CHROMA_REACTIVE,
  CHROMA_STATIC,
  CHROMA_SPECTRUMCYCLING,
  CHROMA_WAVE,
  CHROMA_RESERVED,
  CHROMA_CUSTOM_KEY,
  CHROMA_INVALID
}
 Chroma keyboard effect types. More...
 

Variables

const RZSIZE MAX_ROW = 6
 Maximum number of rows in a keyboard.
 
const RZSIZE MAX_COLUMN = 22
 Maximum number of columns in a keyboard.
 
const RZSIZE MAX_KEYS = MAX_ROW * MAX_COLUMN
 Maximum number of keys.
 
const RZSIZE MAX_CUSTOM_EFFECTS = MAX_KEYS
 Maximum number of custom effects.
 
const COLORREF RZKEY_LAYOUT [MAX_ROW][MAX_COLUMN] = {}
 Keyboard LED layout.
 

Detailed Description

Keyboards.

Enumeration Type Documentation

Chroma keyboard effect types.

Enumerator
CHROMA_NONE 

No effect.

CHROMA_BREATHING 

Breathing effect.

CHROMA_CUSTOM 

Custom effect.

CHROMA_REACTIVE 

Reactive effect.

CHROMA_STATIC 

Static effect.

CHROMA_SPECTRUMCYCLING 

Spectrum cycling effect.

CHROMA_WAVE 

Wave effect.

CHROMA_RESERVED 

TODO.

CHROMA_CUSTOM_KEY 

Custom effects with keys.

CHROMA_INVALID 

Invalid effect.

Definitions of keys.

Enumerator
RZKEY_ESC 

Esc (VK_ESCAPE)

RZKEY_F1 

F1 (VK_F1)

RZKEY_F2 

F2 (VK_F2)

RZKEY_F3 

F3 (VK_F3)

RZKEY_F4 

F4 (VK_F4)

RZKEY_F5 

F5 (VK_F5)

RZKEY_F6 

F6 (VK_F6)

RZKEY_F7 

F7 (VK_F7)

RZKEY_F8 

F8 (VK_F8)

RZKEY_F9 

F9 (VK_F9)

RZKEY_F10 

F10 (VK_F10)

RZKEY_F11 

F11 (VK_F11)

RZKEY_F12 

F12 (VK_F12)

RZKEY_1 

1 (VK_1)

RZKEY_2 

2 (VK_2)

RZKEY_3 

3 (VK_3)

RZKEY_4 

4 (VK_4)

RZKEY_5 

5 (VK_5)

RZKEY_6 

6 (VK_6)

RZKEY_7 

7 (VK_7)

RZKEY_8 

8 (VK_8)

RZKEY_9 

9 (VK_9)

RZKEY_0 

0 (VK_0)

RZKEY_A 

A (VK_A)

RZKEY_B 

B (VK_B)

RZKEY_C 

C (VK_C)

RZKEY_D 

D (VK_D)

RZKEY_E 

E (VK_E)

RZKEY_F 

F (VK_F)

RZKEY_G 

G (VK_G)

RZKEY_H 

H (VK_H)

RZKEY_I 

I (VK_I)

RZKEY_J 

J (VK_J)

RZKEY_K 

K (VK_K)

RZKEY_L 

L (VK_L)

RZKEY_M 

M (VK_M)

RZKEY_N 

N (VK_N)

RZKEY_O 

O (VK_O)

RZKEY_P 

P (VK_P)

RZKEY_Q 

Q (VK_Q)

RZKEY_R 

R (VK_R)

RZKEY_S 

S (VK_S)

RZKEY_T 

T (VK_T)

RZKEY_U 

U (VK_U)

RZKEY_V 

V (VK_V)

RZKEY_W 

W (VK_W)

RZKEY_X 

X (VK_X)

RZKEY_Y 

Y (VK_Y)

RZKEY_Z 

Z (VK_Z)

RZKEY_NUMLOCK 

Numlock (VK_NUMLOCK)

RZKEY_NUMPAD0 

Numpad 0 (VK_NUMPAD0)

RZKEY_NUMPAD1 

Numpad 1 (VK_NUMPAD1)

RZKEY_NUMPAD2 

Numpad 2 (VK_NUMPAD2)

RZKEY_NUMPAD3 

Numpad 3 (VK_NUMPAD3)

RZKEY_NUMPAD4 

Numpad 4 (VK_NUMPAD4)

RZKEY_NUMPAD5 

Numpad 5 (VK_NUMPAD5)

RZKEY_NUMPAD6 

Numpad 6 (VK_NUMPAD6)

RZKEY_NUMPAD7 

Numpad 7 (VK_NUMPAD7)

RZKEY_NUMPAD8 

Numpad 8 (VK_NUMPAD8)

RZKEY_NUMPAD9 

Numpad 9 (VK_ NUMPAD9

RZKEY_NUMPAD_DIVIDE 

Divide (VK_DIVIDE)

RZKEY_NUMPAD_MULTIPLY 

Multiply (VK_MULTIPLY)

RZKEY_NUMPAD_SUBTRACT 

Subtract (VK_SUBTRACT)

RZKEY_NUMPAD_ADD 

Add (VK_ADD)

RZKEY_NUMPAD_ENTER 

Enter (VK_RETURN - Extended)

RZKEY_NUMPAD_DECIMAL 

Decimal (VK_DECIMAL)

RZKEY_PRINTSCREEN 

Print Screen (VK_PRINT)

RZKEY_SCROLL 

Scroll Lock (VK_SCROLL)

RZKEY_PAUSE 

Pause (VK_PAUSE)

RZKEY_INSERT 

Insert (VK_INSERT)

RZKEY_HOME 

Home (VK_HOME)

RZKEY_PAGEUP 

Page Up (VK_PRIOR)

RZKEY_DELETE 

Delete (VK_DELETE)

RZKEY_END 

End (VK_END)

RZKEY_PAGEDOWN 

Page Down (VK_NEXT)

RZKEY_UP 

Up (VK_UP)

RZKEY_LEFT 

Left (VK_LEFT)

RZKEY_DOWN 

Down (VK_DOWN)

RZKEY_RIGHT 

Right (VK_RIGHT)

RZKEY_TAB 

Tab (VK_TAB)

RZKEY_CAPSLOCK 

Caps Lock(VK_CAPITAL)

RZKEY_BACKSPACE 

Backspace (VK_BACK)

RZKEY_ENTER 

Enter (VK_RETURN)

RZKEY_LCTRL 

Left Control(VK_LCONTROL)

RZKEY_LWIN 

Left Window (VK_LWIN)

RZKEY_LALT 

Left Alt (VK_LMENU)

RZKEY_SPACE 

Spacebar (VK_SPACE)

RZKEY_RALT 

Right Alt (VK_RMENU)

RZKEY_FN 

Function key.

RZKEY_RMENU 

Right Menu (VK_APPS)

RZKEY_RCTRL 

Right Control (VK_RCONTROL)

RZKEY_LSHIFT 

Left Shift (VK_LSHIFT)

RZKEY_RSHIFT 

Right Shift (VK_RSHIFT)

RZKEY_MACRO1 

Macro Key 1

RZKEY_MACRO2 

Macro Key 2

RZKEY_MACRO3 

Macro Key 3

RZKEY_MACRO4 

Macro Key 4

RZKEY_MACRO5 

Macro Key 5

RZKEY_OEM_1 

~ (tilde/半角/全角) (VK_OEM_3)

RZKEY_OEM_2 

– (minus) (VK_OEM_MINUS)

RZKEY_OEM_3 

= (equal) (VK_OEM_PLUS)

RZKEY_OEM_4 

[ (left sqaure bracket) (VK_OEM_4)

RZKEY_OEM_5 

] (right square bracket) (VK_OEM_6)

RZKEY_OEM_6 

\ (backslash) (VK_OEM_5)

RZKEY_OEM_7 

; (semi-colon) (VK_OEM_1)

RZKEY_OEM_8 

' (apostrophe) (VK_OEM_7)

RZKEY_OEM_9 

, (comma) (VK_OEM_COMMA)

RZKEY_OEM_10 

. (period) (VK_OEM_PERIOD)

RZKEY_OEM_11 

/ (forward slash) (VK_OEM_2)

RZKEY_EUR_1 

"#" (VK_OEM_5)

RZKEY_EUR_2 

\ (VK_OEM_102)

RZKEY_JPN_1 

¥ (0xFF)

RZKEY_JPN_2 

\ (0xC1)

RZKEY_JPN_3 

無変換 (VK_OEM_PA1)

RZKEY_JPN_4 

変換 (0xFF)

RZKEY_JPN_5 

ひらがな/カタカナ (0xFF)

RZKEY_KOR_1 

| (0xFF)

RZKEY_KOR_2 

(VK_OEM_5)

RZKEY_KOR_3 

(VK_OEM_102)

RZKEY_KOR_4 

(0xC1)

RZKEY_KOR_5 

(VK_OEM_PA1)

RZKEY_KOR_6 

한/영 (0xFF)

RZKEY_KOR_7 

(0xFF)

RZKEY_INVALID 

Invalid keys.

Definition of LEDs.

Enumerator
RZLED_LOGO 

Razer logo