Added code-documentation for the Profile-implementation

This commit is contained in:
DarthAffe committed 2016-02-07 10:26:35 +01:00
1 parent 089cada426
commit 6479de8d26
5 files changed
+89

No files matched your search

+13
View File
@@ -5,6 +5,9 @@ using CUE.NET.Devices.Keyboard.Keys;
namespace CUE.NET.Brushes
{
/// <summary>
/// Represents a brush drawing the lighting of a CUE profile.
/// </summary>
public class ProfileBrush : AbstractBrush
{
#region Properties & Fields
@@ -15,6 +18,10 @@ namespace CUE.NET.Brushes
#region Constructors
/// <summary>
/// Initializes a new instance of the <see cref="ProfileBrush"/> class.
/// </summary>
/// <param name="keyLights">The light settings of the CUE profile.</param>
internal ProfileBrush(Dictionary<CorsairKeyboardKeyId, Color> keyLights)
{
this._keyLights = keyLights;
@@ -24,6 +31,12 @@ namespace CUE.NET.Brushes
#region Methods
/// <summary>
/// Gets the color at an specific point getting the color of the key at the given point.
/// </summary>
/// <param name="rectangle">The rectangle in which the brush should be drawn.</param>
/// <param name="point">The point from which the color should be taken.</param>
/// <returns>The color of the key at the specified point.</returns>
public override Color GetColorAtPoint(RectangleF rectangle, PointF point)
{
CorsairKey key = CueSDK.KeyboardSDK[point];