summaryrefslogtreecommitdiff
path: root/doc/classes/AudioStreamGeneratorPlayback.xml
AgeCommit message (Collapse)Author
2022-09-10Update AudioStreamGeneratorPlayback.xmlFireflash
Fixed incorrect method description for `get_frames_available`. According to [The AudioStreamGenerator source](https://github.com/godotengine/godot/blob/master/servers/audio/effects/audio_stream_generator.cpp#L132), the `get_frames_available` method should return the space remaining in the sample buffer.
2022-08-12[doc] Use "param" instead of "code" to refer to parameters (8)Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-03-09Remove unused GDNative codeRémi Verschelde
This has been superseded by GDExtension so this code is no longer useful nor usable. There's still some GDNative-related stuff in platform export code which needs to be adapted for GDExtension (e.g. to include GDExtension libraries in exports).
2022-02-15Add an XML schema for documentationHugo Locurcio
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-01-31Fixes invalid links to tutorials in AudioStreamGenerator, ↵Ev01
AudioStreamGeneratorPlayback, and AudioEffectSpectrumAnalyzer class references
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-05-15Improve AudioStreamGenerator and AudioEffectSpectrumAnalyzer documentationHugo Locurcio
- Mention audio sample rate caveats in other classes where relevant.
2020-08-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-02-18doc: Sync classref with current sourceRémi Verschelde
Handle removal of Pool*Array types and other recent changes.
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2019-08-31Improve AudioStreamSample and AudioStreamGenerator documentationHugo Locurcio
- Add a link to the audio generator demo in AudioStreamGenerator and AudioStreamGeneratorPlayback. - Mention that signed PCM8 data is expected in AudioStreamSample (and how to convert unsigned PCM8 to signed PCM8).
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-15doc: Sync classref with current sourceRémi Verschelde