—

              
HideShow 67 lines of Pod
=encoding utf-8
=head1 NAME
SDL2::HapticRamp - A structure containing a template for a Ramp effect
=head1 SYNOPSIS
    use SDL2 qw[:all];
    # TODO: I need to whip up a quick example
=head1 DESCRIPTION
A SDL2::HapticRamp is exclusively for the C<SDL_HAPTIC_RAMP> effect.
The ramp effect starts at start strength and ends at end strength. It augments
in linear fashion.  If you use attack and fade with a ramp the effects get
added to the ramp effect making the effect become quadratic instead of linear.
=head1 Fields
=over
=item C<type> - C<SDL_HAPTIC_RAMP>
=item C<direction> - Direction of the effect - Not used ATM
=item C<length> - Duration of the effect
=item C<delay> - Delay before starting the effect
=item C<button> - Button that triggers the effect
=item C<interval> - How soon it can be triggered again after button
=item C<start> - Beginning strength level
=item C<end> - Ending strength level
=item C<attack_length> - Duration of the attack
=item C<attack_level> - Level at the start of the attack
=item C<fade_length> - Duration of the fade
=item C<fade_level> - Level at the end of the fade
=back
=head1 LICENSE
Copyright (C) Sanko Robinson.
This library is free software; you can redistribute it and/or modify it under
the terms found in the Artistic License 2. Other copyrights, terms, and
conditions may apply to data transmitted through this module.
=head1 AUTHOR
Sanko Robinson E<lt>sanko@cpan.orgE<gt>
=begin stopwords
=end stopwords
=cut