libElysianVMU 1.6.0
Full-featured, accurate, cross-platform library emulating the Dreamcast's Visual Memory Unit
Loading...
Searching...
No Matches
Data Fields
EvmuBuzzer Struct Reference
Peripherals

#include <evmu_buzzer.h>

Inheritance diagram for EvmuBuzzer:
EvmuPeripheral EvmuIBehavior

Data Fields

union { 
 
   EvmuBuzzerClass *   pClass 
 
   EvmuPeripheral   base 
 
};  
 
GblBool pcmChanged
 
GblBool enableFreqResp
 
- Data Fields inherited from EvmuPeripheral
union { 
 
   EvmuPeripheralClass *   pClass 
 
   GblObject   base 
 
};  
 
GblFlags logLevel
 

Related Symbols

(Note that these are not member symbols.)

Configuration

Methods for managing buzzer configuration

GblBool EvmuBuzzer_isActive (const EvmuBuzzer *pSelf)
 
GblBool EvmuBuzzer_isConfigured (const EvmuBuzzer *pSelf)
 
GblBool EvmuBuzzer_isEnabled (const EvmuBuzzer *pSelf)
 
void EvmuBuzzer_setEnabled (EvmuBuzzer *pSelf, GblBool en)
 
Tone Playback

Methods for managing tone generation and playback

void EvmuBuzzer_tone (const EvmuBuzzer *pSelf, uint16_t *pPeriod, uint8_t *pInvPulseLen)
 
EVMU_RESULT EvmuBuzzer_setTone (EvmuBuzzer *pSelf, uint16_t period, uint8_t invPulseLen)
 
EVMU_RESULT EvmuBuzzer_playTone (EvmuBuzzer *pSelf)
 
EVMU_RESULT EvmuBuzzer_stopTone (EvmuBuzzer *pSelf)
 
PCM Back-End

Methods used to implement an audio driver back-end

const void * EvmuBuzzer_pcmBuffer (const EvmuBuzzer *pSelf)
 
size_t EvmuBuzzer_pcmSamples (const EvmuBuzzer *pSelf)
 
size_t EvmuBuzzer_pcmFrequency (const EvmuBuzzer *pSelf)
 
float EvmuBuzzer_pcmGain (const EvmuBuzzer *pSelf)
 
- Related Symbols inherited from EvmuPeripheral
 

Detailed Description

Instance structure for Buzzer Peripheral.

EvmuBuzzer is the GblInstance structure representing the piezoelectric buzzer peripheral and associated logic.

See also
EvmuBuzzerClass

Definition at line 84 of file evmu_buzzer.h.

Friends And Related Symbol Documentation

◆ EvmuBuzzer_isActive()

GblBool EvmuBuzzer_isActive ( const EvmuBuzzer * pSelf)
related

Returns whether playback is active or not.

◆ EvmuBuzzer_isConfigured()

GblBool EvmuBuzzer_isConfigured ( const EvmuBuzzer * pSelf)
related

Returns whether the buzzer has been configured for playback.

◆ EvmuBuzzer_isEnabled()

GblBool EvmuBuzzer_isEnabled ( const EvmuBuzzer * pSelf)
related

Returns whether software has enabled or disabled the buzzer.

◆ EvmuBuzzer_pcmBuffer()

const void * EvmuBuzzer_pcmBuffer ( const EvmuBuzzer * pSelf)
related

Returns the current PCM buffer to the audio driver.

◆ EvmuBuzzer_pcmFrequency()

size_t EvmuBuzzer_pcmFrequency ( const EvmuBuzzer * pSelf)
related

Returns the PCM buffer's sample frequency to the audio driver.

◆ EvmuBuzzer_pcmGain()

float EvmuBuzzer_pcmGain ( const EvmuBuzzer * pSelf)
related

Returns the PCM buffer's gain to the audio driver.

◆ EvmuBuzzer_pcmSamples()

size_t EvmuBuzzer_pcmSamples ( const EvmuBuzzer * pSelf)
related

Returns the PCM buffer's sample size to the audio driver.

◆ EvmuBuzzer_playTone()

EVMU_RESULT EvmuBuzzer_playTone ( EvmuBuzzer * pSelf)
related

Plays the current tone's square wave.

◆ EvmuBuzzer_setEnabled()

void EvmuBuzzer_setEnabled ( EvmuBuzzer * pSelf,
GblBool en )
related

Allows software to enable or disable buzzer emulation.

◆ EvmuBuzzer_setTone()

EVMU_RESULT EvmuBuzzer_setTone ( EvmuBuzzer * pSelf,
uint16_t period,
uint8_t invPulseLen )
related

Sets the square wave of the current tone without impacting playback.

◆ EvmuBuzzer_stopTone()

EVMU_RESULT EvmuBuzzer_stopTone ( EvmuBuzzer * pSelf)
related

Stops playback of the current tone.

◆ EvmuBuzzer_tone()

void EvmuBuzzer_tone ( const EvmuBuzzer * pSelf,
uint16_t * pPeriod,
uint8_t * pInvPulseLen )
related

Returns the current tone's square wave.

Field Documentation

◆ base

EvmuPeripheral EvmuBuzzer::base

Inherited base instance structure.

Definition at line 84 of file evmu_buzzer.h.

◆ enableFreqResp

GblBool EvmuBuzzer::enableFreqResp

Enables per-tone gain/volume emulation.

Definition at line 86 of file evmu_buzzer.h.

◆ pClass

EvmuBuzzerClass* EvmuBuzzer::pClass

Pointer to class/vtable structure.

Definition at line 84 of file evmu_buzzer.h.

◆ pcmChanged

GblBool EvmuBuzzer::pcmChanged

User-toggle for polling updates.

Definition at line 85 of file evmu_buzzer.h.

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