# [−][src]Struct valora::prelude::Fbm

Noise function that outputs fBm (fractal Brownian motion) noise.

fBm is a *monofractal* method. In essence, fBm has a *constant* fractal
dimension. It is as close to statistically *homogeneous* and *isotropic*
as possible. Homogeneous means "the same everywhere" and isotropic means
"the same in all directions" (note that the two do not mean the same
thing).

The main difference between fractal Brownian motion and regular Brownian motion is that while the increments in Brownian motion are independent, the increments in fractal Brownian motion depend on the previous increment.

fBm is the result of several noise functions of ever-increasing frequency and ever-decreasing amplitude.

fBm is commonly referred to as Perlin noise.

## Fields

`octaves: usize`

Total number of frequency octaves to generate the noise with.

The number of octaves control the *amount of detail* in the noise
function. Adding more octaves increases the detail, with the drawback
of increasing the calculation time.

`frequency: f64`

The number of cycles per unit length that the noise function outputs.

`lacunarity: f64`

A multiplier that determines how quickly the frequency increases for each successive octave in the noise function.

The frequency of each successive octave is equal to the product of the previous octave's frequency and the lacunarity value.

A lacunarity of 2.0 results in the frequency doubling every octave. For almost all cases, 2.0 is a good value to use.

`persistence: f64`

A multiplier that determines how quickly the amplitudes diminish for each successive octave in the noise function.

The amplitude of each successive octave is equal to the product of the previous octave's amplitude and the persistence value. Increasing the persistence produces "rougher" noise.

## Methods

`impl Fbm`

[src]

`pub const `**DEFAULT_SEED**: u32

[src]

**DEFAULT_SEED**: u32

`pub const `**DEFAULT_OCTAVE_COUNT**: usize

[src]

**DEFAULT_OCTAVE_COUNT**: usize

`pub const `**DEFAULT_FREQUENCY**: f64

[src]

**DEFAULT_FREQUENCY**: f64

`pub const `**DEFAULT_LACUNARITY**: f64

[src]

**DEFAULT_LACUNARITY**: f64

`pub const `**DEFAULT_PERSISTENCE**: f64

[src]

**DEFAULT_PERSISTENCE**: f64

`pub const `**MAX_OCTAVES**: usize

[src]

**MAX_OCTAVES**: usize

`pub fn new() -> Fbm`

[src]

## Trait Implementations

`impl Clone for Fbm`

[src]

`impl Debug for Fbm`

[src]

`impl Default for Fbm`

[src]

`impl MultiFractal for Fbm`

[src]

`fn set_octaves(self, octaves: usize) -> Fbm`

[src]

`fn set_frequency(self, frequency: f64) -> Fbm`

[src]

`fn set_lacunarity(self, lacunarity: f64) -> Fbm`

[src]

`fn set_persistence(self, persistence: f64) -> Fbm`

[src]

`impl NoiseFn<[f64; 2]> for Fbm`

[src]

2-dimensional Fbm noise

`impl NoiseFn<[f64; 3]> for Fbm`

[src]

3-dimensional Fbm noise

`impl NoiseFn<[f64; 4]> for Fbm`

[src]

4-dimensional Fbm noise

`impl Seedable for Fbm`

[src]

## Auto Trait Implementations

`impl RefUnwindSafe for Fbm`

`impl Send for Fbm`

`impl Sync for Fbm`

`impl Unpin for Fbm`

`impl UnwindSafe for Fbm`

## Blanket Implementations

`impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where`

D: AdaptFrom<S, Swp, Dwp, T>,

Dwp: WhitePoint,

Swp: WhitePoint,

T: Component + Float,

[src]

D: AdaptFrom<S, Swp, Dwp, T>,

Dwp: WhitePoint,

Swp: WhitePoint,

T: Component + Float,

`fn adapt_into_using<M>(self, method: M) -> D where`

M: TransformMatrix<Swp, Dwp, T>,

[src]

M: TransformMatrix<Swp, Dwp, T>,

`fn adapt_into(self) -> D`

[src]

`impl<T> Any for T where`

T: 'static + ?Sized,

[src]

T: 'static + ?Sized,

`impl<T> Borrow<T> for T where`

T: ?Sized,

[src]

T: ?Sized,

`impl<T> BorrowMut<T> for T where`

T: ?Sized,

[src]

T: ?Sized,

`fn borrow_mut(&mut self) -> &mut T`

[src]

`impl<T, U> ConvertInto<U> for T where`

U: ConvertFrom<T>,

[src]

U: ConvertFrom<T>,

`fn convert_into(self) -> U`

[src]

`fn convert_unclamped_into(self) -> U`

[src]

`fn try_convert_into(self) -> Result<U, OutOfBounds<U>>`

[src]

`impl<T> From<T> for T`

[src]

`impl<T, U> Into<U> for T where`

U: From<T>,

[src]

U: From<T>,

`impl<T> Same<T> for T`

`type Output = T`

Should always be `Self`

`impl<T> SetParameter for T`

`fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where`

T: Parameter<Self>,

T: Parameter<Self>,

`impl<T> SetParameter for T`

`fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where`

T: Parameter<Self>,

T: Parameter<Self>,

`impl<SS, SP> SupersetOf<SS> for SP where`

SS: SubsetOf<SP>,

SS: SubsetOf<SP>,

`fn to_subset(&self) -> Option<SS>`

`fn is_in_subset(&self) -> bool`

`unsafe fn to_subset_unchecked(&self) -> SS`

`fn from_subset(element: &SS) -> SP`

`impl<T> ToOwned for T where`

T: Clone,

[src]

T: Clone,

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`

[src]

`fn clone_into(&self, target: &mut T)`

[src]

`impl<T, U> TryFrom<U> for T where`

U: Into<T>,

[src]

U: Into<T>,

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

`impl<T, U> TryInto<U> for T where`

U: TryFrom<T>,

[src]

U: TryFrom<T>,

`type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

`impl<V, T> VZip<V> for T where`

V: MultiLane<T>,

V: MultiLane<T>,