Navigation
API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/FBulkData
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IBulkDataIORequest * CreateStreamingRequest
(
EAsyncIOPriorityAndFlags Priority, |
Create an async read request for the bulk data. | Serialization/BulkData.h | |
IBulkDataIORequest * CreateStreamingRequest
(
int64 OffsetInBulkData, |
Create an async read request for the bulk data. | Serialization/BulkData.h |
CreateStreamingRequest(EAsyncIOPriorityAndFlags, FBulkDataIORequestCallBack , uint8 )
Description
Create an async read request for the bulk data. This version will load the entire data range that the FBulkData represents.
| Name | CreateStreamingRequest |
| Type | function |
| Header File | /Engine/Source/Runtime/CoreUObject/Public/Serialization/BulkData.h |
| Include Path | #include "Serialization/BulkData.h" |
| Source | /Engine/Source/Runtime/CoreUObject/Private/Serialization/BulkData.cpp |
IBulkDataIORequest * CreateStreamingRequest
(
EAsyncIOPriorityAndFlags Priority,
FBulkDataIORequestCallBack * CompleteCallback,
uint8 * UserSuppliedMemory
) const
A request for the read. This is owned by the caller and must be deleted by the caller.
Parameters
| Name | Remarks |
|---|---|
| Priority | Priority and flags of the request. If this includes AIOP_FLAG_PRECACHE, then memory will never be returned. The request should always be canceled and waited for, even for a precache request. |
| CompleteCallback | Called from an arbitrary thread when the request is complete. Can be nullptr, if non-null, must remain valid until it is called. It will always be called. |
| UserSuppliedMemory | A pointer to memory for the IO request to be written to, it is up to the caller to make sure that it is large enough. If the pointer is null then the system will allocate memory instead. |
CreateStreamingRequest(int64, int64, EAsyncIOPriorityAndFlags, FBulkDataIORequestCallBack , uint8 )
Description
Create an async read request for the bulk data. This version allows the user to request a subset of the data that the FBulkData represents.
| Name | CreateStreamingRequest |
| Type | function |
| Header File | /Engine/Source/Runtime/CoreUObject/Public/Serialization/BulkData.h |
| Include Path | #include "Serialization/BulkData.h" |
| Source | /Engine/Source/Runtime/CoreUObject/Private/Serialization/BulkData.cpp |
IBulkDataIORequest * CreateStreamingRequest
(
int64 OffsetInBulkData,
int64 BytesToRead,
EAsyncIOPriorityAndFlags Priority,
FBulkDataIORequestCallBack * CompleteCallback,
uint8 * UserSuppliedMemory
) const
A request for the read. This is owned by the caller and must be deleted by the caller.
Parameters
| Name | Remarks |
|---|---|
| OffsetInBulkData | Offset into the bulk data to start reading from. |
| BytesToRead | The number of bytes to read. If this request is AIOP_Preache, the size can be anything, even MAX_int64, otherwise the size and offset must be fully contained in the file. |
| Priority | Priority and flags of the request. If this includes AIOP_FLAG_PRECACHE, then memory will never be returned. The request should always be canceled and waited for, even for a precache request. |
| CompleteCallback | Called from an arbitrary thread when the request is complete. Can be nullptr, if non-null, must remain valid until it is called. It will always be called. |
| UserSuppliedMemory | A pointer to memory for the IO request to be written to, it is up to the caller to make sure that it is large enough. If the pointer is null then the system will allocate memory instead. |