The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

SANKO / SDL2-FFI-0.08 / lib / SDL2 / HapticEffect.pod 

            

              
—
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

              
=encoding utf-8
=head1 NAME
SDL2::HapticEffect - A generic template for a any haptic effect
=head1 SYNOPSIS
    use SDL2 qw[:all];
    # TODO: I need to whip up a quick example
=head1 DESCRIPTION
SDL2::HapticEffect is a C union which generalizes all known haptic effects.
All values max at C<32767> (C<0x7FFF>).  Signed values also can be negative.
Time values unless specified otherwise are in milliseconds.
You can also pass C<SDL_HAPTIC_INFINITY> to length instead of a C<0-32767>
value. Neither C<delay>, C<interval>, C<attack_length> nor C<fade_length>
support C<SDL_HAPTIC_INFINITY>. Fade will also not be used since effect never
ends.
Additionally, the C<SDL_HAPTIC_RAMP> effect does not support a duration of
C<SDL_HAPTIC_INFINITY>.
Button triggers may not be supported on all devices, it is advised to not use
them if possible. Buttons start at index C<1> instead of index C<0> like the
joystick.
If both C<attack_length> and C<fade_level> are C<0>, the envelope is not used,
otherwise both values are used.
Common parts:
=over
=item Replay - All effects have this
=over
=item C<length> - Duration of effect (ms).
=item C<delay> - Delay before starting effect.
=back
=item Trigger - All effects have this
=over
=item C<button> - Button that triggers effect.
=item C<interval> - How soon before effect can be triggered again.
=back
=item Envelope - All effects except condition effects have this
=over
=item C<attack_length> - Duration of the attack (ms).
=item C<attack_level> - Level at the start of the attack.
=item C<fade_length> - Duration of the fade out (ms).
=item C<fade_level> - Level at the end of the fade.
=back
=back
Here we have an example of a constant effect evolution in time:
    Strength
    ^
    |
    |    effect level -->  _________________
    |                     /                 \
    |                    /                   \
    |                   /                     \
    |                  /                       \
    | attack_level --> |                        \
    |                  |                        |  <---  fade_level
    |
    +--------------------------------------------------> Time
                       [--]                 [---]
                       attack_length        fade_length
    [------------------][-----------------------]
    delay               length
 Note either the C<attack_level> or the C<fade_level> may be above the actual
 effect level.
=head1 Fields
As a union, this object main contain the following structures:
=over
=item C<type> - Effect type
=item C<constant> - L<SDL2::HapticConstant>
=item C<periodic> - L<SDL2::HapticPeriodic>
=item C<condition> - L<SDL2::HapticCondition>
=item C<ramp> - L<SDL2::HapticRamp>
=item C<leftright> - L<SDL2::HapticLeftRight>
=item C<custom> - L<SDL2::HapticCustom>
=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
(ms)
=end stopwords
=cut