Navigation
API > API/Plugins > API/Plugins/AVCodecsCore
Base wrapper for an immutable device resource. Bundles necessary data that may not be easily retrieved on without an RHI, such as size on device. If the underlying device resource must change, this resource wrapper must be recreated.
| Name | FAVResource |
| Type | class |
| Header File | /Engine/Plugins/Experimental/AVCodecs/AVCodecsCore/Source/AVCodecsCore/Public/AVResource.h |
| Include Path | #include "AVResource.h" |
Syntax
class FAVResource
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAVResource
(
TSharedRef< FAVDevice > const& Device, |
AVResource.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAVResource() |
AVResource.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Device | TSharedRef< FAVDevice > | Reference to parent device. Must exist. | AVResource.h | |
| Layout | FAVLayout | Layout of data in device memory. | AVResource.h | |
| Mappings | TTypeMap< void > | All mappings of this resource into other resources (or other objects), ensuring appropriate cleanup when the root resource is destroyed. | AVResource.h | |
| Mutex | FCriticalSection | Mutex used for resource synchronization. | AVResource.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< FAVDevice > const & GetDevice() |
AVResource.h | ||
FAVLayout const & GetLayout() |
AVResource.h | ||
uint64 GetMemorySize() |
AVResource.h | ||
uint64 GetOffset() |
AVResource.h | ||
uint64 GetStride() |
AVResource.h | ||
virtual void Lock() |
Lock this resource for internal use. Is a blocking call until the lock can be taken. | AVResource.h | |
virtual FScopeLock LockScope () |
Lock this resource for internal use, within the current scope. | AVResource.h | |
TSharedPtr< TMapping > & PinMapping () |
Create a mapping of this resource to another resource (or other object). | AVResource.h | |
virtual void Unlock() |
Release this resource for external use. | AVResource.h | |
| Test if the underlying resource is usable or misconfigured. | AVResource.h |