A memory-cached sound that is played on-demand simulating a position in 3D-space. More...
Inheritance diagram for OmegaEngine.Audio.Sound3D:
Public Member Functions | |
| Sound3D (XSound sound) | |
| Sets up a new Sound based on an XSound asset. More... | |
| override void | StartPlayback (bool looping) |
| Starts the sound playback More... | |
| override void | StopPlayback () |
| Stops the sound playback More... | |
 Public Member Functions inherited from OmegaEngine.Audio.Sound | |
| Sound (XSound sound) | |
| Sets up a new Sound based on an XSound asset. More... | |
| Public Member Functions inherited from OmegaEngine.EngineElement | |
| void | Dispose () |
Protected Member Functions | |
| override void | OnDispose () |
| Hook that is called when the object needs to dispose its internal resources. | |
| Protected Member Functions inherited from OmegaEngine.Audio.Sound | |
| override void | OnEngineSet () |
| Hook that is calld when Engine is set for the first time. | |
| Protected Member Functions inherited from OmegaEngine.EngineElement | |
| void | RegisterChild (EngineElement element, bool autoDispose=true) |
| Registers a child EngineElement for automatic Engine setting and Dispose calling. More... | |
| void | UnregisterChild (EngineElement element) |
| Unregisters a child EngineElement (opposite of RegisterChild). More... | |
Properties | |
| DoubleVector3 | Position [get, set] |
| The sound's position in world space More... | |
| Properties inherited from OmegaEngine.Audio.Sound | |
| int | Volume [get, set] |
| > | |
| Properties inherited from OmegaEngine.EngineElement | |
| Engine | Engine [get, set] |
| The Engine instance used by this object. Must be set before using the object. May not be changed once it has been set! More... | |
| bool | IsDisposed [get] |
| Indicates whether this object has been disposed and can therefore no longer be used. More... | |
| Properties inherited from OmegaEngine.IAudio | |
| bool | Playing [get] |
| Is this sound currently being played? More... | |
| bool | Looping [get] |
| Is this sound set to loop? More... | |
| int | Volume [get, set] |
| The playback volume for the asset. More... | |
| Properties inherited from OmegaEngine.IPositionableOffset | |
| DoubleVector3 | Offset [get, set] |
| A value to be subtracted from IPositionable.Position in order gain IPositionableOffset.EffectivePosition More... | |
| Vector3 | EffectivePosition [get] |
| The sum of IPositionable.Position and IPositionableOffset.EffectivePosition More... | |
| Properties inherited from OmegaEngine.IPositionable | |
| DoubleVector3 | Position [get, set] |
| The object's position More... | |
Additional Inherited Members | |
| Public Attributes inherited from OmegaEngine.Audio.Sound | |
| bool | Playing => !SoundBuffer.Disposed && SoundBuffer.Status == BufferStatus.Playing |
| bool | Looping => !SoundBuffer.Disposed && SoundBuffer.Status == BufferStatus.Looping |
| Public Attributes inherited from OmegaEngine.EngineElement | |
| bool | IsEngineSet => _engine != null |
true if the Engine has been set. More... | |
| Protected Attributes inherited from OmegaEngine.Audio.Sound | |
| readonly XSound | Asset |
| A reference to the asset providing the data for this sound. More... | |
| SecondarySoundBuffer | SoundBuffer |
| The sound buffer containing the decoded data ready for playback. More... | |
Detailed Description
A memory-cached sound that is played on-demand simulating a position in 3D-space.
Constructor & Destructor Documentation
◆ Sound3D()
|
inline |
Sets up a new Sound based on an XSound asset.
- Parameters
-
sound The XSound asset to get the audio data from.
Member Function Documentation
◆ StartPlayback()
|
inlinevirtual |
Starts the sound playback
Reimplemented from OmegaEngine.Audio.Sound.
◆ StopPlayback()
|
inlinevirtual |
Stops the sound playback
Reimplemented from OmegaEngine.Audio.Sound.
Property Documentation
◆ Position
|
getset |
The sound's position in world space
The documentation for this class was generated from the following file:
- OmegaEngine/Audio/Sound3D.cs
