#include <PlatformIoDispatcher.h>

Classes
struct	FScatterParams

Public Types
using	FScatterParamsArray = TArray< FScatterParams, TInlineAllocator< 4 > >

Public Member Functions
	FIoScatterGatherRequestParams (FIoFileHandle InFileHandle, FIoBuffer &InDestination, uint64 InDestinationSize, void *InUserData, int32 InPriority)

void	Scatter (uint64 BlockFileOffset, uint32 BlockIndex, uint32 BlockCompressedSize, uint32 BlockUncompresedSize, uint64 ScatterOffset, uint64 ScatterSize, uint64 DestinationOffset, FName CompressionMethod, FMemoryView EncryptionKey, FMemoryView BlockHash)

Public Attributes
FIoFileHandle	FileHandle

FIoBuffer &	Destination

uint64	DestinationSize

void *	UserData

int32	Priority

FScatterParamsArray	Params

Detailed Description

The scatter-gather parameters specifies the I/O store encoded block boundaries, whether the block is compressed and or encrypted, whether to check the block signature hash and from where in the uncompressed block to copy the block data to the destination buffer.

Member Typedef Documentation

◆ FScatterParamsArray

using UE::FIoScatterGatherRequestParams::FScatterParamsArray = TArray<FScatterParams, TInlineAllocator<4> >

Constructor & Destructor Documentation

◆ FIoScatterGatherRequestParams()

UE::FIoScatterGatherRequestParams::FIoScatterGatherRequestParams	(	FIoFileHandle	InFileHandle,
		FIoBuffer &	InDestination,
		uint64	InDestinationSize,
		void *	InUserData,
		int32	InPriority
	)

inline

Creates a new set of scatter-gather parameters.

Parameters

InFileHandle	Handle to the file to read from.
InDestination	Reference to the destination buffer.
InDestinationSize	Size in bytes of the destination buffer.
InUserData	Optional user data associated with the request.
InPriority	The priority of the request.

Member Function Documentation

◆ Scatter()

void UE::FIoScatterGatherRequestParams::Scatter	(	uint64	BlockFileOffset,
		uint32	BlockIndex,
		uint32	BlockCompressedSize,
		uint32	BlockUncompresedSize,
		uint64	ScatterOffset,
		uint64	ScatterSize,
		uint64	DestinationOffset,
		FName	CompressionMethod,
		FMemoryView	EncryptionKey,
		FMemoryView	BlockHash
	)

inline

Add block scatter parameters.

Parameters

BlockFileOffset	Offset of the encoded block in the file.
BlockIndex	Index of the block in the TOC.
BlockCompressedSize	Compressed size of the block.
BlockUncompressedSize	Uncompressed size of the block.
ScatterOffset	Offset in the uncompressed block from where to copy the data to the destination buffer.
ScatterSize	Number of bytes to copy from the uncompressed block.
DestinationOffset	Offset in the destination buffer to copy the data from the uncompressed buffer.
CompressionMethod	Method used to compress the block data.
EncryptionKey	Optional memory view to the encryption key.
BlockHash	Optional memory view to the block hash for signature check.

Member Data Documentation

◆ Destination

FIoBuffer& UE::FIoScatterGatherRequestParams::Destination

◆ DestinationSize

uint64 UE::FIoScatterGatherRequestParams::DestinationSize

◆ FileHandle

FIoFileHandle UE::FIoScatterGatherRequestParams::FileHandle

◆ Params

FScatterParamsArray UE::FIoScatterGatherRequestParams::Params

◆ Priority

int32 UE::FIoScatterGatherRequestParams::Priority

◆ UserData

void* UE::FIoScatterGatherRequestParams::UserData

The documentation for this class was generated from the following file:

Engine/Source/Runtime/Core/Internal/IO/PlatformIoDispatcher.h

Classes

Public Types

Public Member Functions

Public Attributes