Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/UTextureAllMipDataProviderFactor-
Description
Retrieve initial texel data for mips, starting from FirstMipToLoad, up to the last mip in the texture. This function will only return mips that are currently loaded in Bulk Data. THIS FUNCTION WILL FAIL if you include in the requested range a bulk data mip that is NOT currently loaded. Also note that only inline mips are loaded initially, and that ALL mip data buffers are discarded (either returned or freed). So... in short, this function should only ever be called once.
| Name | GetInitialMipData |
| Type | function |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/TextureAllMipDataProviderFactory.h |
| Include Path | #include "Engine/TextureAllMipDataProviderFactory.h" |
virtual bool GetInitialMipData
(
int32 FirstMipToLoad,
TArrayView < void * > OutMipData,
TArrayView < int64 > OutMipSize,
FStringView DebugContext
)
true if the requested mip data has been successfully returned.
Parameters
| Name | Remarks |
|---|---|
| FirstMipToLoad | The first mip index to load. |
| OutMipData | A pre-allocated array of pointers, that correspond to [FirstMipToLoad, .... LastMip] Upon successful return, each of those pointers will point to allocated memory containing the corresponding mip's data. Caller takes responsibility to free that memory. |
| OutMipSize | A pre-allocated array of int64, that should be the same size as OutMipData (or zero size if caller does not require the sizes to be returned) Upon successful return, each element contains the size of the corresponding mip's data buffer. |
| DebugContext | A string used for debug tracking and logging. Usually Texture->GetPathName() |