Navigation
API > API/Runtime > API/Runtime/Engine
Class for utilizing memory in the stream cache budget for an unrelated, temporary audio-based feature. Allows us to borrow from budgeted memory for audio features that would otherwise not fit in the overall memory budget.
Usage:
- Create an instance of this class on an object or subsystem where want to track memory usage
- Memory usage will immediately be taken out of the Audio Stream Cache budget on construction of the object
- Update memory usage via this class as necessary.
- Deleting the instance will automatically reset the memory usage to 0
| Name | FAudioStreamCacheMemoryHandle |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/AudioStreamCacheMemoryHandle.h |
| Include Path | #include "AudioStreamCacheMemoryHandle.h" |
Syntax
class FAudioStreamCacheMemoryHandle : public FNoncopyable
Inheritance Hierarchy
- FNoncopyable → FAudioStreamCacheMemoryHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAudioStreamCacheMemoryHandle
(
FName InFeatureName, |
AudioStreamCacheMemoryHandle.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FAudioStreamCacheMemoryHandle() |
AudioStreamCacheMemoryHandle.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FeatureName | const FName | AudioStreamCacheMemoryHandle.h | ||
| MemoryUseInBytes | uint64 | AudioStreamCacheMemoryHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FName GetFeatureName() |
AudioStreamCacheMemoryHandle.h | ||
uint64 GetMemoryUseInBytes() |
AudioStreamCacheMemoryHandle.h | ||
void ResetMemoryUseInBytes
(
uint64 InMemoryUseInBytes |
AudioStreamCacheMemoryHandle.h |