linux-joystick.h

Go to the documentation of this file.

/*
 * linux-joystick.h
 *
 * Copyright (C) 2009,2011  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Library to expose gamepad devices through the linux joystick APIs.
 */

#ifndef GAMEPAD_LINUX_JOYSTICK_H__
#define GAMEPAD_LINUX_JOYSTICK_H__

// includes --------------------------------------------------------------------
#include "source-device/source-device.h"
#include "threadsafe/smart_ptr.h"


namespace gamepad {


/// \ingroup source_device
/// \defgroup linux_joystick Linux Joystick Gamepad Devices
///
/// APIs to provide gamepad::SourceDevice objects based on the linux joystick
/// event model (see the header file /usr/include/linux/joystick.h). 
/*@{*/


/// Use this method to create a gamepad::SourceDeviceFactory object capable of
///     providing SourceDevice objects from the linux joystick API.
smart_ptr<SourceDeviceFactory> getLinuxJoystickSourceDeviceFactory(void);


};      // gamepad namespace

#endif  // GAMEPAD_LINUX_JOYSTICK_H__