Arcade
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
GameAPI.Peripheral< TGame, TProvider, TImplementation > Class Template Reference

Base class for hardware input and output devices. More...

Inheritance diagram for GameAPI.Peripheral< TGame, TProvider, TImplementation >:
GameAPI.Peripheral GameAPI.AudioBase< TGame, TImplementation > GameAPI.ControlsBase< TGame, TImplementation > GameAPI.FirmwareBase< TGame, TImplementation > GameAPI.GraphicsBase< TGame, TImplementation > GameAPI.BudgetBoy.Audio GameAPI.BudgetBoy.Controls GameAPI.BudgetBoy.Firmware GameAPI.BudgetBoy.Graphics

Public Member Functions

override void Dispose ()
 

Protected Member Functions

override void OnInitialize ()
 
virtual void OnAttachImplementation ()
 
- Protected Member Functions inherited from GameAPI.Peripheral
void ClearFrameWriter ()
 
virtual void OnRegisterResourceTypes (ResourceManager library)
 
virtual void OnLoadResources (Resources volume)
 
virtual void OnReset ()
 
virtual void OnDeserializeSetup (Stream stream)
 
virtual void OnSerializeSetup (Stream stream)
 
virtual void OnStartControlling ()
 
virtual void OnStopControlling ()
 
virtual void OnDeserializeFrame (Stream stream)
 
virtual void OnUpdateFrame (double dt)
 
virtual void OnSerializeFrame (Stream stream)
 
virtual void OnCopyFrame (Stream stream)
 

Properties

virtual bool ShouldUpdate [get]
 
- Properties inherited from GameAPI.Peripheral
BinaryWriter FrameWriter [get]
 

Detailed Description

Base class for hardware input and output devices.

Template Parameters
TProviderType of an IProvider that handles communication between a Peripheral instance and the actual (virtual) hardware implementation.
Type Constraints
TGame :GameBase 
TProvider :Provider<TProvider> 
TImplementation :PeripheralImplementation<TProvider> 
TImplementation :new() 

Member Function Documentation

override void GameAPI.Peripheral< TGame, TProvider, TImplementation >.Dispose ( )
inlinevirtual

Reimplemented from GameAPI.Peripheral.

virtual void GameAPI.Peripheral< TGame, TProvider, TImplementation >.OnAttachImplementation ( )
inlineprotectedvirtual
override void GameAPI.Peripheral< TGame, TProvider, TImplementation >.OnInitialize ( )
inlineprotectedvirtual

Reimplemented from GameAPI.Peripheral.

Reimplemented in GameAPI.BudgetBoy.Graphics, and GameAPI.BudgetBoy.Controls.

Property Documentation

virtual bool GameAPI.Peripheral< TGame, TProvider, TImplementation >.ShouldUpdate
getprotected