KeyboardFrame¶
namespace GameSense
public class KeyboardFrame
A class that contains a color bitmap for a full keyboard effect. See the GameSense SDK docs for more information on full keyboard effects.
Summary¶
Constructors¶
| Constructor |
|---|
KeyboardFrame() |
Properties¶
public¶
| Type | Property | Get | Set |
|---|---|---|---|
int[][] |
Bitmap |
Methods¶
public¶
| Returns | Method |
|---|---|
KeyboardFrame |
SetColor(int index, int r, int g, int b) |
KeyboardFrame |
SetColor(int index, int[] color) |
KeyboardFrame |
Copy() |
Constructors¶
KeyboardFrame¶
public KeyboardFrame()
Initializes a new instance of the class.
Properties¶
Bitmap¶
Source ยท Default: A 132 by 3 int array filled with zeros.
public int[][] Bitmap {get; set;}
Gets or sets the color bitmap. This bitmap is used by the GameSense Engine to map a 22x6 grid to the keys of the keyboard.
Methods¶
SetColor¶
public KeyboardFrame SetColor(int index, int r, int g, int b)
Sets a color in the Bitmap.
Returns¶
Itself
Parameters¶
| Type | Name | Description | Default |
|---|---|---|---|
int |
index |
The index of the Bitmap or a Key to set the color of a specific key |
|
int |
r |
The red channel value | |
int |
g |
The green channel value | |
int |
b |
The blue channel value |
SetColor¶
public KeyboardFrame SetColor(int index, int[] color)
Sets a color in the Bitmap.
Returns¶
Itself
Parameters¶
| Type | Name | Description | Default |
|---|---|---|---|
int |
index |
The index of the Bitmap or a Key to set the color of a specific key |
- |
int[] |
color |
The color to be set (RGB format) | - |
Copy¶
public KeyboardFrame Copy()
Creates a copy of itself.
Returns¶
The copied version of itself.