Categorygithub.com/oakmound/oak/v4shake
package
4.1.1
Repository: https://github.com/oakmound/oak.git
Documentation: pkg.go.dev
Versions
1
Dependencies
7
Dependents
1
Files
102 SLOC

# README

shake

The shake package helps one "shake", or quickly move back-and-forth, things.

One can shake the screen via shake.Screen(ctx, time.Second), or shake anything that has a ShiftPos function with shake.Shake(...). Both of these package functions build on the shake.Shaker type, which has some settings for configuring how a thing is shaken.

# Functions

Screen shakes the screen that the context controls for the given duration.
Shake shakes a ShiftPoser for the given duration.

# Variables

DefaultShaker is the global default shaker, used when shake.Screen or shake.Shake are called.

# Structs

A Shaker knows how to shake something by a (or up to a) given magnitude.

# Interfaces

A ShiftPoser can have its position shifted by an x,y pair.