|
Size: 4692
Comment: update formatting - categories
|
Size: 4610
Comment: update formatting
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 6: | Line 6: |
| A structure that contains a template for a Periodic effect. | A structure that contains a template for a periodic effect. |
| Line 11: | Line 11: |
| <<Color2(green,Section title formats should be adjusted to match [[SDL_HapticConstant]] once a final format is decided.)>> ||||||'''''Header'''''|| |
||||||''Header''|| |
| Line 15: | Line 14: |
| ||||||'''''Replay'''''|| | ||||||''Replay''|| |
| Line 18: | Line 17: |
| ||||||'''''Trigger'''''|| | ||||||''Trigger''|| |
| Line 20: | Line 19: |
| ||Uint16||'''interval'''||how soon it can be triggered again after button ^(delay between individual waves or before the effect can be used again?)^ ^(ms?)^|| ||||||'''''Periodic'''''|| |
||Uint16||'''interval'''||how soon it can be triggered again after '''button''' ^(delay between individual waves or before the effect can be used again?)^ ^(ms?)^|| ||||||''Periodic''|| |
| Line 26: | Line 25: |
| ||||||'''''Envelope'''''|| | ||||||''Envelope''|| |
| Line 91: | Line 90: |
| <<Color2(green,For some reason when these are interpreted in the code box the angle of the slashes is changed and they look funny. Don't know how to fix that.)>> | <<Color2(green,For some reason when these are interpreted in the code box the angle of the slashes is changed and they look funny. Don't know how to fix that unless there is a way to change font or if we use an actual image.)>> |
DRAFT |
SDL_HapticPeriodic
A structure that contains a template for a periodic effect.
Data Fields
Header |
||
Uint16 |
type |
the shape of the waves one of the effects handled by this structure; see Remarks for details |
direction |
direction of the effect (relative to the user) |
|
Replay |
||
Uint32 |
length |
duration of the effect (is this the same as # of cycles? always in ms?) |
Uint16 |
delay |
delay before starting the effect (ms?) |
Trigger |
||
Uint16 |
button |
button that triggers the effect |
Uint16 |
interval |
how soon it can be triggered again after button (delay between individual waves or before the effect can be used again?) (ms?) |
Periodic |
||
Uint16 |
period |
period of the wave (like frequency, duration from start to start?) (ms?) |
Sint16 |
magnitude |
peak value (like amplitude?) (units?) |
Sint16 |
offset |
mean value of the wave (what aspect of the wave is being offset from what other marker? Is this the distance between waves?) |
Uint16 |
phase |
horizontal shift given by hundredths of a cycle; see Remarks for details (what is being shifted? Is this what creates the flat tops? What is the definition of a cycle, 1 sec?) |
Envelope |
||
Uint16 |
attack_length |
duration of the attack (ms?) |
Uint16 |
attack_level |
level at the start of the attack (units?) |
Uint16 |
fade_length |
duration of the fade (ms?) |
Uint16 |
fade_level |
level at the end of the fade (units?) |
Code Examples
You can add your code example here
Remarks
green
A periodic effect consists of a wave-shaped effect that repeats itself over time. The type determines the shape of the wave and the other parameters determine the dimensions of the wave.
button period
press | |
|| __ __ __ __ __ _
|| | | | | | | | | | | magnitude
\/ | |__| |__| |__| |__| | _
-----
| offset?
delay phase?
-------------------------------------
length
===================================================
intervalgreen
type may be one of the following:
SDL_HAPTIC_SINE |
SDL_HAPTIC_SQUARE |
SDL_HAPTIC_TRIANGLE |
SDL_HAPTIC_SAWTOOTHUP |
SDL_HAPTIC_SAWTOOTHDOWN |
- Examples:
SDL_HAPTIC_SINE __ __ __ __ / \ / \ / \ / / \__/ \__/ \__/ SDL_HAPTIC_SQUARE __ __ __ __ __ | | | | | | | | | | | |__| |__| |__| |__| | SDL_HAPTIC_TRIANGLE /\ /\ /\ /\ /\ / \ / \ / \ / \ / / \/ \/ \/ \/ SDL_HAPTIC_SAWTOOTHUP /| /| /| /| /| /| /| / | / | / | / | / | / | / | / |/ |/ |/ |/ |/ |/ | SDL_HAPTIC_SAWTOOTHDOWN \ |\ |\ |\ |\ |\ |\ | \ | \ | \ | \ | \ | \ | \ | \| \| \| \| \| \| \|
green
phase is given by hundredths of a cycle, meaning that giving the phase a value of 9000 will displace it 25% of it's period. Here are sample values:
0 |
No phase displacement |
9000 |
Displaced 25% of it's period |
18000 |
Displaced 50% of it's period |
27000 |
Displaced 75% of it's period |
36000 |
Displaced 100% of it's period, same as 0, but 0 is preferred |
<<Color2(green,This is not at all clear unless it is a common thing that a programmer would know. Is phase describing the duration of an individual wave from start to finish or the duration from the start of one wave to the start of the next?
Related Structures
