author Edgar Simo <>
Mon, 30 Jun 2008 17:28:34 +0000
changeset 2478 4fd783e0f34b
parent 2477 97f75ea43a93
child 2480 b883974445fc
permissions -rw-r--r--
Added query functions for haptic devices.

    SDL - Simple DirectMedia Layer
    Copyright (C) 2008 Edgar Simo

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    Sam Lantinga

 * \file SDL_haptic.h
 * Include file for SDL haptic subsystem

#ifndef _SDL_haptic_h
#define _SDL_haptic_h

#include "SDL_stdinc.h"
#include "SDL_error.h"

#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
extern "C" {
   /* *INDENT-ON* */                                                         

/* The haptic structure used to identify an SDL haptic */
struct _SDL_Haptic;                                                     
typedef struct _SDL_Haptic SDL_Haptic;

/* Different effects that can be generated */
#define SDL_HAPTIC_CONSTANT   (1<<0)
#define SDL_HAPTIC_PERIODIC   (1<<1)
#define SDL_HAPTIC_RAMP       (1<<2)
#define SDL_HAPTIC_SPRING     (1<<3)
#define SDL_HAPTIC_FRICTION   (1<<4)
#define SDL_HAPTIC_DAMPER     (1<<5)
#define SDL_HAPTIC_RUMBLE     (1<<6)
#define SDL_HAPTIC_INERTIA    (1<<7)
#define SDL_HAPTIC_GAIN       (1<<8)

typedef struct SDL_HapticConstant {
   /* Header */
   Uint16 type;
   Uint16 length;
   Uint16 delay;
   Uint16 direction;
} SDL_HapticConstant;

typedef union SDL_HapticEffect {
   /* Common for all force feedback effects */
   Uint16 type; /* Effect type */
   SDL_HapticConstant constant; /* Constant effect */
} SDL_HapticEffect;

/* Function prototypes */
 * Count the number of joysticks attached to the system
extern DECLSPEC int SDLCALL SDL_NumHaptics(void);

 * Get the implementation dependent name of a Haptic device.
 * This can be called before any joysticks are opened.
 * If no name can be found, this function returns NULL.
extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);

 * Opens a Haptic device for usage - the index passed as an
 * argument refers to the N'th Haptic device on this system.
 * This function returns a Haptic device identifier, or Null
 * if an error occurred.
extern DECLSPEC SDL_Haptic * SDL_HapticOpen(int device_index);

 * Closes a Haptic device previously opened with SDL_HapticOpen.
extern DECLSPEC void SDL_HapticClose(SDL_Haptic * haptic);

 * Returns the number of effects a haptic device can store.
extern DECLSPEC int SDL_HapticNumEffects(SDL_Haptic * haptic);

 * Returns the supported effects.  Individual effects can be queried by
 * bitwise operators.
 * Example:  (SDL_HapticQueryEffects(haptic) & SDL_HAPTIC_CONSTANT)
extern DECLSPEC unsigned int SDL_HapticQueryEffects(SDL_Haptic * haptic);

 * Creates a new haptic effect on the device.
extern DECLSPEC int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect);

 * Runs the haptic effect on it's assosciated haptic device.
extern DECLSPEC int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect);

 * Destroys a haptic effect on the device.
extern DECLSPEC void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect);

/* Ends C function definitions when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
/* *INDENT-ON* */
#include "close_code.h"

#endif /* _SDL_haptic_h */

/* vi: set ts=4 sw=4 expandtab: */