wavelength 1.0.0
Loading...
Searching...
No Matches
BankSampleDesc Class Reference

A sample descriptor loaded into a bank, linked to the sample it plays. More...

#include <banksampledesc.h>

Inheritance diagram for BankSampleDesc:
Collaboration diagram for BankSampleDesc:

Public Member Functions

void Dump () const
 Print the descriptor and its sample to the console.
void Init ()
 Reset the descriptor and clear its sample.
Sample * GetSample () const
 Report the sample the descriptor plays.
Public Member Functions inherited from SampleDesc
 SampleDesc ()
 Construct a descriptor with the defaults Init() sets.
void Init ()
 Reset every field to its default.
int Pack (unsigned char *data) const
 Write the descriptor as a serialised record of version 3.
int PackedSize () const
 Report the size of a serialised record of version 3.
int Unpack (const unsigned char *data)
 Read the descriptor from a serialised record of version 1, 2, or 3.
void Validate ()
 Check the descriptor after Unpack().
void Dump () const
 Print every field to the console.

Public Attributes

Sample * mSample
Public Attributes inherited from SampleDesc
unsigned char mLowKeymap
unsigned char mHighKeymap
unsigned char mBaseKey
signed char mTranspose
signed char mFineTranspose
unsigned char mAttackRate
unsigned short mAttackMode
unsigned char mDecayRate
unsigned char mSusLevel
unsigned char mSusRate
unsigned short mSusMode
unsigned char mReleaseRate
unsigned short mReleaseMode
unsigned char mVolume
unsigned char mPan
unsigned short mSampleIndex
unsigned short mBus
unsigned short mBusMode
signed char mSurround

Detailed Description

A sample descriptor loaded into a bank, linked to the sample it plays.

The class has no RTTI, and its name is inferred from its role. The descriptor pool hands out raw storage. The constructor never runs, and Init() prepares each descriptor.

Member Function Documentation

◆ Dump()

void BankSampleDesc::Dump ( ) const

Print the descriptor and its sample to the console.

Ghidra address:
NTSC-U/C: 0x00001e70
Ghidra address:
PAL: 0x00001e70

◆ Init()

void BankSampleDesc::Init ( )

Reset the descriptor and clear its sample.

Ghidra address:
NTSC-U/C: 0x00001eac
Ghidra address:
PAL: 0x00001eac

◆ GetSample()

Sample * BankSampleDesc::GetSample ( ) const

Report the sample the descriptor plays.

Returns
The sample, or null before the bank links one.
Ghidra address:
NTSC-U/C: 0x00002094
Ghidra address:
PAL: 0x00002094

Member Data Documentation

◆ mSample

Sample* BankSampleDesc::mSample

The sample mSampleIndex selects, once the bank links it.


The documentation for this class was generated from the following file: