X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FCircularBuffer.html;h=2ebcde63b0cd8712d7c1a9b6c3967da8d3a7bd7c;hb=1352ca70c0b5c6b4ff3813b0c24354b5514b2796;hp=485899f130ee2d73ee3997ae24a04d58b060abb8;hpb=4ac8e928fb5e8ea7423f03a02edde998e1320921;p=poolifier.git diff --git a/docs/classes/CircularBuffer.html b/docs/classes/CircularBuffer.html index 485899f1..2ebcde63 100644 --- a/docs/classes/CircularBuffer.html +++ b/docs/classes/CircularBuffer.html @@ -1,5 +1,5 @@ -CircularBuffer | poolifier - v4.0.14

Class CircularBufferInternal

Circular buffer designed for positive numbers.

-

Constructors

constructor +CircularBuffer | poolifier - v4.0.15

Class CircularBufferInternal

Circular buffer designed for positive numbers.

+

Constructors

constructor

Properties

items maxArrayIdx readIdx @@ -15,16 +15,16 @@

Returns CircularBuffer

CircularBuffer.

Default Value

defaultBufferSize
-

Properties

Private Readonly items

items: Float32Array

Private Readonly maxArrayIdx

maxArrayIdx: number

Private readIdx

readIdx: number

size

size: number

Private writeIdx

writeIdx: number

Methods

Private checkSize

Properties

Private Readonly items

items: Float32Array

Private Readonly maxArrayIdx

maxArrayIdx: number

Private readIdx

readIdx: number

size

size: number

Private writeIdx

writeIdx: number

Methods

Private checkSize

  • checkSize(size): void

  • Checks the buffer size.

    Parameters

    • size: number

      Buffer size.

      -

    Returns void

empty

  • empty(): boolean

  • Checks whether the buffer is empty.

    +

Returns void

empty

  • empty(): boolean

  • Checks whether the buffer is empty.

    Returns boolean

    Whether the buffer is empty.

    -

full

full

  • full(): boolean

  • Checks whether the buffer is full.

    Returns boolean

    Whether the buffer is full.

    -

get

get

  • get(): undefined | number

  • Gets number from buffer.

    Returns undefined | number

    Number from buffer.

    -

put

put

  • put(number): void

  • Puts number into buffer.

    Parameters

    • number: number

      Number to put into buffer.

      -

    Returns void

toArray

  • toArray(): number[]

  • Returns buffer as numbers' array.

    +

Returns void

toArray

Settings

Member Visibility

Theme

On This Page

constructoritemsmaxArrayIdxreadIdxsizewriteIdxcheckSizeemptyfullgetputtoArray
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoritemsmaxArrayIdxreadIdxsizewriteIdxcheckSizeemptyfullgetputtoArray
\ No newline at end of file