mirror of
https://github.com/curioustorvald/Terrarum.git
synced 2026-06-09 10:04:05 +09:00
PostProcessor working: nested FBO won't work, use FrameBufferManager
This commit is contained in:
27
work_files/usermanuals/romapidoc/api_speaker.tex
Normal file
27
work_files/usermanuals/romapidoc/api_speaker.tex
Normal file
@@ -0,0 +1,27 @@
|
||||
The Speaker API provides means to control computer's built-in beeper speaker.
|
||||
|
||||
\section{Functions}
|
||||
|
||||
\begin{tabularx}{\textwidth}{l l X}
|
||||
\textbf{\large Function} & \textbf{\large Return} & \textbf{\large Description}
|
||||
\\ \\
|
||||
\endhead
|
||||
speaker.enqueue(len: int, freq: num\footnote{Frequency in hertz (double) or the name of the note (``A-5'', ``B3'', ``F\#2'', ``Db6'', \ldots)}) & nil & Enqueues speaker driving information. Queues will be started automatically.
|
||||
\\ \\
|
||||
speaker.clear() & nil & Clears speaker queue.
|
||||
\\ \\
|
||||
speaker.retune(str or nil) & nil & Retunes speaker to specified tuning (e.g. ``A415'', ``C256'', ``A\#440''). If no argument is given, A440 will be used.
|
||||
\\ \\
|
||||
speaker.resetTune() & nil & Retunes speaker to A440.
|
||||
\\ \\
|
||||
speaker.toFreq(string) & int & Translates input note name to matching frequency based on current speaker tunining.
|
||||
\end{tabularx}
|
||||
|
||||
\section{Constants}
|
||||
|
||||
\begin{tabularx}{\textwidth}{l l X}
|
||||
\textbf{\large Name} & \textbf{\large Type} & \textbf{\large Description}
|
||||
\\ \\
|
||||
\endhead
|
||||
speaker.\_\_basefreq\_\_ & number & Frequency of note A-0.
|
||||
\end{tabularx}
|
||||
Reference in New Issue
Block a user