Skip to content
This repository has been archived by the owner on Sep 7, 2021. It is now read-only.

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
jkuhlmann committed Aug 30, 2015
1 parent f9dae16 commit a6ee71d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
9 changes: 9 additions & 0 deletions lib/include/gainput/GainputDebugRenderer.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,22 @@ namespace gainput
{

/// Interface for debug rendering of input device states.
/**
* Coordinates and other measures passed to the interface's functions are in the
* range of 0.0f to 1.0f.
*
* The functions are called as part InputManager::Update().
*/
class GAINPUT_LIBEXPORT DebugRenderer
{
public:
/// Called to draw a circle with the given radius.
virtual void DrawCircle(float x, float y, float radius) = 0;

/// Called to draw a line between the two given points.
virtual void DrawLine(float x1, float y1, float x2, float y2) = 0;

/// Called to draw some text at the given position.
virtual void DrawText(float x, float y, const char* const text) = 0;
};

Expand Down
2 changes: 2 additions & 0 deletions lib/include/gainput/GainputInputDevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,9 @@ class GAINPUT_LIBEXPORT InputDevice
/// Returns the device's previous state, probably best if only used internally.
InputState* GetPreviousInputState() { return previousState_; }

/// Returns the previously set dead zone for the given button or 0.0f if none was set yet.
float GetDeadZone(DeviceButtonId buttonId) const;
/// Sets the dead zone for the given button.
void SetDeadZone(DeviceButtonId buttonId, float value);

/// Enable/disable debug rendering of this device.
Expand Down
2 changes: 1 addition & 1 deletion lib/include/gainput/GainputInputDeviceBuiltIn.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ enum BuiltInButton

class InputDeviceBuiltInImpl;

/// An input device for inputs that are directly built into the executing device.
/// An input device for inputs that are directly built into the executing device (for example, sensors in a phone).
class GAINPUT_LIBEXPORT InputDeviceBuiltIn : public InputDevice
{
public:
Expand Down

0 comments on commit a6ee71d

Please sign in to comment.