Mercurial > sdl-ios-xcode

comparison include/SDL_haptic.h @ 2511:f12ae0bae468 gsoc2008_force_feedback

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed bugs in documentation. Improved code correctness a bit.
author Edgar Simo <bobbens@gmail.com>
date Wed, 09 Jul 2008 18:29:11 +0000
parents 8ef1d0f4d0c1
children ef147ee4896c
comparison
equal deleted inserted replaced
2510:e6ad7e678fca 2511:f12ae0bae468
304 * \endcode 304 * \endcode
305 * 305 *
306 * If type is SDL_HAPTIC_POLAR, direction is encoded by hundredths of a 306 * If type is SDL_HAPTIC_POLAR, direction is encoded by hundredths of a
307 * degree starting north and turning clockwise. The cardinal directions would be: 307 * degree starting north and turning clockwise. The cardinal directions would be:
308 * - North: 0 (0 degrees) 308 * - North: 0 (0 degrees)
309 * - West: 9000 (90 degrees) 309 * - East: 9000 (90 degrees)
310 * - South: 18000 (180 degrees) 310 * - South: 18000 (180 degrees)
311 * - East: 27000 (270 degrees) 311 * - West: 27000 (270 degrees)
312 * 312 *
313 * If type is SDL_HAPTIC_CARTESIAN, direction is encoded by position. 313 * If type is SDL_HAPTIC_CARTESIAN, direction is encoded by position.
314 * The cardinal directions would be: 314 * The cardinal directions would be:
315 * - North: 0,-1 315 * - North: 0,-1
316 * - West: -1, 0 316 * - East: -1, 0
317 * - South: 0, 1 317 * - South: 0, 1
318 * - East: 1, 0 318 * - West: 1, 0
319 * 319 *
320 * 320 *
321 * Example: 321 * Example:
322 * \code 322 * \code
323 * SDL_HapticDirection direction; 323 * SDL_HapticDirection direction;
324 * 324 *
325 * direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding. 325 * direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding.
326 * direction.dir = 180000; // Force comes from the south meaning the user will 326 * direction.dir = 18000; // Force comes from the south meaning the user will
327 * // have to pull the stick to counteract. 327 * // have to pull the stick to counteract.
328 * \endcode 328 * \endcode
329 * 329 *
330 * \sa SDL_HAPTIC_POLAR 330 * \sa SDL_HAPTIC_POLAR
331 * \sa SDL_HAPTIC_CARTESIAN 331 * \sa SDL_HAPTIC_CARTESIAN