Enum ChunkCacheHint

pub enum ChunkCacheHint {
    NormalMode,
    UndoMode,
}

A performance/caching hint which determines how REAPER internally gets or sets a chunk.

Has implications on both performance and chunk content.

Variants

NormalMode

This takes longer but is the best choice for most situations.

UndoMode

This can be faster but has some drawbacks.

The following happens when using this mode:

• When getting a chunk, then FX configurations are cached, e.g. if the plug-in hasn’t recently notified REAPER of a parameter change, the last configuration state is returned (which is faster). The downside is if the plug-in doesn’t properly report its state as having changed, one wouldn’t get the latest version.
• When setting a chunk, envelope lane sizes will not be updated from the configuration state.
• The format in which FX GUIDs are encoded is slightly different in this mode (to facilitate more efficient re-use of existing plug-in instances).
• The logic in saving the event data for pooled MIDI items is slightly different (in undo mode only one of the items in the pool will encode, in normal mode the first instance in the chunk will get the data).

Trait Implementations

impl Clone for ChunkCacheHint

fn clone(&self) -> ChunkCacheHint

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChunkCacheHint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for ChunkCacheHint

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ChunkCacheHint

fn eq(&self, other: &ChunkCacheHint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ChunkCacheHint

impl Eq for ChunkCacheHint

impl StructuralPartialEq for ChunkCacheHint